AWS SDK for C++  1.9.128
AWS SDK for C++
Public Member Functions | List of all members
Aws::Athena::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 EncryptionOptionGetEncryptionOption () const
 
bool EncryptionOptionHasBeenSet () const
 
void SetEncryptionOption (const EncryptionOption &value)
 
void SetEncryptionOption (EncryptionOption &&value)
 
EncryptionConfigurationWithEncryptionOption (const EncryptionOption &value)
 
EncryptionConfigurationWithEncryptionOption (EncryptionOption &&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

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.

See Also:

AWS API Reference

Definition at line 34 of file EncryptionConfiguration.h.

Constructor & Destructor Documentation

◆ EncryptionConfiguration() [1/2]

Aws::Athena::Model::EncryptionConfiguration::EncryptionConfiguration ( )

◆ EncryptionConfiguration() [2/2]

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

Member Function Documentation

◆ EncryptionOptionHasBeenSet()

bool Aws::Athena::Model::EncryptionConfiguration::EncryptionOptionHasBeenSet ( ) const
inline

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

Definition at line 63 of file EncryptionConfiguration.h.

◆ GetEncryptionOption()

const EncryptionOption& Aws::Athena::Model::EncryptionConfiguration::GetEncryptionOption ( ) const
inline

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

Definition at line 52 of file EncryptionConfiguration.h.

◆ GetKmsKey()

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

Definition at line 114 of file EncryptionConfiguration.h.

◆ Jsonize()

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

◆ KmsKeyHasBeenSet()

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

Definition at line 120 of file EncryptionConfiguration.h.

◆ operator=()

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

◆ SetEncryptionOption() [1/2]

void Aws::Athena::Model::EncryptionConfiguration::SetEncryptionOption ( const EncryptionOption value)
inline

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

Definition at line 74 of file EncryptionConfiguration.h.

◆ SetEncryptionOption() [2/2]

void Aws::Athena::Model::EncryptionConfiguration::SetEncryptionOption ( EncryptionOption &&  value)
inline

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

Definition at line 85 of file EncryptionConfiguration.h.

◆ SetKmsKey() [1/3]

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

Definition at line 132 of file EncryptionConfiguration.h.

◆ SetKmsKey() [2/3]

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

Definition at line 126 of file EncryptionConfiguration.h.

◆ SetKmsKey() [3/3]

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

Definition at line 138 of file EncryptionConfiguration.h.

◆ WithEncryptionOption() [1/2]

EncryptionConfiguration& Aws::Athena::Model::EncryptionConfiguration::WithEncryptionOption ( const EncryptionOption value)
inline

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

Definition at line 96 of file EncryptionConfiguration.h.

◆ WithEncryptionOption() [2/2]

EncryptionConfiguration& Aws::Athena::Model::EncryptionConfiguration::WithEncryptionOption ( EncryptionOption &&  value)
inline

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

Definition at line 107 of file EncryptionConfiguration.h.

◆ WithKmsKey() [1/3]

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

Definition at line 150 of file EncryptionConfiguration.h.

◆ WithKmsKey() [2/3]

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

Definition at line 144 of file EncryptionConfiguration.h.

◆ WithKmsKey() [3/3]

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

Definition at line 156 of file EncryptionConfiguration.h.


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