com.amazonaws.services.mediaconvert.model.S3EncryptionSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-mediaconvert Show documentation
Show all versions of aws-java-sdk-mediaconvert Show documentation
The AWS Java SDK for AWS Elemental MediaConvert module holds the client classes that are used for communicating with AWS Elemental MediaConvert Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mediaconvert.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3EncryptionSettings implements Serializable, Cloneable, StructuredPojo {
/**
* 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.
*/
private String encryptionType;
/**
* 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.
*/
private String kmsEncryptionContext;
/**
* 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.
*/
private String kmsKeyArn;
/**
* 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.
*
* @param 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.
* @see S3ServerSideEncryptionType
*/
public void setEncryptionType(String encryptionType) {
this.encryptionType = 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.
*
* @return 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 S3ServerSideEncryptionType
*/
public String getEncryptionType() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see S3ServerSideEncryptionType
*/
public S3EncryptionSettings withEncryptionType(String encryptionType) {
setEncryptionType(encryptionType);
return this;
}
/**
* 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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see S3ServerSideEncryptionType
*/
public S3EncryptionSettings withEncryptionType(S3ServerSideEncryptionType encryptionType) {
this.encryptionType = encryptionType.toString();
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setKmsEncryptionContext(String kmsEncryptionContext) {
this.kmsEncryptionContext = 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.
*
* @return 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.
*/
public String getKmsEncryptionContext() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3EncryptionSettings withKmsEncryptionContext(String kmsEncryptionContext) {
setKmsEncryptionContext(kmsEncryptionContext);
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setKmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = 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.
*
* @return 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.
*/
public String getKmsKeyArn() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3EncryptionSettings withKmsKeyArn(String kmsKeyArn) {
setKmsKeyArn(kmsKeyArn);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEncryptionType() != null)
sb.append("EncryptionType: ").append(getEncryptionType()).append(",");
if (getKmsEncryptionContext() != null)
sb.append("KmsEncryptionContext: ").append(getKmsEncryptionContext()).append(",");
if (getKmsKeyArn() != null)
sb.append("KmsKeyArn: ").append(getKmsKeyArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3EncryptionSettings == false)
return false;
S3EncryptionSettings other = (S3EncryptionSettings) obj;
if (other.getEncryptionType() == null ^ this.getEncryptionType() == null)
return false;
if (other.getEncryptionType() != null && other.getEncryptionType().equals(this.getEncryptionType()) == false)
return false;
if (other.getKmsEncryptionContext() == null ^ this.getKmsEncryptionContext() == null)
return false;
if (other.getKmsEncryptionContext() != null && other.getKmsEncryptionContext().equals(this.getKmsEncryptionContext()) == false)
return false;
if (other.getKmsKeyArn() == null ^ this.getKmsKeyArn() == null)
return false;
if (other.getKmsKeyArn() != null && other.getKmsKeyArn().equals(this.getKmsKeyArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEncryptionType() == null) ? 0 : getEncryptionType().hashCode());
hashCode = prime * hashCode + ((getKmsEncryptionContext() == null) ? 0 : getKmsEncryptionContext().hashCode());
hashCode = prime * hashCode + ((getKmsKeyArn() == null) ? 0 : getKmsKeyArn().hashCode());
return hashCode;
}
@Override
public S3EncryptionSettings clone() {
try {
return (S3EncryptionSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.mediaconvert.model.transform.S3EncryptionSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}