Interface S3TableProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, TableBaseProps
All Known Subinterfaces:
TableProps
All Known Implementing Classes:
S3TableProps.Jsii$Proxy, TableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:18.146Z") @Stability(Experimental) public interface S3TableProps extends software.amazon.jsii.JsiiSerializable, TableBaseProps
Example:

 Database myDatabase;
 S3Table.Builder.create(this, "MyTable")
         .database(myDatabase)
         .columns(List.of(Column.builder()
                 .name("col1")
                 .type(Schema.STRING)
                 .build()))
         .partitionKeys(List.of(Column.builder()
                 .name("year")
                 .type(Schema.SMALL_INT)
                 .build(), Column.builder()
                 .name("month")
                 .type(Schema.SMALL_INT)
                 .build()))
         .dataFormat(DataFormat.JSON)
         .enablePartitionFiltering(true)
         .build();
 
  • Method Details

    • getBucket

      @Stability(Experimental) @Nullable default IBucket getBucket()
      (experimental) S3 bucket in which to store data.

      Default: one is created for you

    • getEncryption

      @Stability(Experimental) @Nullable default TableEncryption getEncryption()
      (experimental) The kind of encryption to secure the data with.

      You can only provide this option if you are not explicitly passing in a bucket.

      If you choose SSE-KMS, you can provide an un-managed KMS key with encryptionKey. If you choose CSE-KMS, you must provide an un-managed KMS key with encryptionKey.

      Default: BucketEncryption.S3_MANAGED

    • getEncryptionKey

      @Stability(Experimental) @Nullable default IKey getEncryptionKey()
      (experimental) External KMS key to use for bucket encryption.

      The encryption property must be SSE-KMS or CSE-KMS.

      Default: key is managed by KMS.

    • getS3Prefix

      @Stability(Experimental) @Nullable default String getS3Prefix()
      (experimental) S3 prefix under which table objects are stored.

      Default: - No prefix. The data will be stored under the root of the bucket.

    • builder

      @Stability(Experimental) static S3TableProps.Builder builder()
      Returns:
      a S3TableProps.Builder of S3TableProps