Class S3EncryptionSettings
- java.lang.Object
-
- software.amazon.awssdk.services.mediaconvert.model.S3EncryptionSettings
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<S3EncryptionSettings.Builder,S3EncryptionSettings>
@Generated("software.amazon.awssdk:codegen") public final class S3EncryptionSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3EncryptionSettings.Builder,S3EncryptionSettings>
Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
S3EncryptionSettings.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static S3EncryptionSettings.Builder
builder()
S3ServerSideEncryptionType
encryptionType()
Specify how you want your data keys managed.String
encryptionTypeAsString()
Specify how you want your data keys managed.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
kmsEncryptionContext()
Optionally, specify the encryption context that you want to use alongside your KMS key.String
kmsKeyArn()
Optionally, specify the customer master key (CMK) that you want to use to encrypt the data key that AWS uses to encrypt your output content.List<SdkField<?>>
sdkFields()
static Class<? extends S3EncryptionSettings.Builder>
serializableBuilderClass()
S3EncryptionSettings.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
-
encryptionType
public final S3ServerSideEncryptionType encryptionType()
Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose Amazon S3. If you want your master key to be managed by AWS Key Management Service (KMS), choose AWS KMS. By default, when you choose AWS KMS, KMS uses the AWS managed customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN.If the service returns an enum value that is not available in the current SDK version,
encryptionType
will returnS3ServerSideEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionTypeAsString()
.- Returns:
- Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose Amazon S3. If you want your master key to be managed by AWS Key Management Service (KMS), choose AWS KMS. By default, when you choose AWS KMS, KMS uses the AWS managed customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN.
- See Also:
S3ServerSideEncryptionType
-
encryptionTypeAsString
public final String encryptionTypeAsString()
Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose Amazon S3. If you want your master key to be managed by AWS Key Management Service (KMS), choose AWS KMS. By default, when you choose AWS KMS, KMS uses the AWS managed customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN.If the service returns an enum value that is not available in the current SDK version,
encryptionType
will returnS3ServerSideEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionTypeAsString()
.- Returns:
- Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose Amazon S3. If you want your master key to be managed by AWS Key Management Service (KMS), choose AWS KMS. By default, when you choose AWS KMS, KMS uses the AWS managed customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN.
- See Also:
S3ServerSideEncryptionType
-
kmsEncryptionContext
public final String kmsEncryptionContext()
Optionally, specify the encryption context that you want to use alongside your KMS key. AWS KMS uses this encryption context as additional authenticated data (AAD) to support authenticated encryption. This value must be a base64-encoded UTF-8 string holding JSON which represents a string-string map. To use this setting, you must also set Server-side encryption to AWS KMS. For more information about encryption context, see: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context.- Returns:
- Optionally, specify the encryption context that you want to use alongside your KMS key. AWS KMS uses this encryption context as additional authenticated data (AAD) to support authenticated encryption. This value must be a base64-encoded UTF-8 string holding JSON which represents a string-string map. To use this setting, you must also set Server-side encryption to AWS KMS. For more information about encryption context, see: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context.
-
kmsKeyArn
public final String kmsKeyArn()
Optionally, specify the customer master key (CMK) that you want to use to encrypt the data key that AWS uses to encrypt your output content. Enter the Amazon Resource Name (ARN) of the CMK. To use this setting, you must also set Server-side encryption to AWS KMS. If you set Server-side encryption to AWS KMS but don't specify a CMK here, AWS uses the AWS managed CMK associated with Amazon S3.- Returns:
- Optionally, specify the customer master key (CMK) that you want to use to encrypt the data key that AWS uses to encrypt your output content. Enter the Amazon Resource Name (ARN) of the CMK. To use this setting, you must also set Server-side encryption to AWS KMS. If you set Server-side encryption to AWS KMS but don't specify a CMK here, AWS uses the AWS managed CMK associated with Amazon S3.
-
toBuilder
public S3EncryptionSettings.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<S3EncryptionSettings.Builder,S3EncryptionSettings>
-
builder
public static S3EncryptionSettings.Builder builder()
-
serializableBuilderClass
public static Class<? extends S3EncryptionSettings.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-