AWS SDK for C++  1.8.4
AWS SDK for C++
Public Member Functions | List of all members
Aws::Kinesis::Model::StartStreamEncryptionRequest Class Reference

#include <StartStreamEncryptionRequest.h>

+ Inheritance diagram for Aws::Kinesis::Model::StartStreamEncryptionRequest:

Public Member Functions

 StartStreamEncryptionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetStreamName () const
 
bool StreamNameHasBeenSet () const
 
void SetStreamName (const Aws::String &value)
 
void SetStreamName (Aws::String &&value)
 
void SetStreamName (const char *value)
 
StartStreamEncryptionRequestWithStreamName (const Aws::String &value)
 
StartStreamEncryptionRequestWithStreamName (Aws::String &&value)
 
StartStreamEncryptionRequestWithStreamName (const char *value)
 
const EncryptionTypeGetEncryptionType () const
 
bool EncryptionTypeHasBeenSet () const
 
void SetEncryptionType (const EncryptionType &value)
 
void SetEncryptionType (EncryptionType &&value)
 
StartStreamEncryptionRequestWithEncryptionType (const EncryptionType &value)
 
StartStreamEncryptionRequestWithEncryptionType (EncryptionType &&value)
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
StartStreamEncryptionRequestWithKeyId (const Aws::String &value)
 
StartStreamEncryptionRequestWithKeyId (Aws::String &&value)
 
StartStreamEncryptionRequestWithKeyId (const char *value)
 
- Public Member Functions inherited from Aws::Kinesis::KinesisRequest
virtual ~KinesisRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file StartStreamEncryptionRequest.h.

Constructor & Destructor Documentation

◆ StartStreamEncryptionRequest()

Aws::Kinesis::Model::StartStreamEncryptionRequest::StartStreamEncryptionRequest ( )

Member Function Documentation

◆ EncryptionTypeHasBeenSet()

bool Aws::Kinesis::Model::StartStreamEncryptionRequest::EncryptionTypeHasBeenSet ( ) const
inline

The encryption type to use. The only valid value is KMS.

Definition at line 87 of file StartStreamEncryptionRequest.h.

◆ GetEncryptionType()

const EncryptionType& Aws::Kinesis::Model::StartStreamEncryptionRequest::GetEncryptionType ( ) const
inline

The encryption type to use. The only valid value is KMS.

Definition at line 82 of file StartStreamEncryptionRequest.h.

◆ GetKeyId()

const Aws::String& Aws::Kinesis::Model::StartStreamEncryptionRequest::GetKeyId ( ) const
inline

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Definition at line 124 of file StartStreamEncryptionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Kinesis::Model::StartStreamEncryptionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Kinesis::KinesisRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Kinesis::Model::StartStreamEncryptionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file StartStreamEncryptionRequest.h.

◆ GetStreamName()

const Aws::String& Aws::Kinesis::Model::StartStreamEncryptionRequest::GetStreamName ( ) const
inline

The name of the stream for which to start encrypting records.

Definition at line 41 of file StartStreamEncryptionRequest.h.

◆ KeyIdHasBeenSet()

bool Aws::Kinesis::Model::StartStreamEncryptionRequest::KeyIdHasBeenSet ( ) const
inline

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Definition at line 140 of file StartStreamEncryptionRequest.h.

◆ SerializePayload()

Aws::String Aws::Kinesis::Model::StartStreamEncryptionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEncryptionType() [1/2]

void Aws::Kinesis::Model::StartStreamEncryptionRequest::SetEncryptionType ( const EncryptionType value)
inline

The encryption type to use. The only valid value is KMS.

Definition at line 92 of file StartStreamEncryptionRequest.h.

◆ SetEncryptionType() [2/2]

void Aws::Kinesis::Model::StartStreamEncryptionRequest::SetEncryptionType ( EncryptionType &&  value)
inline

The encryption type to use. The only valid value is KMS.

Definition at line 97 of file StartStreamEncryptionRequest.h.

◆ SetKeyId() [1/3]

