Aws::S3::Model::Encryption Class Reference

#include <Encryption.h>

Public Member Functions

AWS_S3_API Encryption ()=default

 

AWS_S3_API Encryption (const Aws::Utils::Xml::XmlNode &xmlNode)

 

AWS_S3_API Encryption & operator= (const Aws::Utils::Xml::XmlNode &xmlNode)

 

AWS_S3_API void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const

 

ServerSideEncryption GetEncryptionType () const

 

bool EncryptionTypeHasBeenSet () const

 

void SetEncryptionType (ServerSideEncryption value)

 

Encryption & WithEncryptionType (ServerSideEncryption value)

 

const Aws::String & GetKMSKeyId () const

 

bool KMSKeyIdHasBeenSet () const

 

template<typename KMSKeyIdT = Aws::String>

void SetKMSKeyId (KMSKeyIdT &&value)

 

template<typename KMSKeyIdT = Aws::String>

Encryption & WithKMSKeyId (KMSKeyIdT &&value)

 

const Aws::String & GetKMSContext () const

 

bool KMSContextHasBeenSet () const

 

template<typename KMSContextT = Aws::String>

void SetKMSContext (KMSContextT &&value)

 

template<typename KMSContextT = Aws::String>

Encryption & WithKMSContext (KMSContextT &&value)

 

Detailed Description

Contains the type of server-side encryption used.

See Also:

AWS API Reference

Definition at line 31 of file Encryption.h.

Constructor & Destructor Documentation

Encryption() [1/2]

AWS_S3_API Aws::S3::Model::Encryption::Encryption ( )

default

Encryption() [2/2]

AWS_S3_API Aws::S3::Model::Encryption::Encryption ( const Aws::Utils::Xml::XmlNode &  xmlNode)

Member Function Documentation

AddToNode()

AWS_S3_API void Aws::S3::Model::Encryption::AddToNode ( Aws::Utils::Xml::XmlNode &  parentNode) const

EncryptionTypeHasBeenSet()

bool Aws::S3::Model::Encryption::EncryptionTypeHasBeenSet ( ) const

inline

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

Definition at line 47 of file Encryption.h.

GetEncryptionType()

ServerSideEncryption Aws::S3::Model::Encryption::GetEncryptionType ( ) const

inline

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

Definition at line 46 of file Encryption.h.

GetKMSContext()

const Aws::String & Aws::S3::Model::Encryption::GetKMSContext ( ) const

inline

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

Definition at line 75 of file Encryption.h.

GetKMSKeyId()

const Aws::String & Aws::S3::Model::Encryption::GetKMSKeyId ( ) const

inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 62 of file Encryption.h.

KMSContextHasBeenSet()

bool Aws::S3::Model::Encryption::KMSContextHasBeenSet ( ) const

inline

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

Definition at line 76 of file Encryption.h.

KMSKeyIdHasBeenSet()

bool Aws::S3::Model::Encryption::KMSKeyIdHasBeenSet ( ) const

inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 63 of file Encryption.h.

operator=()

AWS_S3_API Encryption & Aws::S3::Model::Encryption::operator= ( const Aws::Utils::Xml::XmlNode &  xmlNode)

SetEncryptionType()

void Aws::S3::Model::Encryption::SetEncryptionType ( ServerSideEncryption  value)

inline

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

Definition at line 48 of file Encryption.h.

SetKMSContext()

template<typename KMSContextT = Aws::String>

void Aws::S3::Model::Encryption::SetKMSContext ( KMSContextT &&  value)

inline

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

Definition at line 78 of file Encryption.h.

SetKMSKeyId()

template<typename KMSKeyIdT = Aws::String>

void Aws::S3::Model::Encryption::SetKMSKeyId ( KMSKeyIdT &&  value)

inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 65 of file Encryption.h.

WithEncryptionType()

Encryption & Aws::S3::Model::Encryption::WithEncryptionType ( ServerSideEncryption  value)

inline

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

Definition at line 49 of file Encryption.h.

WithKMSContext()

template<typename KMSContextT = Aws::String>

Encryption & Aws::S3::Model::Encryption::WithKMSContext ( KMSContextT &&  value)

inline

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

Definition at line 80 of file Encryption.h.

WithKMSKeyId()

template<typename KMSKeyIdT = Aws::String>

Encryption & Aws::S3::Model::Encryption::WithKMSKeyId ( KMSKeyIdT &&  value)

inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 67 of file Encryption.h.

---

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

• generated/src/aws-cpp-sdk-s3/include/aws/s3/model/Encryption.h