Package software.amazon.awssdk.services.synthetics.model

Class S3EncryptionConfig

java.lang.Object

software.amazon.awssdk.services.synthetics.model.S3EncryptionConfig

All Implemented Interfaces:

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

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

A structure that contains the configuration of encryption-at-rest settings for canary artifacts that the canary uploads to Amazon S3.

For more information, see Encrypting canary artifacts

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3EncryptionConfig.Builder

Method Summary

Modifier and Type	Method	Description
static S3EncryptionConfig.Builder	builder()
EncryptionMode	encryptionMode()	The encryption method to use for artifacts created by this canary.
String	encryptionModeAsString()	The encryption method to use for artifacts created by this canary.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyArn()	The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode
List<SdkField<?>>	sdkFields()
static Class<? extends S3EncryptionConfig.Builder>	serializableBuilderClass()
S3EncryptionConfig.Builder	toBuilder()
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 Detail

encryptionMode

public final EncryptionMode encryptionMode()

The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.

If you omit this parameter, an Amazon Web Services-managed KMS key is used.

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

Returns:

The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.

If you omit this parameter, an Amazon Web Services-managed KMS key is used.

See Also:

EncryptionMode

encryptionModeAsString

public final String encryptionModeAsString()

The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.

If you omit this parameter, an Amazon Web Services-managed KMS key is used.

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

Returns:

The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.

If you omit this parameter, an Amazon Web Services-managed KMS key is used.

See Also:

EncryptionMode

kmsKeyArn

public final String kmsKeyArn()

The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode

Returns:

The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode

toBuilder

public S3EncryptionConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3EncryptionConfig.Builder,S3EncryptionConfig>

builder

public static S3EncryptionConfig.Builder builder()

serializableBuilderClass

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