software.amazon.awssdk.services.s3.model

Class ServerSideEncryptionByDefault

java.lang.Object

software.amazon.awssdk.services.s3.model.ServerSideEncryptionByDefault

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ServerSideEncryptionByDefault.Builder,ServerSideEncryptionByDefault>

@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 S3 API Reference.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServerSideEncryptionByDefault.Builder

Method Summary

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 AWS 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() 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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sseAlgorithm

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().

Returns:

Server-side encryption algorithm to use for the default encryption.

See Also:

ServerSideEncryption

sseAlgorithmAsString

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().

Returns:

Server-side encryption algorithm to use for the default encryption.

See Also:

ServerSideEncryption

kmsMasterKeyID

public final String kmsMasterKeyID()

AWS Key Management Service (KMS) customer AWS 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 or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key 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 KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the AWS Key Management Service Developer Guide.

Returns:

AWS Key Management Service (KMS) customer AWS 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 or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key 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 KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the AWS Key Management Service Developer Guide.

toBuilder

public ServerSideEncryptionByDefault.Builder 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 interface ToCopyableBuilder<ServerSideEncryptionByDefault.Builder,ServerSideEncryptionByDefault>

Returns:

a builder for type T

builder

public static ServerSideEncryptionByDefault.Builder builder()

serializableBuilderClass

public static Class<? extends ServerSideEncryptionByDefault.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.