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

#include <StreamDescriptionSummary.h>

Public Member Functions

 StreamDescriptionSummary ()
 
 StreamDescriptionSummary (Aws::Utils::Json::JsonView jsonValue)
 
StreamDescriptionSummaryoperator= (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)
 
StreamDescriptionSummaryWithStreamName (const Aws::String &value)
 
StreamDescriptionSummaryWithStreamName (Aws::String &&value)
 
StreamDescriptionSummaryWithStreamName (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)
 
StreamDescriptionSummaryWithStreamARN (const Aws::String &value)
 
StreamDescriptionSummaryWithStreamARN (Aws::String &&value)
 
StreamDescriptionSummaryWithStreamARN (const char *value)
 
const StreamStatusGetStreamStatus () const
 
bool StreamStatusHasBeenSet () const
 
void SetStreamStatus (const StreamStatus &value)
 
void SetStreamStatus (StreamStatus &&value)
 
StreamDescriptionSummaryWithStreamStatus (const StreamStatus &value)
 
StreamDescriptionSummaryWithStreamStatus (StreamStatus &&value)
 
int GetRetentionPeriodHours () const
 
bool RetentionPeriodHoursHasBeenSet () const
 
void SetRetentionPeriodHours (int value)
 
StreamDescriptionSummaryWithRetentionPeriodHours (int value)
 
const Aws::Utils::DateTimeGetStreamCreationTimestamp () const
 
bool StreamCreationTimestampHasBeenSet () const
 
void SetStreamCreationTimestamp (const Aws::Utils::DateTime &value)
 
void SetStreamCreationTimestamp (Aws::Utils::DateTime &&value)
 
StreamDescriptionSummaryWithStreamCreationTimestamp (const Aws::Utils::DateTime &value)
 
StreamDescriptionSummaryWithStreamCreationTimestamp (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)
 
StreamDescriptionSummaryWithEnhancedMonitoring (const Aws::Vector< EnhancedMetrics > &value)
 
StreamDescriptionSummaryWithEnhancedMonitoring (Aws::Vector< EnhancedMetrics > &&value)
 
StreamDescriptionSummaryAddEnhancedMonitoring (const EnhancedMetrics &value)
 
StreamDescriptionSummaryAddEnhancedMonitoring (EnhancedMetrics &&value)
 
const EncryptionTypeGetEncryptionType () const
 
bool EncryptionTypeHasBeenSet () const
 
void SetEncryptionType (const EncryptionType &value)
 
void SetEncryptionType (EncryptionType &&value)
 
StreamDescriptionSummaryWithEncryptionType (const EncryptionType &value)
 
StreamDescriptionSummaryWithEncryptionType (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)
 
StreamDescriptionSummaryWithKeyId (const Aws::String &value)
 
StreamDescriptionSummaryWithKeyId (Aws::String &&value)
 
StreamDescriptionSummaryWithKeyId (const char *value)
 
int GetOpenShardCount () const
 
bool OpenShardCountHasBeenSet () const
 
void SetOpenShardCount (int value)
 
StreamDescriptionSummaryWithOpenShardCount (int value)
 
int GetConsumerCount () const
 
bool ConsumerCountHasBeenSet () const
 
void SetConsumerCount (int value)
 
StreamDescriptionSummaryWithConsumerCount (int value)
 

Detailed Description

Represents the output for DescribeStreamSummary

See Also:

AWS API Reference

Definition at line 37 of file StreamDescriptionSummary.h.

Constructor & Destructor Documentation

◆ StreamDescriptionSummary() [1/2]

Aws::Kinesis::Model::StreamDescriptionSummary::StreamDescriptionSummary ( )

◆ StreamDescriptionSummary() [2/2]

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

Member Function Documentation

◆ AddEnhancedMonitoring() [1/2]

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

Represents the current enhanced monitoring settings of the stream.

Definition at line 310 of file StreamDescriptionSummary.h.

◆ AddEnhancedMonitoring() [2/2]

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

Represents the current enhanced monitoring settings of the stream.

Definition at line 315 of file StreamDescriptionSummary.h.

◆ ConsumerCountHasBeenSet()

