Package software.amazon.awscdk.cfnpropertymixins.services.s3

Class CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Builder

java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.s3.CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty>
Enclosing interface:
CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty
@Stability(Stable) public static final class CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty>
A builder for CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • kmsMasterKeyId

      @Stability(Stable) public CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Builder kmsMasterKeyId(String kmsMasterKeyId)
      Sets the value of CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.getKmsMasterKeyId()
      Parameters:
      kmsMasterKeyId - AWS Key Management Service (KMS) customer managed key ID to use for the default encryption.

      • General purpose buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse .
      • Directory buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms .

      You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
      • Key Alias: alias/alias-name

      If you are using encryption with cross-account or AWS service operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations .

      • General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.
      • Directory buckets - When you specify an AWS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported. > Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in AWS KMS in the AWS Key Management Service Developer Guide .

      Returns:
      this

    • kmsMasterKeyId

      @Stability(Stable) public CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Builder kmsMasterKeyId(IAliasRef kmsMasterKeyId)
      Sets the value of CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.getKmsMasterKeyId()
      Parameters:
      kmsMasterKeyId - AWS Key Management Service (KMS) customer managed key ID to use for the default encryption.

      • General purpose buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse .
      • Directory buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms .

      You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
      • Key Alias: alias/alias-name

      If you are using encryption with cross-account or AWS service operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations .

      • General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.
      • Directory buckets - When you specify an AWS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported. > Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in AWS KMS in the AWS Key Management Service Developer Guide .

      Returns:
      this

    • kmsMasterKeyId

      @Stability(Stable) public CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Builder kmsMasterKeyId(IKeyRef kmsMasterKeyId)
      Sets the value of CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.getKmsMasterKeyId()
      Parameters:
      kmsMasterKeyId - AWS Key Management Service (KMS) customer managed key ID to use for the default encryption.

      • General purpose buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse .
      • Directory buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms .

      You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
      • Key Alias: alias/alias-name

      If you are using encryption with cross-account or AWS service operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations .

      • General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.
      • Directory buckets - When you specify an AWS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported. > Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in AWS KMS in the AWS Key Management Service Developer Guide .

      Returns:
      this

    • sseAlgorithm

      @Stability(Stable) public CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Builder sseAlgorithm(String sseAlgorithm)
      Sets the value of CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty.getSseAlgorithm()
      Parameters:
      sseAlgorithm - Server-side encryption algorithm to use for the default encryption.

      For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms .

      Returns:
      this

    • build

      @Stability(Stable) public CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty>
      Returns:
      a new instance of CfnBucketPropsMixin.ServerSideEncryptionByDefaultProperty
      Throws:
      NullPointerException - if any required attribute was not provided