Class ServerSideEncryptionByDefault
- All Implemented Interfaces:
Serializable
,SdkPojo
,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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption.static Class
<? extends ServerSideEncryptionByDefault.Builder> final ServerSideEncryption
Server-side encryption algorithm to use for the default encryption.final String
Server-side encryption algorithm to use for the default encryption.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsseAlgorithmAsString()
.- Returns:
- Server-side encryption algorithm to use for the default encryption.
- See Also:
-
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 returnServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsseAlgorithmAsString()
.- Returns:
- Server-side encryption algorithm to use for the default encryption.
- See Also:
-
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 toaws:kms
oraws:kms:dsse
.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.
- Returns:
- 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 toaws:kms
oraws:kms:dsse
.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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ServerSideEncryptionByDefault.Builder,
ServerSideEncryptionByDefault> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-