bool Aws::Kinesis::Model::StreamDescriptionSummary::ConsumerCountHasBeenSet ( ) const
inline

The number of enhanced fan-out consumers registered with the stream.

Definition at line 513 of file StreamDescriptionSummary.h.

◆ EncryptionTypeHasBeenSet()

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

The encryption type used. This value is one of the following:

Definition at line 328 of file StreamDescriptionSummary.h.

◆ EnhancedMonitoringHasBeenSet()

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

Represents the current enhanced monitoring settings of the stream.

Definition at line 285 of file StreamDescriptionSummary.h.

◆ GetConsumerCount()

int Aws::Kinesis::Model::StreamDescriptionSummary::GetConsumerCount ( ) const
inline

The number of enhanced fan-out consumers registered with the stream.

Definition at line 508 of file StreamDescriptionSummary.h.

◆ GetEncryptionType()

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

The encryption type used. This value is one of the following:

Definition at line 322 of file StreamDescriptionSummary.h.

◆ GetEnhancedMonitoring()

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

Represents the current enhanced monitoring settings of the stream.

Definition at line 280 of file StreamDescriptionSummary.h.

◆ GetKeyId()

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

◆ GetOpenShardCount()

int Aws::Kinesis::Model::StreamDescriptionSummary::GetOpenShardCount ( ) const
inline

The number of open shards in the stream.

Definition at line 487 of file StreamDescriptionSummary.h.

◆ GetRetentionPeriodHours()

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

The current retention period, in hours.

Definition at line 228 of file StreamDescriptionSummary.h.

◆ GetStreamARN()

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

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

Definition at line 90 of file StreamDescriptionSummary.h.

◆ GetStreamCreationTimestamp()

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

The approximate time that the stream was created.

Definition at line 249 of file StreamDescriptionSummary.h.

◆ GetStreamName()

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

The name of the stream being described.

Definition at line 49 of file StreamDescriptionSummary.h.

◆ GetStreamStatus()

const StreamStatus& Aws::Kinesis::Model::StreamDescriptionSummary::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 142 of file StreamDescriptionSummary.h.

◆ Jsonize()

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

◆ KeyIdHasBeenSet()

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

◆ OpenShardCountHasBeenSet()

bool Aws::Kinesis::Model::StreamDescriptionSummary::OpenShardCountHasBeenSet ( ) const
inline

The number of open shards in the stream.

Definition at line 492 of file StreamDescriptionSummary.h.

◆ operator=()

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

◆ RetentionPeriodHoursHasBeenSet()

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

The current retention period, in hours.

Definition at line 233 of file StreamDescriptionSummary.h.

◆ SetConsumerCount()

void Aws::Kinesis::Model::StreamDescriptionSummary::SetConsumerCount ( int  value)
inline

The number of enhanced fan-out consumers registered with the stream.

Definition at line 518 of file StreamDescriptionSummary.h.

◆ SetEncryptionType() [1/2]

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

The encryption type used. This value is one of the following:

Definition at line 334 of file StreamDescriptionSummary.h.

◆ SetEncryptionType() [2/2]

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

The encryption type used. This value is one of the following:

Definition at line 340 of file StreamDescriptionSummary.h.

◆ SetEnhancedMonitoring() [1/2]

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

Represents the current enhanced monitoring settings of the stream.

Definition at line 295 of file StreamDescriptionSummary.h.

◆ SetEnhancedMonitoring() [2/2]

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

Represents the current enhanced monitoring settings of the stream.

Definition at line 290 of file StreamDescriptionSummary.h.

◆ SetKeyId() [1/3]

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

◆ SetKeyId() [2/3]

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

◆ SetKeyId() [3/3]

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

◆ SetOpenShardCount()

void Aws::Kinesis::Model::StreamDescriptionSummary::SetOpenShardCount ( int  value)
inline

The number of open shards in the stream.

Definition at line 497 of file StreamDescriptionSummary.h.

◆ SetRetentionPeriodHours()

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

The current retention period, in hours.

Definition at line 238 of file StreamDescriptionSummary.h.

◆ SetStreamARN() [1/3]

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

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

Definition at line 105 of file StreamDescriptionSummary.h.

