Package software.amazon.awssdk.services.s3.model

Interface SSEKMSEncryption.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SSEKMSEncryption.Builder,SSEKMSEncryption>, SdkBuilder<SSEKMSEncryption.Builder,SSEKMSEncryption>, SdkPojo

Enclosing class:

SSEKMSEncryption

@Mutable
@NotThreadSafe
public static interface SSEKMSEncryption.Builder
extends SdkPojo, CopyableBuilder<SSEKMSEncryption.Builder,SSEKMSEncryption>

Method Summary

Modifier and Type	Method	Description
SSEKMSEncryption.Builder	bucketKeyEnabled(Boolean bucketKeyEnabled)	Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).
SSEKMSEncryption.Builder	kmsKeyArn(String kmsKeyArn)	Specifies the Amazon Web Services KMS key Amazon Resource Name (ARN) to use for the updated server-side encryption type.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

kmsKeyArn

SSEKMSEncryption.Builder kmsKeyArn(String kmsKeyArn)

Specifies the Amazon Web Services KMS key Amazon Resource Name (ARN) to use for the updated server-side encryption type. Required if ObjectEncryption specifies SSEKMS.

You must specify the full Amazon Web Services KMS key ARN. The KMS key ID and KMS key alias aren't supported.

Pattern: (arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)

Parameters:

kmsKeyArn - Specifies the Amazon Web Services KMS key Amazon Resource Name (ARN) to use for the updated server-side encryption type. Required if ObjectEncryption specifies SSEKMS.

You must specify the full Amazon Web Services KMS key ARN. The KMS key ID and KMS key alias aren't supported.

Pattern: (arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)

Returns:

Returns a reference to this object so that method calls can be chained together.

bucketKeyEnabled

SSEKMSEncryption.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If this value isn't specified, it defaults to false. Setting this value to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. For more information, see Using Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Valid Values: true | false

Parameters:

bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If this value isn't specified, it defaults to false. Setting this value to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. For more information, see Using Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Valid Values: true | false

Returns:

Returns a reference to this object so that method calls can be chained together.