#include <StopStreamEncryptionRequest.h>

Inheritance diagram for Aws::Kinesis::Model::StopStreamEncryptionRequest:

Public Member Functions
	StopStreamEncryptionRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override

const Aws::String &	GetStreamName () const

bool	StreamNameHasBeenSet () const

void	SetStreamName (const Aws::String &value)

void	SetStreamName (Aws::String &&value)

void	SetStreamName (const char *value)

StopStreamEncryptionRequest &	WithStreamName (const Aws::String &value)

StopStreamEncryptionRequest &	WithStreamName (Aws::String &&value)

StopStreamEncryptionRequest &	WithStreamName (const char *value)

const EncryptionType &	GetEncryptionType () const

bool	EncryptionTypeHasBeenSet () const

void	SetEncryptionType (const EncryptionType &value)

void	SetEncryptionType (EncryptionType &&value)

StopStreamEncryptionRequest &	WithEncryptionType (const EncryptionType &value)

StopStreamEncryptionRequest &	WithEncryptionType (EncryptionType &&value)

const Aws::String &	GetKeyId () const

bool	KeyIdHasBeenSet () const

void	SetKeyId (const Aws::String &value)

void	SetKeyId (Aws::String &&value)

void	SetKeyId (const char *value)

StopStreamEncryptionRequest &	WithKeyId (const Aws::String &value)

StopStreamEncryptionRequest &	WithKeyId (Aws::String &&value)