◆ SetStreamARN() [2/3]

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

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

Definition at line 100 of file StreamDescriptionSummary.h.

◆ SetStreamARN() [3/3]

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

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

Definition at line 110 of file StreamDescriptionSummary.h.

◆ SetStreamCreationTimestamp() [1/2]

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

The approximate time that the stream was created.

Definition at line 264 of file StreamDescriptionSummary.h.

◆ SetStreamCreationTimestamp() [2/2]

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

The approximate time that the stream was created.

Definition at line 259 of file StreamDescriptionSummary.h.

◆ SetStreamName() [1/3]

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

The name of the stream being described.

Definition at line 64 of file StreamDescriptionSummary.h.

◆ SetStreamName() [2/3]

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

The name of the stream being described.

Definition at line 59 of file StreamDescriptionSummary.h.

◆ SetStreamName() [3/3]

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

The name of the stream being described.

Definition at line 69 of file StreamDescriptionSummary.h.

◆ SetStreamStatus() [1/2]

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

◆ SetStreamStatus() [2/2]

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

◆ StreamARNHasBeenSet()

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

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

Definition at line 95 of file StreamDescriptionSummary.h.

◆ StreamCreationTimestampHasBeenSet()

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

The approximate time that the stream was created.

Definition at line 254 of file StreamDescriptionSummary.h.

◆ StreamNameHasBeenSet()

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

The name of the stream being described.

Definition at line 54 of file StreamDescriptionSummary.h.

◆ StreamStatusHasBeenSet()

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

◆ WithConsumerCount()

StreamDescriptionSummary& Aws::Kinesis::Model::StreamDescriptionSummary::WithConsumerCount ( int  value)
inline

The number of enhanced fan-out consumers registered with the stream.

Definition at line 523 of file StreamDescriptionSummary.h.

◆ WithEncryptionType() [1/2]

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

The encryption type used. This value is one of the following:

Definition at line 346 of file StreamDescriptionSummary.h.

◆ WithEncryptionType() [2/2]

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

The encryption type used. This value is one of the following:

Definition at line 352 of file StreamDescriptionSummary.h.

◆ WithEnhancedMonitoring() [1/2]

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

Represents the current enhanced monitoring settings of the stream.

Definition at line 305 of file StreamDescriptionSummary.h.

◆ WithEnhancedMonitoring() [2/2]

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

Represents the current enhanced monitoring settings of the stream.

Definition at line 300 of file StreamDescriptionSummary.h.

◆ WithKeyId() [1/3]

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

◆ WithKeyId() [2/3]

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

◆ WithKeyId() [3/3]

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

◆ WithOpenShardCount()

StreamDescriptionSummary& Aws::Kinesis::Model::StreamDescriptionSummary::WithOpenShardCount ( int  value)
inline

The number of open shards in the stream.

Definition at line 502 of file StreamDescriptionSummary.h.

◆ WithRetentionPeriodHours()

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

The current retention period, in hours.

Definition at line 243 of file StreamDescriptionSummary.h.

◆ WithStreamARN() [1/3]

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

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

Definition at line 120 of file StreamDescriptionSummary.h.

◆ WithStreamARN() [2/3]

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

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

Definition at line 115 of file StreamDescriptionSummary.h.

◆ WithStreamARN() [3/3]

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

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

Definition at line 125 of file StreamDescriptionSummary.h.

◆ WithStreamCreationTimestamp() [1/2]

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

The approximate time that the stream was created.

Definition at line 274 of file StreamDescriptionSummary.h.

◆ WithStreamCreationTimestamp() [2/2]

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

The approximate time that the stream was created.

Definition at line 269 of file StreamDescriptionSummary.h.

◆ WithStreamName() [1/3]

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

The name of the stream being described.

Definition at line 79 of file StreamDescriptionSummary.h.

◆ WithStreamName() [2/3]

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

The name of the stream being described.

Definition at line 74 of file StreamDescriptionSummary.h.

◆ WithStreamName() [3/3]

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

The name of the stream being described.

Definition at line 84 of file StreamDescriptionSummary.h.

◆ WithStreamStatus() [1/2]

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

◆ WithStreamStatus() [2/2]

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


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