AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration Class Reference

#include <DeliveryStreamEncryptionConfiguration.h>

Public Member Functions

 DeliveryStreamEncryptionConfiguration ()
 
 DeliveryStreamEncryptionConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
DeliveryStreamEncryptionConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetKeyARN () const
 
bool KeyARNHasBeenSet () const
 
void SetKeyARN (const Aws::String &value)
 
void SetKeyARN (Aws::String &&value)
 
void SetKeyARN (const char *value)
 
DeliveryStreamEncryptionConfigurationWithKeyARN (const Aws::String &value)
 
DeliveryStreamEncryptionConfigurationWithKeyARN (Aws::String &&value)
 
DeliveryStreamEncryptionConfigurationWithKeyARN (const char *value)
 
const KeyTypeGetKeyType () const
 
bool KeyTypeHasBeenSet () const
 
void SetKeyType (const KeyType &value)
 
void SetKeyType (KeyType &&value)
 
DeliveryStreamEncryptionConfigurationWithKeyType (const KeyType &value)
 
DeliveryStreamEncryptionConfigurationWithKeyType (KeyType &&value)
 
const DeliveryStreamEncryptionStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const DeliveryStreamEncryptionStatus &value)
 
void SetStatus (DeliveryStreamEncryptionStatus &&value)
 
DeliveryStreamEncryptionConfigurationWithStatus (const DeliveryStreamEncryptionStatus &value)
 
DeliveryStreamEncryptionConfigurationWithStatus (DeliveryStreamEncryptionStatus &&value)
 
const FailureDescriptionGetFailureDescription () const
 
bool FailureDescriptionHasBeenSet () const
 
void SetFailureDescription (const FailureDescription &value)
 
void SetFailureDescription (FailureDescription &&value)
 
DeliveryStreamEncryptionConfigurationWithFailureDescription (const FailureDescription &value)
 
DeliveryStreamEncryptionConfigurationWithFailureDescription (FailureDescription &&value)
 

Detailed Description

Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream operation.

See Also:

AWS API Reference

Definition at line 38 of file DeliveryStreamEncryptionConfiguration.h.

Constructor & Destructor Documentation

◆ DeliveryStreamEncryptionConfiguration() [1/2]

Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::DeliveryStreamEncryptionConfiguration ( )

◆ DeliveryStreamEncryptionConfiguration() [2/2]

Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::DeliveryStreamEncryptionConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ FailureDescriptionHasBeenSet()

bool Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::FailureDescriptionHasBeenSet ( ) const
inline

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Definition at line 240 of file DeliveryStreamEncryptionConfiguration.h.

◆ GetFailureDescription()

const FailureDescription& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::GetFailureDescription ( ) const
inline

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Definition at line 233 of file DeliveryStreamEncryptionConfiguration.h.

◆ GetKeyARN()

const Aws::String& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::GetKeyARN ( ) const
inline

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Definition at line 53 of file DeliveryStreamEncryptionConfiguration.h.

◆ GetKeyType()

const KeyType& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::GetKeyType ( ) const
inline

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

Definition at line 119 of file DeliveryStreamEncryptionConfiguration.h.

◆ GetStatus()

const DeliveryStreamEncryptionStatus& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::GetStatus ( ) const
inline

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

Definition at line 175 of file DeliveryStreamEncryptionConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::Jsonize ( ) const

◆ KeyARNHasBeenSet()

bool Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::KeyARNHasBeenSet ( ) const
inline

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Definition at line 61 of file DeliveryStreamEncryptionConfiguration.h.

◆ KeyTypeHasBeenSet()

bool Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::KeyTypeHasBeenSet ( ) const
inline

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

Definition at line 128 of file DeliveryStreamEncryptionConfiguration.h.

◆ operator=()

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetFailureDescription() [1/2]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetFailureDescription ( const FailureDescription value)
inline

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Definition at line 247 of file DeliveryStreamEncryptionConfiguration.h.

◆ SetFailureDescription() [2/2]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetFailureDescription ( FailureDescription &&  value)
inline

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Definition at line 254 of file DeliveryStreamEncryptionConfiguration.h.

◆ SetKeyARN() [1/3]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetKeyARN ( const Aws::String value)
inline

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Definition at line 69 of file DeliveryStreamEncryptionConfiguration.h.

◆ SetKeyARN() [2/3]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetKeyARN ( Aws::String &&  value)
inline

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Definition at line 77 of file DeliveryStreamEncryptionConfiguration.h.

◆ SetKeyARN() [3/3]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetKeyARN ( const char *  value)
inline

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Definition at line 85 of file DeliveryStreamEncryptionConfiguration.h.

◆ SetKeyType() [1/2]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetKeyType ( const KeyType value)
inline

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

Definition at line 137 of file DeliveryStreamEncryptionConfiguration.h.

◆ SetKeyType() [2/2]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetKeyType ( KeyType &&  value)
inline

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

Definition at line 146 of file DeliveryStreamEncryptionConfiguration.h.

◆ SetStatus() [1/2]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetStatus ( const DeliveryStreamEncryptionStatus value)
inline

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

Definition at line 195 of file DeliveryStreamEncryptionConfiguration.h.

◆ SetStatus() [2/2]

void Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::SetStatus ( DeliveryStreamEncryptionStatus &&  value)
inline

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

Definition at line 205 of file DeliveryStreamEncryptionConfiguration.h.

◆ StatusHasBeenSet()

bool Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::StatusHasBeenSet ( ) const
inline

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

Definition at line 185 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithFailureDescription() [1/2]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithFailureDescription ( const FailureDescription value)
inline

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Definition at line 261 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithFailureDescription() [2/2]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithFailureDescription ( FailureDescription &&  value)
inline

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Definition at line 268 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithKeyARN() [1/3]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithKeyARN ( const Aws::String value)
inline

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Definition at line 93 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithKeyARN() [2/3]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithKeyARN ( Aws::String &&  value)
inline

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Definition at line 101 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithKeyARN() [3/3]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithKeyARN ( const char *  value)
inline

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Definition at line 109 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithKeyType() [1/2]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithKeyType ( const KeyType value)
inline

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

Definition at line 155 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithKeyType() [2/2]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithKeyType ( KeyType &&  value)
inline

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

Definition at line 164 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithStatus() [1/2]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithStatus ( const DeliveryStreamEncryptionStatus value)
inline

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

Definition at line 215 of file DeliveryStreamEncryptionConfiguration.h.

◆ WithStatus() [2/2]

DeliveryStreamEncryptionConfiguration& Aws::Firehose::Model::DeliveryStreamEncryptionConfiguration::WithStatus ( DeliveryStreamEncryptionStatus &&  value)
inline

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

Definition at line 225 of file DeliveryStreamEncryptionConfiguration.h.


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