Package software.amazon.awscdk.services.s3tables.alpha

Class TableBucket.Builder

java.lang.Object
software.amazon.awscdk.services.s3tables.alpha.TableBucket.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<TableBucket>
Enclosing class:
TableBucket
@Stability(Experimental) public static final class TableBucket.Builder extends Object implements software.amazon.jsii.Builder<TableBucket>
(experimental) A fluent builder for TableBucket.

  • Method Details

    • create

      @Stability(Experimental) public static TableBucket.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of TableBucket.Builder.

    • tableBucketName

      @Stability(Experimental) public TableBucket.Builder tableBucketName(String tableBucketName)
      (experimental) Name of the S3 TableBucket.

      Parameters:
      tableBucketName - Name of the S3 TableBucket. This parameter is required.
      Returns:
      this

    • account

      @Stability(Experimental) public TableBucket.Builder account(String account)
      (experimental) AWS Account ID of the table bucket owner.

      Default: - it's assumed the bucket belongs to the same account as the scope it's being imported into

      Parameters:
      account - AWS Account ID of the table bucket owner. This parameter is required.
      Returns:
      this

    • encryption

      @Stability(Experimental) public TableBucket.Builder encryption(TableBucketEncryption encryption)
      (experimental) The kind of server-side encryption to apply to this bucket.

      If you choose KMS, you can specify a KMS key via encryptionKey. If encryption key is not specified, a key will automatically be created.

      Default: - `KMS` if `encryptionKey` is specified, or `S3_MANAGED` otherwise.

      Parameters:
      encryption - The kind of server-side encryption to apply to this bucket. This parameter is required.
      Returns:
      this

    • encryptionKey

      @Stability(Experimental) public TableBucket.Builder encryptionKey(IKey encryptionKey)
      (experimental) External KMS key to use for bucket encryption.

      The encryption property must be either not specified or set to KMS. An error will be emitted if encryption is set to S3_MANAGED.

      Default: - If `encryption` is set to `KMS` and this property is undefined, a new KMS key will be created and associated with this bucket.

      Parameters:
      encryptionKey - External KMS key to use for bucket encryption. This parameter is required.
      Returns:
      this

    • region

      @Stability(Experimental) public TableBucket.Builder region(String region)
      (experimental) AWS region that the table bucket exists in.

      Default: - it's assumed the bucket is in the same region as the scope it's being imported into

      Parameters:
      region - AWS region that the table bucket exists in. This parameter is required.
      Returns:
      this

    • removalPolicy

      @Stability(Experimental) public TableBucket.Builder removalPolicy(RemovalPolicy removalPolicy)
      (experimental) Controls what happens to this table bucket it it stoped being managed by cloudformation.

      Default: RETAIN

      Parameters:
      removalPolicy - Controls what happens to this table bucket it it stoped being managed by cloudformation. This parameter is required.
      Returns:
      this

    • unreferencedFileRemoval

      @Stability(Experimental) public TableBucket.Builder unreferencedFileRemoval(UnreferencedFileRemoval unreferencedFileRemoval)
      (experimental) Unreferenced file removal settings for the S3 TableBucket.

      Default: Enabled with default values

      Parameters:
      unreferencedFileRemoval - Unreferenced file removal settings for the S3 TableBucket. This parameter is required.
      Returns:
      this
      See Also:

    • build

      @Stability(Experimental) public TableBucket build()
      Specified by:
      build in interface software.amazon.jsii.Builder<TableBucket>
      Returns:
      a newly built instance of TableBucket.