StopStreamEncryptionRequest &	WithKeyId (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 StopStreamEncryptionRequest.h.

Constructor & Destructor Documentation

◆ StopStreamEncryptionRequest()

Aws::Kinesis::Model::StopStreamEncryptionRequest::StopStreamEncryptionRequest ( )

Member Function Documentation

◆ EncryptionTypeHasBeenSet()

bool Aws::Kinesis::Model::StopStreamEncryptionRequest::EncryptionTypeHasBeenSet ( ) const

inline

The encryption type. The only valid value is KMS.

Definition at line 87 of file StopStreamEncryptionRequest.h.

◆ GetEncryptionType()

const EncryptionType& Aws::Kinesis::Model::StopStreamEncryptionRequest::GetEncryptionType ( ) const

inline

The encryption type. The only valid value is KMS.

Definition at line 82 of file StopStreamEncryptionRequest.h.

◆ GetKeyId()

const Aws::String& Aws::Kinesis::Model::StopStreamEncryptionRequest::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 StopStreamEncryptionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Kinesis::Model::StopStreamEncryptionRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::Kinesis::KinesisRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Kinesis::Model::StopStreamEncryptionRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file StopStreamEncryptionRequest.h.

◆ GetStreamName()

const Aws::String& Aws::Kinesis::Model::StopStreamEncryptionRequest::GetStreamName ( ) const

inline

The name of the stream on which to stop encrypting records.

Definition at line 41 of file StopStreamEncryptionRequest.h.

◆ KeyIdHasBeenSet()

bool Aws::Kinesis::Model::StopStreamEncryptionRequest::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 StopStreamEncryptionRequest.h.

◆ SerializePayload()

Aws::String Aws::Kinesis::Model::StopStreamEncryptionRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEncryptionType() [1/2]

void Aws::Kinesis::Model::StopStreamEncryptionRequest::SetEncryptionType ( const EncryptionType & value )

inline

The encryption type. The only valid value is KMS.

Definition at line 92 of file StopStreamEncryptionRequest.h.

◆ SetEncryptionType() [2/2]

void Aws::Kinesis::Model::StopStreamEncryptionRequest::SetEncryptionType ( EncryptionType && value )

inline

The encryption type. The only valid value is KMS.

Definition at line 97 of file StopStreamEncryptionRequest.h.

◆ SetKeyId() [1/3]

void Aws::Kinesis::Model::StopStreamEncryptionRequest::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 StopStreamEncryptionRequest.h.

◆ SetKeyId() [2/3]

void Aws::Kinesis::Model::StopStreamEncryptionRequest::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 StopStreamEncryptionRequest.h.

◆ SetKeyId() [3/3]

void Aws::Kinesis::Model::StopStreamEncryptionRequest::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 StopStreamEncryptionRequest.h.

◆ SetStreamName() [1/3]

void Aws::Kinesis::Model::StopStreamEncryptionRequest::SetStreamName ( Aws::String && value )

inline

The name of the stream on which to stop encrypting records.

Definition at line 56 of file StopStreamEncryptionRequest.h.

◆ SetStreamName() [2/3]

void Aws::Kinesis::Model::StopStreamEncryptionRequest::SetStreamName ( const Aws::String & value )

inline

The name of the stream on which to stop encrypting records.

Definition at line 51 of file StopStreamEncryptionRequest.h.

◆ SetStreamName() [3/3]

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

inline

The name of the stream on which to stop encrypting records.

Definition at line 61 of file StopStreamEncryptionRequest.h.

◆ StreamNameHasBeenSet()

bool Aws::Kinesis::Model::StopStreamEncryptionRequest::StreamNameHasBeenSet ( ) const

inline

The name of the stream on which to stop encrypting records.

Definition at line 46 of file StopStreamEncryptionRequest.h.

◆ WithEncryptionType() [1/2]

StopStreamEncryptionRequest& Aws::Kinesis::Model::StopStreamEncryptionRequest::WithEncryptionType ( const EncryptionType & value )

inline

The encryption type. The only valid value is KMS.

Definition at line 102 of file StopStreamEncryptionRequest.h.

◆ WithEncryptionType() [2/2]

StopStreamEncryptionRequest& Aws::Kinesis::Model::StopStreamEncryptionRequest::WithEncryptionType ( EncryptionType && value )

inline

The encryption type. The only valid value is KMS.

Definition at line 107 of file StopStreamEncryptionRequest.h.

◆ WithKeyId() [1/3]

StopStreamEncryptionRequest& Aws::Kinesis::Model::StopStreamEncryptionRequest::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 StopStreamEncryptionRequest.h.

◆ WithKeyId() [2/3]

StopStreamEncryptionRequest& Aws::Kinesis::Model::StopStreamEncryptionRequest::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 StopStreamEncryptionRequest.h.

◆ WithKeyId() [3/3]

StopStreamEncryptionRequest& Aws::Kinesis::Model::StopStreamEncryptionRequest::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 StopStreamEncryptionRequest.h.

◆ WithStreamName() [1/3]

StopStreamEncryptionRequest& Aws::Kinesis::Model::StopStreamEncryptionRequest::WithStreamName ( Aws::String && value )

inline

The name of the stream on which to stop encrypting records.

Definition at line 71 of file StopStreamEncryptionRequest.h.

◆ WithStreamName() [2/3]

StopStreamEncryptionRequest& Aws::Kinesis::Model::StopStreamEncryptionRequest::WithStreamName ( const Aws::String & value )

inline

The name of the stream on which to stop encrypting records.

Definition at line 66 of file StopStreamEncryptionRequest.h.

◆ WithStreamName() [3/3]

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

inline

The name of the stream on which to stop encrypting records.

Definition at line 76 of file StopStreamEncryptionRequest.h.

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

aws-cpp-sdk-kinesis/include/aws/kinesis/model/StopStreamEncryptionRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StopStreamEncryptionRequest()

Member Function Documentation

◆ EncryptionTypeHasBeenSet()

◆ GetEncryptionType()

◆ GetKeyId()

◆ GetRequestSpecificHeaders()

◆ GetServiceRequestName()

◆ GetStreamName()

◆ KeyIdHasBeenSet()

◆ SerializePayload()

◆ SetEncryptionType() [1/2]

◆ SetEncryptionType() [2/2]

◆ SetKeyId() [1/3]

◆ SetKeyId() [2/3]

◆ SetKeyId() [3/3]

◆ SetStreamName() [1/3]

◆ SetStreamName() [2/3]

◆ SetStreamName() [3/3]

◆ StreamNameHasBeenSet()

◆ WithEncryptionType() [1/2]

◆ WithEncryptionType() [2/2]

◆ WithKeyId() [1/3]

◆ WithKeyId() [2/3]

◆ WithKeyId() [3/3]

◆ WithStreamName() [1/3]

◆ WithStreamName() [2/3]

◆ WithStreamName() [3/3]