Package software.amazon.awssdk.services.s3.model

Class Encryption

java.lang.Object

software.amazon.awssdk.services.s3.model.Encryption

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class Encryption
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Encryption.Builder,Encryption>

Contains the type of server-side encryption used.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Encryption.Builder

Method Summary

Modifier and Type	Method	Description
static Encryption.Builder	builder()
final ServerSideEncryption	encryptionType()	The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
final String	encryptionTypeAsString()	The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	kmsContext()	If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.
final String	kmsKeyId()	If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends Encryption.Builder>	serializableBuilderClass()
Encryption.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

encryptionType

public final ServerSideEncryption encryptionType()

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

If the service returns an enum value that is not available in the current SDK version, encryptionType will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().

Returns:

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

See Also:

• ServerSideEncryption

encryptionTypeAsString

public final String encryptionTypeAsString()

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

If the service returns an enum value that is not available in the current SDK version, encryptionType will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().

Returns:

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

See Also:

• ServerSideEncryption

kmsKeyId

public final String kmsKeyId()

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

Returns:

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

kmsContext

public final String kmsContext()

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

Returns:

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

toBuilder

public Encryption.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Encryption.Builder,Encryption>

builder

public static Encryption.Builder builder()

serializableBuilderClass

public static Class<? extends Encryption.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo