Package software.amazon.awscdk.services.glue

Class S3Table

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.glue.TableBase
software.amazon.awscdk.services.glue.S3Table
All Implemented Interfaces:
IEnvironmentAware, IResource, ITable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-17T14:54:05.083Z") @Stability(Stable) public class S3Table extends TableBase
A Glue table that targets a S3 dataset.

Example: 

 Database myDatabase;
 S3Table.Builder.create(this, "MyTable")
         .database(myDatabase)
         .columns(List.of(Column.builder()
                 .name("data")
                 .type(Schema.STRING)
                 .build()))
         .partitionKeys(List.of(Column.builder()
                 .name("date")
                 .type(Schema.STRING)
                 .build()))
         .dataFormat(DataFormat.JSON)
         .partitionProjection(Map.of(
                 "date", PartitionProjectionConfiguration.date(DatePartitionProjectionConfigurationProps.builder()
                         .min("NOW-3YEARS")
                         .max("NOW")
                         .format("yyyy-MM-dd")
                         .build())))
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Stable) public static final String PROPERTY_INJECTION_ID
      Uniquely identifies this class.

  • Constructor Details

    • S3Table

      protected S3Table(software.amazon.jsii.JsiiObjectRef objRef)

    • S3Table

      protected S3Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • S3Table

      @Stability(Stable) public S3Table(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull S3TableProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • generateS3PrefixForGrant

      @Stability(Stable) @NotNull protected String generateS3PrefixForGrant()

    • grantRead

      @Stability(Stable) @NotNull public Grant grantRead(@NotNull IGrantable grantee)
      Grant read permissions to the table and the underlying data stored in S3 to an IAM principal.

      [disable-awslint:no-grants]

      Specified by:
      grantRead in class TableBase
      Parameters:
      grantee - the principal. This parameter is required.

    • grantReadWrite

      @Stability(Stable) @NotNull public Grant grantReadWrite(@NotNull IGrantable grantee)
      Grant read and write permissions to the table and the underlying data stored in S3 to an IAM principal.

      [disable-awslint:no-grants]

      Specified by:
      grantReadWrite in class TableBase
      Parameters:
      grantee - the principal. This parameter is required.

    • grantWrite

      @Stability(Stable) @NotNull public Grant grantWrite(@NotNull IGrantable grantee)
      Grant write permissions to the table and the underlying data stored in S3 to an IAM principal.

      [disable-awslint:no-grants]

      Specified by:
      grantWrite in class TableBase
      Parameters:
      grantee - the principal. This parameter is required.

    • getBucket

      @Stability(Stable) @NotNull public IBucket getBucket()
      S3 bucket in which the table's data resides.

    • getS3Prefix

      @Stability(Stable) @NotNull public String getS3Prefix()
      S3 Key Prefix under which this table's files are stored in S3.

    • getTableArn

      @Stability(Stable) @NotNull public String getTableArn()
      ARN of this table.
      Specified by:
      getTableArn in interface ITable
      Specified by:
      getTableArn in class TableBase

    • getTableName

      @Stability(Stable) @NotNull public String getTableName()
      Name of this table.
      Specified by:
      getTableName in interface ITable
      Specified by:
      getTableName in class TableBase

    • getTableResource

      @Stability(Stable) @NotNull protected CfnTable getTableResource()
      Specified by:
      getTableResource in class TableBase

    • getClientSideEncryptionKey

      @Stability(Stable) @Nullable public IKeyRef getClientSideEncryptionKey()
      The KMS key used for client-side encryption of the table's data, if clientSideEncryption was configured. Otherwise, undefined.

      For server-side (bucket) encryption, read bucket.encryptionKey instead.

    • getPartitionIndexes

      @Stability(Stable) @Nullable public List<PartitionIndex> getPartitionIndexes()
      This table's partition indexes.
      Specified by:
      getPartitionIndexes in class TableBase