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

#include <DeliveryStreamEncryptionConfigurationInput.h>

Public Member Functions

 DeliveryStreamEncryptionConfigurationInput ()
 
 DeliveryStreamEncryptionConfigurationInput (Aws::Utils::Json::JsonView jsonValue)
 
DeliveryStreamEncryptionConfigurationInputoperator= (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)
 
DeliveryStreamEncryptionConfigurationInputWithKeyARN (const Aws::String &value)
 
DeliveryStreamEncryptionConfigurationInputWithKeyARN (Aws::String &&value)
 
DeliveryStreamEncryptionConfigurationInputWithKeyARN (const char *value)
 
const KeyTypeGetKeyType () const
 
bool KeyTypeHasBeenSet () const
 
void SetKeyType (const KeyType &value)
 
void SetKeyType (KeyType &&value)
 
DeliveryStreamEncryptionConfigurationInputWithKeyType (const KeyType &value)
 
DeliveryStreamEncryptionConfigurationInputWithKeyType (KeyType &&value)
 

Detailed Description

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

See Also:

AWS API Reference

Definition at line 33 of file DeliveryStreamEncryptionConfigurationInput.h.

Constructor & Destructor Documentation

◆ DeliveryStreamEncryptionConfigurationInput() [1/2]

Aws::Firehose::Model::DeliveryStreamEncryptionConfigurationInput::DeliveryStreamEncryptionConfigurationInput ( )

◆ DeliveryStreamEncryptionConfigurationInput() [2/2]

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

Member Function Documentation

◆ GetKeyARN()

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

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

Definition at line 48 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ GetKeyType()

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

Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

Definition at line 132 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ Jsonize()

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

◆ KeyARNHasBeenSet()

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

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

Definition at line 56 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ KeyTypeHasBeenSet()

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

Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

Definition at line 159 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ operator=()

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

◆ SetKeyARN() [1/3]

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

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

Definition at line 64 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ SetKeyARN() [2/3]

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

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

Definition at line 72 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ SetKeyARN() [3/3]

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

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

Definition at line 80 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ SetKeyType() [1/2]

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

Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

Definition at line 186 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ SetKeyType() [2/2]

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

Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

Definition at line 213 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ WithKeyARN() [1/3]

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

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

Definition at line 88 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ WithKeyARN() [2/3]

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

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

Definition at line 96 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ WithKeyARN() [3/3]

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

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

Definition at line 104 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ WithKeyType() [1/2]

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

Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

Definition at line 240 of file DeliveryStreamEncryptionConfigurationInput.h.

◆ WithKeyType() [2/2]

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

Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

Definition at line 267 of file DeliveryStreamEncryptionConfigurationInput.h.


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