pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-ecr/include/aws/ecr/model/EncryptionConfiguration.h

/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/ecr/ECR_EXPORTS.h>
#include <aws/ecr/model/EncryptionType.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>

namespace Aws
{
namespace Utils
{
namespace Json
{
  class JsonValue;
  class JsonView;
} // namespace Json
} // namespace Utils
namespace ECR
{
namespace Model
{

  /**
   * <p>The encryption configuration for the repository. This determines how the
   * contents of your repository are encrypted at rest.</p> <p>By default, when no
   * encryption configuration is set or the <code>AES256</code> 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.</p> <p>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 <a
   * href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html">Amazon
   * ECR encryption at rest</a> in the <i>Amazon Elastic Container Registry User
   * Guide</i>.</p><p><h3>See Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/EncryptionConfiguration">AWS
   * API Reference</a></p>
   */
  class AWS_ECR_API EncryptionConfiguration
  {
  public:
    EncryptionConfiguration();
    EncryptionConfiguration(Aws::Utils::Json::JsonView jsonValue);
    EncryptionConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue);
    Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * <p>The encryption type to use.</p> <p>If you use the <code>KMS</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting
     * Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service
     * (SSE-KMS)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p> <p>If you use the <code>AES256</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Protecting
     * Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys
     * (SSE-S3)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p>
     */
    inline const EncryptionType& GetEncryptionType() const{ return m_encryptionType; }

    /**
     * <p>The encryption type to use.</p> <p>If you use the <code>KMS</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting
     * Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service
     * (SSE-KMS)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p> <p>If you use the <code>AES256</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Protecting
     * Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys
     * (SSE-S3)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p>
     */
    inline bool EncryptionTypeHasBeenSet() const { return m_encryptionTypeHasBeenSet; }

    /**
     * <p>The encryption type to use.</p> <p>If you use the <code>KMS</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting
     * Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service
     * (SSE-KMS)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p> <p>If you use the <code>AES256</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Protecting
     * Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys
     * (SSE-S3)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p>
     */
    inline void SetEncryptionType(const EncryptionType& value) { m_encryptionTypeHasBeenSet = true; m_encryptionType = value; }

    /**
     * <p>The encryption type to use.</p> <p>If you use the <code>KMS</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting
     * Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service
     * (SSE-KMS)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p> <p>If you use the <code>AES256</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Protecting
     * Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys
     * (SSE-S3)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p>
     */
    inline void SetEncryptionType(EncryptionType&& value) { m_encryptionTypeHasBeenSet = true; m_encryptionType = std::move(value); }

    /**
     * <p>The encryption type to use.</p> <p>If you use the <code>KMS</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting
     * Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service
     * (SSE-KMS)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p> <p>If you use the <code>AES256</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Protecting
     * Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys
     * (SSE-S3)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p>
     */
    inline EncryptionConfiguration& WithEncryptionType(const EncryptionType& value) { SetEncryptionType(value); return *this;}

    /**
     * <p>The encryption type to use.</p> <p>If you use the <code>KMS</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting
     * Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service
     * (SSE-KMS)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p> <p>If you use the <code>AES256</code> 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 <a
     * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Protecting
     * Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys
     * (SSE-S3)</a> in the <i>Amazon Simple Storage Service Console Developer
     * Guide.</i>.</p>
     */
    inline EncryptionConfiguration& WithEncryptionType(EncryptionType&& value) { SetEncryptionType(std::move(value)); return *this;}


    /**
     * <p>If you use the <code>KMS</code> 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.</p>
     */
    inline const Aws::String& GetKmsKey() const{ return m_kmsKey; }

    /**
     * <p>If you use the <code>KMS</code> 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.</p>
     */
    inline bool KmsKeyHasBeenSet() const { return m_kmsKeyHasBeenSet; }

    /**
     * <p>If you use the <code>KMS</code> 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.</p>
     */
    inline void SetKmsKey(const Aws::String& value) { m_kmsKeyHasBeenSet = true; m_kmsKey = value; }

    /**
     * <p>If you use the <code>KMS</code> 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.</p>
     */
    inline void SetKmsKey(Aws::String&& value) { m_kmsKeyHasBeenSet = true; m_kmsKey = std::move(value); }

    /**
     * <p>If you use the <code>KMS</code> 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.</p>
     */
    inline void SetKmsKey(const char* value) { m_kmsKeyHasBeenSet = true; m_kmsKey.assign(value); }

    /**
     * <p>If you use the <code>KMS</code> 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.</p>
     */
    inline EncryptionConfiguration& WithKmsKey(const Aws::String& value) { SetKmsKey(value); return *this;}

    /**
     * <p>If you use the <code>KMS</code> 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.</p>
     */
    inline EncryptionConfiguration& WithKmsKey(Aws::String&& value) { SetKmsKey(std::move(value)); return *this;}

    /**
     * <p>If you use the <code>KMS</code> 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.</p>
     */
    inline EncryptionConfiguration& WithKmsKey(const char* value) { SetKmsKey(value); return *this;}

  private:

    EncryptionType m_encryptionType;
    bool m_encryptionTypeHasBeenSet;

    Aws::String m_kmsKey;
    bool m_kmsKeyHasBeenSet;
  };

} // namespace Model
} // namespace ECR
} // namespace Aws