AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECR::Model::EncryptionConfiguration Class Reference

#include <EncryptionConfiguration.h>

Public Member Functions

 EncryptionConfiguration ()
 
 EncryptionConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
EncryptionConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const EncryptionTypeGetEncryptionType () const
 
bool EncryptionTypeHasBeenSet () const
 
void SetEncryptionType (const EncryptionType &value)
 
void SetEncryptionType (EncryptionType &&value)
 
EncryptionConfigurationWithEncryptionType (const EncryptionType &value)
 
EncryptionConfigurationWithEncryptionType (EncryptionType &&value)
 
const Aws::StringGetKmsKey () const
 
bool KmsKeyHasBeenSet () const
 
void SetKmsKey (const Aws::String &value)
 
void SetKmsKey (Aws::String &&value)
 
void SetKmsKey (const char *value)
 
EncryptionConfigurationWithKmsKey (const Aws::String &value)
 
EncryptionConfigurationWithKmsKey (Aws::String &&value)
 
EncryptionConfigurationWithKmsKey (const char *value)
 

Detailed Description

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 customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) to encrypt your images. For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide.

See Also:

AWS API Reference

Definition at line 43 of file EncryptionConfiguration.h.

Constructor & Destructor Documentation

◆ EncryptionConfiguration() [1/2]

Aws::ECR::Model::EncryptionConfiguration::EncryptionConfiguration ( )

◆ EncryptionConfiguration() [2/2]

Aws::ECR::Model::EncryptionConfiguration::EncryptionConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ EncryptionTypeHasBeenSet()

bool Aws::ECR::Model::EncryptionConfiguration::EncryptionTypeHasBeenSet ( ) const
inline

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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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..

Definition at line 92 of file EncryptionConfiguration.h.

◆ GetEncryptionType()

const EncryptionType& Aws::ECR::Model::EncryptionConfiguration::GetEncryptionType ( ) const
inline

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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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..

Definition at line 71 of file EncryptionConfiguration.h.

◆ GetKmsKey()

const Aws::String& Aws::ECR::Model::EncryptionConfiguration::GetKmsKey ( ) const
inline

If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.

Definition at line 185 of file EncryptionConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECR::Model::EncryptionConfiguration::Jsonize ( ) const

◆ KmsKeyHasBeenSet()

bool Aws::ECR::Model::EncryptionConfiguration::KmsKeyHasBeenSet ( ) const
inline

If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.

Definition at line 193 of file EncryptionConfiguration.h.

◆ operator=()

EncryptionConfiguration& Aws::ECR::Model::EncryptionConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetEncryptionType() [1/2]

void Aws::ECR::Model::EncryptionConfiguration::SetEncryptionType ( const EncryptionType value)
inline

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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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..

Definition at line 113 of file EncryptionConfiguration.h.

◆ SetEncryptionType() [2/2]

void Aws::ECR::Model::EncryptionConfiguration::SetEncryptionType ( EncryptionType &&  value)
inline

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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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..

Definition at line 134 of file EncryptionConfiguration.h.

◆ SetKmsKey() [1/3]

void Aws::ECR::Model::EncryptionConfiguration::SetKmsKey ( Aws::String &&  value)
inline

If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.

Definition at line 209 of file EncryptionConfiguration.h.

◆ SetKmsKey() [2/3]

void Aws::ECR::Model::EncryptionConfiguration::SetKmsKey ( const Aws::String value)
inline

If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.

Definition at line 201 of file EncryptionConfiguration.h.

◆ SetKmsKey() [3/3]

void Aws::ECR::Model::EncryptionConfiguration::SetKmsKey ( const char *  value)
inline

If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.

Definition at line 217 of file EncryptionConfiguration.h.

◆ WithEncryptionType() [1/2]

EncryptionConfiguration& Aws::ECR::Model::EncryptionConfiguration::WithEncryptionType ( const EncryptionType value)
inline

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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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..

Definition at line 155 of file EncryptionConfiguration.h.

◆ WithEncryptionType() [2/2]

EncryptionConfiguration& Aws::ECR::Model::EncryptionConfiguration::WithEncryptionType ( EncryptionType &&  value)
inline

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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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..

Definition at line 176 of file EncryptionConfiguration.h.

◆ WithKmsKey() [1/3]

EncryptionConfiguration& Aws::ECR::Model::EncryptionConfiguration::WithKmsKey ( Aws::String &&  value)
inline

If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.

Definition at line 233 of file EncryptionConfiguration.h.

◆ WithKmsKey() [2/3]

EncryptionConfiguration& Aws::ECR::Model::EncryptionConfiguration::WithKmsKey ( const Aws::String value)
inline

If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.

Definition at line 225 of file EncryptionConfiguration.h.

◆ WithKmsKey() [3/3]

EncryptionConfiguration& Aws::ECR::Model::EncryptionConfiguration::WithKmsKey ( const char *  value)
inline

If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.

Definition at line 241 of file EncryptionConfiguration.h.


The documentation for this class was generated from the following file: