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

#include <StreamDescription.h>

Public Member Functions

 StreamDescription ()
 
 StreamDescription (Aws::Utils::Json::JsonView jsonValue)
 
StreamDescriptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetStreamName () const
 
bool StreamNameHasBeenSet () const
 
void SetStreamName (const Aws::String &value)
 
void SetStreamName (Aws::String &&value)
 
void SetStreamName (const char *value)
 
StreamDescriptionWithStreamName (const Aws::String &value)
 
StreamDescriptionWithStreamName (Aws::String &&value)
 
StreamDescriptionWithStreamName (const char *value)
 
const Aws::StringGetStreamARN () const
 
bool StreamARNHasBeenSet () const
 
void SetStreamARN (const Aws::String &value)
 
void SetStreamARN (Aws::String &&value)
 
void SetStreamARN (const char *value)
 
StreamDescriptionWithStreamARN (const Aws::String &value)
 
StreamDescriptionWithStreamARN (Aws::String &&value)
 
StreamDescriptionWithStreamARN (const char *value)
 
const StreamStatusGetStreamStatus () const
 
bool StreamStatusHasBeenSet () const
 
void SetStreamStatus (const StreamStatus &value)
 
void SetStreamStatus (StreamStatus &&value)
 
StreamDescriptionWithStreamStatus (const StreamStatus &value)
 
StreamDescriptionWithStreamStatus (StreamStatus &&value)
 
const Aws::Vector< Shard > & GetShards () const
 
bool ShardsHasBeenSet () const
 
void SetShards (const Aws::Vector< Shard > &value)
 
void SetShards (Aws::Vector< Shard > &&value)
 
StreamDescriptionWithShards (const Aws::Vector< Shard > &value)
 
StreamDescriptionWithShards (Aws::Vector< Shard > &&value)
 
StreamDescriptionAddShards (const Shard &value)
 
StreamDescriptionAddShards (Shard &&value)
 
bool GetHasMoreShards () const
 
bool HasMoreShardsHasBeenSet () const
 
void SetHasMoreShards (bool value)
 
StreamDescriptionWithHasMoreShards (bool value)
 
int GetRetentionPeriodHours () const
 
bool RetentionPeriodHoursHasBeenSet () const
 
void SetRetentionPeriodHours (int value)
 
StreamDescriptionWithRetentionPeriodHours (int value)
 
const Aws::Utils::DateTimeGetStreamCreationTimestamp () const
 
bool StreamCreationTimestampHasBeenSet () const
 
void SetStreamCreationTimestamp (const Aws::Utils::DateTime &value)
 
void SetStreamCreationTimestamp (Aws::Utils::DateTime &&value)
 
StreamDescriptionWithStreamCreationTimestamp (const Aws::Utils::DateTime &value)
 
StreamDescriptionWithStreamCreationTimestamp (Aws::Utils::DateTime &&value)
 
const Aws::Vector< EnhancedMetrics > & GetEnhancedMonitoring () const
 
bool EnhancedMonitoringHasBeenSet () const
 
void SetEnhancedMonitoring (const Aws::Vector< EnhancedMetrics > &value)
 
void SetEnhancedMonitoring (Aws::Vector< EnhancedMetrics > &&value)
 
StreamDescriptionWithEnhancedMonitoring (const Aws::Vector< EnhancedMetrics > &value)
 
StreamDescriptionWithEnhancedMonitoring (Aws::Vector< EnhancedMetrics > &&value)
 
StreamDescriptionAddEnhancedMonitoring (const EnhancedMetrics &value)
 
StreamDescriptionAddEnhancedMonitoring (EnhancedMetrics &&value)
 
const EncryptionTypeGetEncryptionType () const
 
bool EncryptionTypeHasBeenSet () const
 
void SetEncryptionType (const EncryptionType &value)
 
void SetEncryptionType (EncryptionType &&value)
 
StreamDescriptionWithEncryptionType (const EncryptionType &value)
 
StreamDescriptionWithEncryptionType (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)
 
StreamDescriptionWithKeyId (const Aws::String &value)
 
StreamDescriptionWithKeyId (Aws::String &&value)
 
StreamDescriptionWithKeyId (const char *value)
 

Detailed Description

Represents the output for DescribeStream.

See Also:


AWS API Reference

Definition at line 38 of file StreamDescription.h.

Constructor & Destructor Documentation

◆ StreamDescription() [1/2]

Aws::Kinesis::Model::StreamDescription::StreamDescription ( )

◆ StreamDescription() [2/2]

Aws::Kinesis::Model::StreamDescription::StreamDescription ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddEnhancedMonitoring() [1/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::AddEnhancedMonitoring ( const EnhancedMetrics value)
inline

Represents the current enhanced monitoring settings of the stream.

Definition at line 381 of file StreamDescription.h.

◆ AddEnhancedMonitoring() [2/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::AddEnhancedMonitoring ( EnhancedMetrics &&  value)
inline

Represents the current enhanced monitoring settings of the stream.

Definition at line 386 of file StreamDescription.h.

◆ AddShards() [1/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::AddShards ( const Shard value)
inline

The shards that comprise the stream.

Definition at line 259 of file StreamDescription.h.

◆ AddShards() [2/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::AddShards ( Shard &&  value)
inline

The shards that comprise the stream.

Definition at line 264 of file StreamDescription.h.

◆ EncryptionTypeHasBeenSet()

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

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 405 of file StreamDescription.h.

◆ EnhancedMonitoringHasBeenSet()

bool Aws::Kinesis::Model::StreamDescription::EnhancedMonitoringHasBeenSet ( ) const
inline

Represents the current enhanced monitoring settings of the stream.

Definition at line 356 of file StreamDescription.h.

◆ GetEncryptionType()

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

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 396 of file StreamDescription.h.

◆ GetEnhancedMonitoring()

const Aws::Vector<EnhancedMetrics>& Aws::Kinesis::Model::StreamDescription::GetEnhancedMonitoring ( ) const
inline

Represents the current enhanced monitoring settings of the stream.

Definition at line 351 of file StreamDescription.h.

◆ GetHasMoreShards()

bool Aws::Kinesis::Model::StreamDescription::GetHasMoreShards ( ) const
inline

If set to true, more shards in the stream are available to describe.

Definition at line 271 of file StreamDescription.h.

◆ GetKeyId()

const Aws::String& Aws::Kinesis::Model::StreamDescription::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 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 458 of file StreamDescription.h.

◆ GetRetentionPeriodHours()

int Aws::Kinesis::Model::StreamDescription::GetRetentionPeriodHours ( ) const
inline

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

Definition at line 296 of file StreamDescription.h.

◆ GetShards()

const Aws::Vector<Shard>& Aws::Kinesis::Model::StreamDescription::GetShards ( ) const
inline

The shards that comprise the stream.

Definition at line 229 of file StreamDescription.h.

◆ GetStreamARN()

const Aws::String& Aws::Kinesis::Model::StreamDescription::GetStreamARN ( ) const
inline

The Amazon Resource Name (ARN) for the stream being described.

Definition at line 91 of file StreamDescription.h.

◆ GetStreamCreationTimestamp()

const Aws::Utils::DateTime& Aws::Kinesis::Model::StreamDescription::GetStreamCreationTimestamp ( ) const
inline

The approximate time that the stream was created.

Definition at line 320 of file StreamDescription.h.

◆ GetStreamName()

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

The name of the stream being described.

Definition at line 50 of file StreamDescription.h.

◆ GetStreamStatus()

const StreamStatus& Aws::Kinesis::Model::StreamDescription::GetStreamStatus ( ) const
inline

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Definition at line 143 of file StreamDescription.h.

◆ HasMoreShardsHasBeenSet()

bool Aws::Kinesis::Model::StreamDescription::HasMoreShardsHasBeenSet ( ) const
inline

If set to true, more shards in the stream are available to describe.

Definition at line 277 of file StreamDescription.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Kinesis::Model::StreamDescription::Jsonize ( ) const

◆ KeyIdHasBeenSet()

bool Aws::Kinesis::Model::StreamDescription::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 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 474 of file StreamDescription.h.

◆ operator=()

StreamDescription& Aws::Kinesis::Model::StreamDescription::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RetentionPeriodHoursHasBeenSet()

bool Aws::Kinesis::Model::StreamDescription::RetentionPeriodHoursHasBeenSet ( ) const
inline

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

Definition at line 302 of file StreamDescription.h.

◆ SetEncryptionType() [1/2]

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

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 414 of file StreamDescription.h.

◆ SetEncryptionType() [2/2]

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

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 423 of file StreamDescription.h.

◆ SetEnhancedMonitoring() [1/2]

void Aws::Kinesis::Model::StreamDescription::SetEnhancedMonitoring ( Aws::Vector< EnhancedMetrics > &&  value)
inline

Represents the current enhanced monitoring settings of the stream.

Definition at line 366 of file StreamDescription.h.

◆ SetEnhancedMonitoring() [2/2]

void Aws::Kinesis::Model::StreamDescription::SetEnhancedMonitoring ( const Aws::Vector< EnhancedMetrics > &  value)
inline

Represents the current enhanced monitoring settings of the stream.

Definition at line 361 of file StreamDescription.h.

◆ SetHasMoreShards()

void Aws::Kinesis::Model::StreamDescription::SetHasMoreShards ( bool  value)
inline

If set to true, more shards in the stream are available to describe.

Definition at line 283 of file StreamDescription.h.

◆ SetKeyId() [1/3]

void Aws::Kinesis::Model::StreamDescription::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 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 506 of file StreamDescription.h.

◆ SetKeyId() [2/3]

void Aws::Kinesis::Model::StreamDescription::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 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 490 of file StreamDescription.h.

◆ SetKeyId() [3/3]

void Aws::Kinesis::Model::StreamDescription::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 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 522 of file StreamDescription.h.

◆ SetRetentionPeriodHours()

void Aws::Kinesis::Model::StreamDescription::SetRetentionPeriodHours ( int  value)
inline

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

Definition at line 308 of file StreamDescription.h.

◆ SetShards() [1/2]

void Aws::Kinesis::Model::StreamDescription::SetShards ( Aws::Vector< Shard > &&  value)
inline

The shards that comprise the stream.

Definition at line 244 of file StreamDescription.h.

◆ SetShards() [2/2]

void Aws::Kinesis::Model::StreamDescription::SetShards ( const Aws::Vector< Shard > &  value)
inline

The shards that comprise the stream.

Definition at line 239 of file StreamDescription.h.

◆ SetStreamARN() [1/3]

void Aws::Kinesis::Model::StreamDescription::SetStreamARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the stream being described.

Definition at line 106 of file StreamDescription.h.

◆ SetStreamARN() [2/3]

void Aws::Kinesis::Model::StreamDescription::SetStreamARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the stream being described.

Definition at line 101 of file StreamDescription.h.

◆ SetStreamARN() [3/3]

void Aws::Kinesis::Model::StreamDescription::SetStreamARN ( const char *  value)
inline

The Amazon Resource Name (ARN) for the stream being described.

Definition at line 111 of file StreamDescription.h.

◆ SetStreamCreationTimestamp() [1/2]

void Aws::Kinesis::Model::StreamDescription::SetStreamCreationTimestamp ( Aws::Utils::DateTime &&  value)
inline

The approximate time that the stream was created.

Definition at line 335 of file StreamDescription.h.

◆ SetStreamCreationTimestamp() [2/2]

void Aws::Kinesis::Model::StreamDescription::SetStreamCreationTimestamp ( const Aws::Utils::DateTime value)
inline

The approximate time that the stream was created.

Definition at line 330 of file StreamDescription.h.

◆ SetStreamName() [1/3]

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

The name of the stream being described.

Definition at line 65 of file StreamDescription.h.

◆ SetStreamName() [2/3]

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

The name of the stream being described.

Definition at line 60 of file StreamDescription.h.

◆ SetStreamName() [3/3]

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

The name of the stream being described.

Definition at line 70 of file StreamDescription.h.

◆ SetStreamStatus() [1/2]

void Aws::Kinesis::Model::StreamDescription::SetStreamStatus ( const StreamStatus value)
inline

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Definition at line 175 of file StreamDescription.h.

◆ SetStreamStatus() [2/2]

void Aws::Kinesis::Model::StreamDescription::SetStreamStatus ( StreamStatus &&  value)
inline

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Definition at line 191 of file StreamDescription.h.

◆ ShardsHasBeenSet()

bool Aws::Kinesis::Model::StreamDescription::ShardsHasBeenSet ( ) const
inline

The shards that comprise the stream.

Definition at line 234 of file StreamDescription.h.

◆ StreamARNHasBeenSet()

bool Aws::Kinesis::Model::StreamDescription::StreamARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the stream being described.

Definition at line 96 of file StreamDescription.h.

◆ StreamCreationTimestampHasBeenSet()

bool Aws::Kinesis::Model::StreamDescription::StreamCreationTimestampHasBeenSet ( ) const
inline

The approximate time that the stream was created.

Definition at line 325 of file StreamDescription.h.

◆ StreamNameHasBeenSet()

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

The name of the stream being described.

Definition at line 55 of file StreamDescription.h.

◆ StreamStatusHasBeenSet()

bool Aws::Kinesis::Model::StreamDescription::StreamStatusHasBeenSet ( ) const
inline

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Definition at line 159 of file StreamDescription.h.

◆ WithEncryptionType() [1/2]

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

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 432 of file StreamDescription.h.

◆ WithEncryptionType() [2/2]

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

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 441 of file StreamDescription.h.

◆ WithEnhancedMonitoring() [1/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithEnhancedMonitoring ( Aws::Vector< EnhancedMetrics > &&  value)
inline

Represents the current enhanced monitoring settings of the stream.

Definition at line 376 of file StreamDescription.h.

◆ WithEnhancedMonitoring() [2/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithEnhancedMonitoring ( const Aws::Vector< EnhancedMetrics > &  value)
inline

Represents the current enhanced monitoring settings of the stream.

Definition at line 371 of file StreamDescription.h.

◆ WithHasMoreShards()

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithHasMoreShards ( bool  value)
inline

If set to true, more shards in the stream are available to describe.

Definition at line 289 of file StreamDescription.h.

◆ WithKeyId() [1/3]

StreamDescription& Aws::Kinesis::Model::StreamDescription::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 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 554 of file StreamDescription.h.

◆ WithKeyId() [2/3]

StreamDescription& Aws::Kinesis::Model::StreamDescription::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 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 538 of file StreamDescription.h.

◆ WithKeyId() [3/3]

StreamDescription& Aws::Kinesis::Model::StreamDescription::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 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 570 of file StreamDescription.h.

◆ WithRetentionPeriodHours()

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithRetentionPeriodHours ( int  value)
inline

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

Definition at line 314 of file StreamDescription.h.

◆ WithShards() [1/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithShards ( Aws::Vector< Shard > &&  value)
inline

The shards that comprise the stream.

Definition at line 254 of file StreamDescription.h.

◆ WithShards() [2/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithShards ( const Aws::Vector< Shard > &  value)
inline

The shards that comprise the stream.

Definition at line 249 of file StreamDescription.h.

◆ WithStreamARN() [1/3]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithStreamARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the stream being described.

Definition at line 121 of file StreamDescription.h.

◆ WithStreamARN() [2/3]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithStreamARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the stream being described.

Definition at line 116 of file StreamDescription.h.

◆ WithStreamARN() [3/3]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithStreamARN ( const char *  value)
inline

The Amazon Resource Name (ARN) for the stream being described.

Definition at line 126 of file StreamDescription.h.

◆ WithStreamCreationTimestamp() [1/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithStreamCreationTimestamp ( Aws::Utils::DateTime &&  value)
inline

The approximate time that the stream was created.

Definition at line 345 of file StreamDescription.h.

◆ WithStreamCreationTimestamp() [2/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithStreamCreationTimestamp ( const Aws::Utils::DateTime value)
inline

The approximate time that the stream was created.

Definition at line 340 of file StreamDescription.h.

◆ WithStreamName() [1/3]

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

The name of the stream being described.

Definition at line 80 of file StreamDescription.h.

◆ WithStreamName() [2/3]

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

The name of the stream being described.

Definition at line 75 of file StreamDescription.h.

◆ WithStreamName() [3/3]

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

The name of the stream being described.

Definition at line 85 of file StreamDescription.h.

◆ WithStreamStatus() [1/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithStreamStatus ( const StreamStatus value)
inline

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Definition at line 207 of file StreamDescription.h.

◆ WithStreamStatus() [2/2]

StreamDescription& Aws::Kinesis::Model::StreamDescription::WithStreamStatus ( StreamStatus &&  value)
inline

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Definition at line 223 of file StreamDescription.h.


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