/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace S3 { namespace Model { /** *

Describes the default server-side encryption to apply to new objects in the * bucket. If a PUT Object request doesn't specify any server-side encryption, this * default encryption will be applied. For more information, see PUT * Bucket encryption in the Amazon Simple Storage Service API * Reference.

See Also:

AWS * API Reference

*/ class AWS_S3_API ServerSideEncryptionByDefault { public: ServerSideEncryptionByDefault(); ServerSideEncryptionByDefault(const Aws::Utils::Xml::XmlNode& xmlNode); ServerSideEncryptionByDefault& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const; /** *

Server-side encryption algorithm to use for the default encryption.

*/ inline const ServerSideEncryption& GetSSEAlgorithm() const{ return m_sSEAlgorithm; } /** *

Server-side encryption algorithm to use for the default encryption.

*/ inline bool SSEAlgorithmHasBeenSet() const { return m_sSEAlgorithmHasBeenSet; } /** *

Server-side encryption algorithm to use for the default encryption.

*/ inline void SetSSEAlgorithm(const ServerSideEncryption& value) { m_sSEAlgorithmHasBeenSet = true; m_sSEAlgorithm = value; } /** *

Server-side encryption algorithm to use for the default encryption.

*/ inline void SetSSEAlgorithm(ServerSideEncryption&& value) { m_sSEAlgorithmHasBeenSet = true; m_sSEAlgorithm = std::move(value); } /** *

Server-side encryption algorithm to use for the default encryption.

*/ inline ServerSideEncryptionByDefault& WithSSEAlgorithm(const ServerSideEncryption& value) { SetSSEAlgorithm(value); return *this;} /** *

Server-side encryption algorithm to use for the default encryption.

*/ inline ServerSideEncryptionByDefault& WithSSEAlgorithm(ServerSideEncryption&& value) { SetSSEAlgorithm(std::move(value)); return *this;} /** *

AWS Key Management Service (KMS) customer master key ID to use for the * default encryption. This parameter is allowed if and only if * SSEAlgorithm is set to aws:kms.

You can specify * the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are * using encryption with cross-account operations, you must use a fully qualified * CMK ARN. For more information, see Using * encryption for cross-account operations.

For example:

*
  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    *
  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

Amazon S3 only supports symmetric CMKs and not * asymmetric CMKs. For more information, see Using * Symmetric and Asymmetric Keys in the AWS Key Management Service Developer * Guide.

*/ inline const Aws::String& GetKMSMasterKeyID() const{ return m_kMSMasterKeyID; } /** *

AWS Key Management Service (KMS) customer master key ID to use for the * default encryption. This parameter is allowed if and only if * SSEAlgorithm is set to aws:kms.

You can specify * the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are * using encryption with cross-account operations, you must use a fully qualified * CMK ARN. For more information, see Using * encryption for cross-account operations.

For example:

*
  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    *
  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

Amazon S3 only supports symmetric CMKs and not * asymmetric CMKs. For more information, see Using * Symmetric and Asymmetric Keys in the AWS Key Management Service Developer * Guide.

*/ inline bool KMSMasterKeyIDHasBeenSet() const { return m_kMSMasterKeyIDHasBeenSet; } /** *

AWS Key Management Service (KMS) customer master key ID to use for the * default encryption. This parameter is allowed if and only if * SSEAlgorithm is set to aws:kms.

You can specify * the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are * using encryption with cross-account operations, you must use a fully qualified * CMK ARN. For more information, see Using * encryption for cross-account operations.

For example:

*
  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    *
  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

Amazon S3 only supports symmetric CMKs and not * asymmetric CMKs. For more information, see Using * Symmetric and Asymmetric Keys in the AWS Key Management Service Developer * Guide.

*/ inline void SetKMSMasterKeyID(const Aws::String& value) { m_kMSMasterKeyIDHasBeenSet = true; m_kMSMasterKeyID = value; } /** *

AWS Key Management Service (KMS) customer master key ID to use for the * default encryption. This parameter is allowed if and only if * SSEAlgorithm is set to aws:kms.

You can specify * the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are * using encryption with cross-account operations, you must use a fully qualified * CMK ARN. For more information, see Using * encryption for cross-account operations.

For example:

*
  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    *
  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

Amazon S3 only supports symmetric CMKs and not * asymmetric CMKs. For more information, see Using * Symmetric and Asymmetric Keys in the AWS Key Management Service Developer * Guide.

*/ inline void SetKMSMasterKeyID(Aws::String&& value) { m_kMSMasterKeyIDHasBeenSet = true; m_kMSMasterKeyID = std::move(value); } /** *

AWS Key Management Service (KMS) customer master key ID to use for the * default encryption. This parameter is allowed if and only if * SSEAlgorithm is set to aws:kms.

You can specify * the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are * using encryption with cross-account operations, you must use a fully qualified * CMK ARN. For more information, see Using * encryption for cross-account operations.

For example:

*
  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    *
  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

Amazon S3 only supports symmetric CMKs and not * asymmetric CMKs. For more information, see Using * Symmetric and Asymmetric Keys in the AWS Key Management Service Developer * Guide.

*/ inline void SetKMSMasterKeyID(const char* value) { m_kMSMasterKeyIDHasBeenSet = true; m_kMSMasterKeyID.assign(value); } /** *

AWS Key Management Service (KMS) customer master key ID to use for the * default encryption. This parameter is allowed if and only if * SSEAlgorithm is set to aws:kms.

You can specify * the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are * using encryption with cross-account operations, you must use a fully qualified * CMK ARN. For more information, see Using * encryption for cross-account operations.

For example:

*
  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    *
  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

Amazon S3 only supports symmetric CMKs and not * asymmetric CMKs. For more information, see Using * Symmetric and Asymmetric Keys in the AWS Key Management Service Developer * Guide.

*/ inline ServerSideEncryptionByDefault& WithKMSMasterKeyID(const Aws::String& value) { SetKMSMasterKeyID(value); return *this;} /** *

AWS Key Management Service (KMS) customer master key ID to use for the * default encryption. This parameter is allowed if and only if * SSEAlgorithm is set to aws:kms.

You can specify * the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are * using encryption with cross-account operations, you must use a fully qualified * CMK ARN. For more information, see Using * encryption for cross-account operations.

For example:

*
  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    *
  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

Amazon S3 only supports symmetric CMKs and not * asymmetric CMKs. For more information, see Using * Symmetric and Asymmetric Keys in the AWS Key Management Service Developer * Guide.

*/ inline ServerSideEncryptionByDefault& WithKMSMasterKeyID(Aws::String&& value) { SetKMSMasterKeyID(std::move(value)); return *this;} /** *

AWS Key Management Service (KMS) customer master key ID to use for the * default encryption. This parameter is allowed if and only if * SSEAlgorithm is set to aws:kms.

You can specify * the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are * using encryption with cross-account operations, you must use a fully qualified * CMK ARN. For more information, see Using * encryption for cross-account operations.

For example:

*
  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    *
  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

Amazon S3 only supports symmetric CMKs and not * asymmetric CMKs. For more information, see Using * Symmetric and Asymmetric Keys in the AWS Key Management Service Developer * Guide.

*/ inline ServerSideEncryptionByDefault& WithKMSMasterKeyID(const char* value) { SetKMSMasterKeyID(value); return *this;} private: ServerSideEncryption m_sSEAlgorithm; bool m_sSEAlgorithmHasBeenSet; Aws::String m_kMSMasterKeyID; bool m_kMSMasterKeyIDHasBeenSet; }; } // namespace Model } // namespace S3 } // namespace Aws