@Generated(value="software.amazon.awssdk:codegen") public final class ServerSideEncryptionByDefault extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServerSideEncryptionByDefault.Builder,ServerSideEncryptionByDefault>
Describes 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. For more information, see PUT Bucket encryption in the Amazon Simple Storage Service API Reference.
Modifier and Type | Class and Description |
---|---|
static interface |
ServerSideEncryptionByDefault.Builder |
Modifier and Type | Method and Description |
---|---|
static ServerSideEncryptionByDefault.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
kmsMasterKeyID()
AWS Key Management Service (KMS) customer master key ID to use for the default encryption.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ServerSideEncryptionByDefault.Builder> |
serializableBuilderClass() |
ServerSideEncryption |
sseAlgorithm()
Server-side encryption algorithm to use for the default encryption.
|
String |
sseAlgorithmAsString()
Server-side encryption algorithm to use for the default encryption.
|
ServerSideEncryptionByDefault.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final ServerSideEncryption sseAlgorithm()
Server-side encryption algorithm to use for the default encryption.
If the service returns an enum value that is not available in the current SDK version, sseAlgorithm
will
return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from sseAlgorithmAsString()
.
ServerSideEncryption
public final String sseAlgorithmAsString()
Server-side encryption algorithm to use for the default encryption.
If the service returns an enum value that is not available in the current SDK version, sseAlgorithm
will
return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from sseAlgorithmAsString()
.
ServerSideEncryption
public final String kmsMasterKeyID()
AWS Key Management Service (KMS) customer master key ID to use for the default encryption. This parameter is
allowed if and only if SSEAlgorithm
is set to aws:kms
.
You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are using encryption with cross-account operations, you must use a fully qualified CMK ARN. For more information, see Using encryption for cross-account operations.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.
SSEAlgorithm
is set to aws:kms
.
You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are using encryption with cross-account operations, you must use a fully qualified CMK ARN. For more information, see Using encryption for cross-account operations.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.
public ServerSideEncryptionByDefault.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ServerSideEncryptionByDefault.Builder,ServerSideEncryptionByDefault>
public static ServerSideEncryptionByDefault.Builder builder()
public static Class<? extends ServerSideEncryptionByDefault.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()