AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3::Model::Encryption Class Reference

#include <Encryption.h>

Public Member Functions

 Encryption ()
 
 Encryption (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Encryptionoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const ServerSideEncryptionGetEncryptionType () const
 
bool EncryptionTypeHasBeenSet () const
 
void SetEncryptionType (const ServerSideEncryption &value)
 
void SetEncryptionType (ServerSideEncryption &&value)
 
EncryptionWithEncryptionType (const ServerSideEncryption &value)
 
EncryptionWithEncryptionType (ServerSideEncryption &&value)
 
const Aws::StringGetKMSKeyId () const
 
bool KMSKeyIdHasBeenSet () const
 
void SetKMSKeyId (const Aws::String &value)
 
void SetKMSKeyId (Aws::String &&value)
 
void SetKMSKeyId (const char *value)
 
EncryptionWithKMSKeyId (const Aws::String &value)
 
EncryptionWithKMSKeyId (Aws::String &&value)
 
EncryptionWithKMSKeyId (const char *value)
 
const Aws::StringGetKMSContext () const
 
bool KMSContextHasBeenSet () const
 
void SetKMSContext (const Aws::String &value)
 
void SetKMSContext (Aws::String &&value)
 
void SetKMSContext (const char *value)
 
EncryptionWithKMSContext (const Aws::String &value)
 
EncryptionWithKMSContext (Aws::String &&value)
 
EncryptionWithKMSContext (const char *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::Model::Encryption::Encryption ( )

◆ Encryption() [2/2]

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

Member Function Documentation

◆ AddToNode()

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 51 of file Encryption.h.

◆ GetEncryptionType()

const 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 45 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 171 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 customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Definition at line 87 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 177 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 customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Definition at line 98 of file Encryption.h.

◆ operator=()

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

◆ SetEncryptionType() [1/2]

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

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

Definition at line 57 of file Encryption.h.

◆ SetEncryptionType() [2/2]

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 63 of file Encryption.h.

◆ SetKMSContext() [1/3]

void Aws::S3::Model::Encryption::SetKMSContext ( const Aws::String 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 183 of file Encryption.h.

◆ SetKMSContext() [2/3]

void Aws::S3::Model::Encryption::SetKMSContext ( Aws::String &&  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 189 of file Encryption.h.

◆ SetKMSContext() [3/3]

void Aws::S3::Model::Encryption::SetKMSContext ( const char *  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 195 of file Encryption.h.

◆ SetKMSKeyId() [1/3]

void Aws::S3::Model::Encryption::SetKMSKeyId ( const Aws::String value)
inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Definition at line 109 of file Encryption.h.

◆ SetKMSKeyId() [2/3]

void Aws::S3::Model::Encryption::SetKMSKeyId ( Aws::String &&  value)
inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Definition at line 120 of file Encryption.h.

◆ SetKMSKeyId() [3/3]

void Aws::S3::Model::Encryption::SetKMSKeyId ( const char *  value)
inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Definition at line 131 of file Encryption.h.

◆ WithEncryptionType() [1/2]

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

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

Definition at line 69 of file Encryption.h.

◆ WithEncryptionType() [2/2]

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 75 of file Encryption.h.

◆ WithKMSContext() [1/3]

Encryption& Aws::S3::Model::Encryption::WithKMSContext ( const Aws::String 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 201 of file Encryption.h.

◆ WithKMSContext() [2/3]

Encryption& Aws::S3::Model::Encryption::WithKMSContext ( Aws::String &&  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 207 of file Encryption.h.

◆ WithKMSContext() [3/3]

Encryption& Aws::S3::Model::Encryption::WithKMSContext ( const char *  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 213 of file Encryption.h.

◆ WithKMSKeyId() [1/3]

Encryption& Aws::S3::Model::Encryption::WithKMSKeyId ( const Aws::String value)
inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Definition at line 142 of file Encryption.h.

◆ WithKMSKeyId() [2/3]

Encryption& Aws::S3::Model::Encryption::WithKMSKeyId ( Aws::String &&  value)
inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Definition at line 153 of file Encryption.h.

◆ WithKMSKeyId() [3/3]

Encryption& Aws::S3::Model::Encryption::WithKMSKeyId ( const char *  value)
inline

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Definition at line 164 of file Encryption.h.


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