@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. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see PUT Bucket encryption in the Amazon S3 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
kmsMasterKeyID()
Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS 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() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
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()
Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS 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, 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 use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.
If you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
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 use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.
If you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
public ServerSideEncryptionByDefault.Builder toBuilder()
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)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.