com.ibm.cos.v2.services.s3.model

Interface ServerSideEncryptionRule.Builder

All Superinterfaces:

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

Enclosing class:

ServerSideEncryptionRule

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

Method Summary

Modifier and Type	Method and Description
default ServerSideEncryptionRule.Builder	applyServerSideEncryptionByDefault(Consumer<ServerSideEncryptionByDefault.Builder> applyServerSideEncryptionByDefault) Specifies the default server-side encryption to apply to new objects in the bucket.
ServerSideEncryptionRule.Builder	applyServerSideEncryptionByDefault(ServerSideEncryptionByDefault applyServerSideEncryptionByDefault) Specifies the default server-side encryption to apply to new objects in the bucket.
ServerSideEncryptionRule.Builder	bucketKeyEnabled(Boolean bucketKeyEnabled) Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation, build

Method Detail

applyServerSideEncryptionByDefault

ServerSideEncryptionRule.Builder applyServerSideEncryptionByDefault(ServerSideEncryptionByDefault applyServerSideEncryptionByDefault)

Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

Parameters:

applyServerSideEncryptionByDefault - Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

Returns:

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

applyServerSideEncryptionByDefault

default ServerSideEncryptionRule.Builder applyServerSideEncryptionByDefault(Consumer<ServerSideEncryptionByDefault.Builder> applyServerSideEncryptionByDefault)

Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

This is a convenience method that creates an instance of the ServerSideEncryptionByDefault.Builder avoiding the need to create one manually via ServerSideEncryptionByDefault.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to applyServerSideEncryptionByDefault(ServerSideEncryptionByDefault).

Parameters:

applyServerSideEncryptionByDefault - a consumer that will call methods on ServerSideEncryptionByDefault.Builder

Returns:

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

See Also:

applyServerSideEncryptionByDefault(ServerSideEncryptionByDefault)

bucketKeyEnabled

ServerSideEncryptionRule.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key.

• General purpose buckets - By default, S3 Bucket Key is not enabled. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

• Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

Parameters:

bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key.

• General purpose buckets - By default, S3 Bucket Key is not enabled. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

• Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

Returns:

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