void Aws::Kinesis::Model::StartStreamEncryptionRequest::SetKeyId ( const Aws::String value)
inline

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Definition at line 156 of file StartStreamEncryptionRequest.h.

◆ SetKeyId() [2/3]

void Aws::Kinesis::Model::StartStreamEncryptionRequest::SetKeyId ( Aws::String &&  value)
inline

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Definition at line 172 of file StartStreamEncryptionRequest.h.

◆ SetKeyId() [3/3]

void Aws::Kinesis::Model::StartStreamEncryptionRequest::SetKeyId ( const char *  value)
inline

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Definition at line 188 of file StartStreamEncryptionRequest.h.

◆ SetStreamName() [1/3]

void Aws::Kinesis::Model::StartStreamEncryptionRequest::SetStreamName ( const Aws::String value)
inline

The name of the stream for which to start encrypting records.

Definition at line 51 of file StartStreamEncryptionRequest.h.

◆ SetStreamName() [2/3]

void Aws::Kinesis::Model::StartStreamEncryptionRequest::SetStreamName ( Aws::String &&  value)
inline

The name of the stream for which to start encrypting records.

Definition at line 56 of file StartStreamEncryptionRequest.h.

◆ SetStreamName() [3/3]

void Aws::Kinesis::Model::StartStreamEncryptionRequest::SetStreamName ( const char *  value)
inline

The name of the stream for which to start encrypting records.

Definition at line 61 of file StartStreamEncryptionRequest.h.

◆ StreamNameHasBeenSet()

bool Aws::Kinesis::Model::StartStreamEncryptionRequest::StreamNameHasBeenSet ( ) const
inline

The name of the stream for which to start encrypting records.

Definition at line 46 of file StartStreamEncryptionRequest.h.

◆ WithEncryptionType() [1/2]

StartStreamEncryptionRequest& Aws::Kinesis::Model::StartStreamEncryptionRequest::WithEncryptionType ( const EncryptionType value)
inline

The encryption type to use. The only valid value is KMS.

Definition at line 102 of file StartStreamEncryptionRequest.h.

◆ WithEncryptionType() [2/2]

StartStreamEncryptionRequest& Aws::Kinesis::Model::StartStreamEncryptionRequest::WithEncryptionType ( EncryptionType &&  value)
inline

The encryption type to use. The only valid value is KMS.

Definition at line 107 of file StartStreamEncryptionRequest.h.

◆ WithKeyId() [1/3]

StartStreamEncryptionRequest& Aws::Kinesis::Model::StartStreamEncryptionRequest::WithKeyId ( const Aws::String value)
inline

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Definition at line 204 of file StartStreamEncryptionRequest.h.

◆ WithKeyId() [2/3]

StartStreamEncryptionRequest& Aws::Kinesis::Model::StartStreamEncryptionRequest::WithKeyId ( Aws::String &&  value)
inline

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Definition at line 220 of file StartStreamEncryptionRequest.h.

◆ WithKeyId() [3/3]

StartStreamEncryptionRequest& Aws::Kinesis::Model::StartStreamEncryptionRequest::WithKeyId ( const char *  value)
inline

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Definition at line 236 of file StartStreamEncryptionRequest.h.

◆ WithStreamName() [1/3]

StartStreamEncryptionRequest& Aws::Kinesis::Model::StartStreamEncryptionRequest::WithStreamName ( const Aws::String value)
inline

The name of the stream for which to start encrypting records.

Definition at line 66 of file StartStreamEncryptionRequest.h.

◆ WithStreamName() [2/3]

StartStreamEncryptionRequest& Aws::Kinesis::Model::StartStreamEncryptionRequest::WithStreamName ( Aws::String &&  value)
inline

The name of the stream for which to start encrypting records.

Definition at line 71 of file StartStreamEncryptionRequest.h.

◆ WithStreamName() [3/3]

StartStreamEncryptionRequest& Aws::Kinesis::Model::StartStreamEncryptionRequest::WithStreamName ( const char *  value)
inline

The name of the stream for which to start encrypting records.

Definition at line 76 of file StartStreamEncryptionRequest.h.


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