com.amazonaws.services.ecr.model.EncryptionConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecr Show documentation
/*
* Copyright 2018-2023 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.ecr.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The encryption configuration for the repository. This determines how the contents of your repository are encrypted at
* rest.
*
*
* By default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR
* uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256
* encryption algorithm. This does not require any action on your part.
*
*
* For more control over the encryption of the contents of your repository, you can use server-side encryption with Key
* Management Service key stored in Key Management Service (KMS) to encrypt your images. For more information, see Amazon ECR encryption at
* rest in the Amazon Elastic Container Registry User Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EncryptionConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The encryption type to use.
*
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you
* can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which
* you already created. For more information, see Protecting data using server-side
* encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service
* Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed
* encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more
* information, see Protecting data using
* server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple Storage
* Service Console Developer Guide.
*
*/
private String encryptionType;
/**
*
* If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or
* full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is
* specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
*
*/
private String kmsKey;
/**
*
* The encryption type to use.
*
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you
* can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which
* you already created. For more information, see Protecting data using server-side
* encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service
* Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed
* encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more
* information, see Protecting data using
* server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple Storage
* Service Console Developer Guide.
*
*
* @param encryptionType
* The encryption type to use.
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your
* data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your
* own KMS key, which you already created. For more information, see Protecting data using
* server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon
* Simple Storage Service Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon
* S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption
* algorithm. For more information, see Protecting data
* using server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple
* Storage Service Console Developer Guide.
* @see EncryptionType
*/
public void setEncryptionType(String encryptionType) {
this.encryptionType = encryptionType;
}
/**
*
* The encryption type to use.
*
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you
* can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which
* you already created. For more information, see Protecting data using server-side
* encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service
* Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed
* encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more
* information, see Protecting data using
* server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple Storage
* Service Console Developer Guide.
*
*
* @return The encryption type to use.
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your
* data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your
* own KMS key, which you already created. For more information, see Protecting data using
* server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon
* Simple Storage Service Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon
* S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption
* algorithm. For more information, see Protecting data
* using server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple
* Storage Service Console Developer Guide.
* @see EncryptionType
*/
public String getEncryptionType() {
return this.encryptionType;
}
/**
*
* The encryption type to use.
*
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you
* can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which
* you already created. For more information, see Protecting data using server-side
* encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service
* Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed
* encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more
* information, see Protecting data using
* server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple Storage
* Service Console Developer Guide.
*
*
* @param encryptionType
* The encryption type to use.
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your
* data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your
* own KMS key, which you already created. For more information, see Protecting data using
* server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon
* Simple Storage Service Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon
* S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption
* algorithm. For more information, see Protecting data
* using server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple
* Storage Service Console Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
public EncryptionConfiguration withEncryptionType(String encryptionType) {
setEncryptionType(encryptionType);
return this;
}
/**
*
* The encryption type to use.
*
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you
* can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which
* you already created. For more information, see Protecting data using server-side
* encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service
* Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed
* encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more
* information, see Protecting data using
* server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple Storage
* Service Console Developer Guide.
*
*
* @param encryptionType
* The encryption type to use.
*
* If you use the KMS encryption type, the contents of the repository will be encrypted using
* server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your
* data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your
* own KMS key, which you already created. For more information, see Protecting data using
* server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon
* Simple Storage Service Console Developer Guide.
*
*
* If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon
* S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption
* algorithm. For more information, see Protecting data
* using server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple
* Storage Service Console Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
public EncryptionConfiguration withEncryptionType(EncryptionType encryptionType) {
this.encryptionType = encryptionType.toString();
return this;
}
/**
*
* If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or
* full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is
* specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
*
*
* @param kmsKey
* If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key
* ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository.
* If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
*/
public void setKmsKey(String kmsKey) {
this.kmsKey = kmsKey;
}
/**
*
* If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or
* full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is
* specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
*
*
* @return If you use the KMS encryption type, specify the KMS key to use for encryption. The alias,
* key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the
* repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will
* be used.
*/
public String getKmsKey() {
return this.kmsKey;
}
/**
*
* If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or
* full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is
* specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
*
*
* @param kmsKey
* If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key
* ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository.
* If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EncryptionConfiguration withKmsKey(String kmsKey) {
setKmsKey(kmsKey);
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 (getKmsKey() != null)
sb.append("KmsKey: ").append(getKmsKey());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EncryptionConfiguration == false)
return false;
EncryptionConfiguration other = (EncryptionConfiguration) obj;
if (other.getEncryptionType() == null ^ this.getEncryptionType() == null)
return false;
if (other.getEncryptionType() != null && other.getEncryptionType().equals(this.getEncryptionType()) == false)
return false;
if (other.getKmsKey() == null ^ this.getKmsKey() == null)
return false;
if (other.getKmsKey() != null && other.getKmsKey().equals(this.getKmsKey()) == 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 + ((getKmsKey() == null) ? 0 : getKmsKey().hashCode());
return hashCode;
}
@Override
public EncryptionConfiguration clone() {
try {
return (EncryptionConfiguration) 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.ecr.model.transform.EncryptionConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}