AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::DynamoDBStreams::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::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 Aws::StringGetStreamLabel () const
 
bool StreamLabelHasBeenSet () const
 
void SetStreamLabel (const Aws::String &value)
 
void SetStreamLabel (Aws::String &&value)
 
void SetStreamLabel (const char *value)
 
StreamDescriptionWithStreamLabel (const Aws::String &value)
 
StreamDescriptionWithStreamLabel (Aws::String &&value)
 
StreamDescriptionWithStreamLabel (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 StreamViewTypeGetStreamViewType () const
 
bool StreamViewTypeHasBeenSet () const
 
void SetStreamViewType (const StreamViewType &value)
 
void SetStreamViewType (StreamViewType &&value)
 
StreamDescriptionWithStreamViewType (const StreamViewType &value)
 
StreamDescriptionWithStreamViewType (StreamViewType &&value)
 
const Aws::Utils::DateTimeGetCreationRequestDateTime () const
 
bool CreationRequestDateTimeHasBeenSet () const
 
void SetCreationRequestDateTime (const Aws::Utils::DateTime &value)
 
void SetCreationRequestDateTime (Aws::Utils::DateTime &&value)
 
StreamDescriptionWithCreationRequestDateTime (const Aws::Utils::DateTime &value)
 
StreamDescriptionWithCreationRequestDateTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetTableName () const
 
bool TableNameHasBeenSet () const
 
void SetTableName (const Aws::String &value)
 
void SetTableName (Aws::String &&value)
 
void SetTableName (const char *value)
 
StreamDescriptionWithTableName (const Aws::String &value)
 
StreamDescriptionWithTableName (Aws::String &&value)
 
StreamDescriptionWithTableName (const char *value)
 
const Aws::Vector< KeySchemaElement > & GetKeySchema () const
 
bool KeySchemaHasBeenSet () const
 
void SetKeySchema (const Aws::Vector< KeySchemaElement > &value)
 
void SetKeySchema (Aws::Vector< KeySchemaElement > &&value)
 
StreamDescriptionWithKeySchema (const Aws::Vector< KeySchemaElement > &value)
 
StreamDescriptionWithKeySchema (Aws::Vector< KeySchemaElement > &&value)
 
StreamDescriptionAddKeySchema (const KeySchemaElement &value)
 
StreamDescriptionAddKeySchema (KeySchemaElement &&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)
 
const Aws::StringGetLastEvaluatedShardId () const
 
bool LastEvaluatedShardIdHasBeenSet () const
 
void SetLastEvaluatedShardId (const Aws::String &value)
 
void SetLastEvaluatedShardId (Aws::String &&value)
 
void SetLastEvaluatedShardId (const char *value)
 
StreamDescriptionWithLastEvaluatedShardId (const Aws::String &value)
 
StreamDescriptionWithLastEvaluatedShardId (Aws::String &&value)
 
StreamDescriptionWithLastEvaluatedShardId (const char *value)
 

Detailed Description

Represents all of the data describing a particular stream.

See Also:

AWS API Reference

Definition at line 38 of file StreamDescription.h.

Constructor & Destructor Documentation

◆ StreamDescription() [1/2]

Aws::DynamoDBStreams::Model::StreamDescription::StreamDescription ( )

◆ StreamDescription() [2/2]

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

Member Function Documentation

◆ AddKeySchema() [1/2]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::AddKeySchema ( const KeySchemaElement value)
inline

The key attribute(s) of the stream's DynamoDB table.

Definition at line 410 of file StreamDescription.h.

◆ AddKeySchema() [2/2]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::AddKeySchema ( KeySchemaElement &&  value)
inline

The key attribute(s) of the stream's DynamoDB table.

Definition at line 415 of file StreamDescription.h.

◆ AddShards() [1/2]

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

The shards that comprise the stream.

Definition at line 451 of file StreamDescription.h.

◆ AddShards() [2/2]

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

The shards that comprise the stream.

Definition at line 456 of file StreamDescription.h.

◆ CreationRequestDateTimeHasBeenSet()

bool Aws::DynamoDBStreams::Model::StreamDescription::CreationRequestDateTimeHasBeenSet ( ) const
inline

The date and time when the request to create this stream was issued.

Definition at line 313 of file StreamDescription.h.

◆ GetCreationRequestDateTime()

const Aws::Utils::DateTime& Aws::DynamoDBStreams::Model::StreamDescription::GetCreationRequestDateTime ( ) const
inline

The date and time when the request to create this stream was issued.

Definition at line 308 of file StreamDescription.h.

◆ GetKeySchema()

const Aws::Vector<KeySchemaElement>& Aws::DynamoDBStreams::Model::StreamDescription::GetKeySchema ( ) const
inline

The key attribute(s) of the stream's DynamoDB table.

Definition at line 380 of file StreamDescription.h.

◆ GetLastEvaluatedShardId()

const Aws::String& Aws::DynamoDBStreams::Model::StreamDescription::GetLastEvaluatedShardId ( ) const
inline

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Definition at line 469 of file StreamDescription.h.

◆ GetShards()

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

The shards that comprise the stream.

Definition at line 421 of file StreamDescription.h.

◆ GetStreamArn()

const Aws::String& Aws::DynamoDBStreams::Model::StreamDescription::GetStreamArn ( ) const
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 50 of file StreamDescription.h.

◆ GetStreamLabel()

const Aws::String& Aws::DynamoDBStreams::Model::StreamDescription::GetStreamLabel ( ) const
inline

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

Definition at line 97 of file StreamDescription.h.

◆ GetStreamStatus()

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

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

Definition at line 185 of file StreamDescription.h.

◆ GetStreamViewType()

const StreamViewType& Aws::DynamoDBStreams::Model::StreamDescription::GetStreamViewType ( ) const
inline

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

Definition at line 247 of file StreamDescription.h.

◆ GetTableName()

const Aws::String& Aws::DynamoDBStreams::Model::StreamDescription::GetTableName ( ) const
inline

The DynamoDB table with which the stream is associated.

Definition at line 339 of file StreamDescription.h.

◆ Jsonize()

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

◆ KeySchemaHasBeenSet()

bool Aws::DynamoDBStreams::Model::StreamDescription::KeySchemaHasBeenSet ( ) const
inline

The key attribute(s) of the stream's DynamoDB table.

Definition at line 385 of file StreamDescription.h.

◆ LastEvaluatedShardIdHasBeenSet()

bool Aws::DynamoDBStreams::Model::StreamDescription::LastEvaluatedShardIdHasBeenSet ( ) const
inline

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Definition at line 481 of file StreamDescription.h.

◆ operator=()

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

◆ SetCreationRequestDateTime() [1/2]

void Aws::DynamoDBStreams::Model::StreamDescription::SetCreationRequestDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time when the request to create this stream was issued.

Definition at line 323 of file StreamDescription.h.

◆ SetCreationRequestDateTime() [2/2]

void Aws::DynamoDBStreams::Model::StreamDescription::SetCreationRequestDateTime ( const Aws::Utils::DateTime value)
inline

The date and time when the request to create this stream was issued.

Definition at line 318 of file StreamDescription.h.

◆ SetKeySchema() [1/2]

void Aws::DynamoDBStreams::Model::StreamDescription::SetKeySchema ( Aws::Vector< KeySchemaElement > &&  value)
inline

The key attribute(s) of the stream's DynamoDB table.

Definition at line 395 of file StreamDescription.h.

◆ SetKeySchema() [2/2]

void Aws::DynamoDBStreams::Model::StreamDescription::SetKeySchema ( const Aws::Vector< KeySchemaElement > &  value)
inline

The key attribute(s) of the stream's DynamoDB table.

Definition at line 390 of file StreamDescription.h.

◆ SetLastEvaluatedShardId() [1/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetLastEvaluatedShardId ( Aws::String &&  value)
inline

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Definition at line 505 of file StreamDescription.h.

◆ SetLastEvaluatedShardId() [2/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetLastEvaluatedShardId ( const Aws::String value)
inline

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Definition at line 493 of file StreamDescription.h.

◆ SetLastEvaluatedShardId() [3/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetLastEvaluatedShardId ( const char *  value)
inline

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Definition at line 517 of file StreamDescription.h.

◆ SetShards() [1/2]

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

The shards that comprise the stream.

Definition at line 436 of file StreamDescription.h.

◆ SetShards() [2/2]

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

The shards that comprise the stream.

Definition at line 431 of file StreamDescription.h.

◆ SetStreamArn() [1/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetStreamArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 65 of file StreamDescription.h.

◆ SetStreamArn() [2/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetStreamArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 60 of file StreamDescription.h.

◆ SetStreamArn() [3/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetStreamArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 70 of file StreamDescription.h.

◆ SetStreamLabel() [1/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetStreamLabel ( Aws::String &&  value)
inline

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

Definition at line 130 of file StreamDescription.h.

◆ SetStreamLabel() [2/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetStreamLabel ( const Aws::String value)
inline

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

Definition at line 119 of file StreamDescription.h.

◆ SetStreamLabel() [3/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetStreamLabel ( const char *  value)
inline

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

Definition at line 141 of file StreamDescription.h.

◆ SetStreamStatus() [1/2]

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

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

Definition at line 205 of file StreamDescription.h.

◆ SetStreamStatus() [2/2]

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

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

Definition at line 215 of file StreamDescription.h.

◆ SetStreamViewType() [1/2]

void Aws::DynamoDBStreams::Model::StreamDescription::SetStreamViewType ( const StreamViewType value)
inline

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

Definition at line 269 of file StreamDescription.h.

◆ SetStreamViewType() [2/2]

void Aws::DynamoDBStreams::Model::StreamDescription::SetStreamViewType ( StreamViewType &&  value)
inline

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

Definition at line 280 of file StreamDescription.h.

◆ SetTableName() [1/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetTableName ( Aws::String &&  value)
inline

The DynamoDB table with which the stream is associated.

Definition at line 354 of file StreamDescription.h.

◆ SetTableName() [2/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetTableName ( const Aws::String value)
inline

The DynamoDB table with which the stream is associated.

Definition at line 349 of file StreamDescription.h.

◆ SetTableName() [3/3]

void Aws::DynamoDBStreams::Model::StreamDescription::SetTableName ( const char *  value)
inline

The DynamoDB table with which the stream is associated.

Definition at line 359 of file StreamDescription.h.

◆ ShardsHasBeenSet()

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

The shards that comprise the stream.

Definition at line 426 of file StreamDescription.h.

◆ StreamArnHasBeenSet()

bool Aws::DynamoDBStreams::Model::StreamDescription::StreamArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 55 of file StreamDescription.h.

◆ StreamLabelHasBeenSet()

bool Aws::DynamoDBStreams::Model::StreamDescription::StreamLabelHasBeenSet ( ) const
inline

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

Definition at line 108 of file StreamDescription.h.

◆ StreamStatusHasBeenSet()

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

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

Definition at line 195 of file StreamDescription.h.

◆ StreamViewTypeHasBeenSet()

bool Aws::DynamoDBStreams::Model::StreamDescription::StreamViewTypeHasBeenSet ( ) const
inline

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

Definition at line 258 of file StreamDescription.h.

◆ TableNameHasBeenSet()

bool Aws::DynamoDBStreams::Model::StreamDescription::TableNameHasBeenSet ( ) const
inline

The DynamoDB table with which the stream is associated.

Definition at line 344 of file StreamDescription.h.

◆ WithCreationRequestDateTime() [1/2]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithCreationRequestDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time when the request to create this stream was issued.

Definition at line 333 of file StreamDescription.h.

◆ WithCreationRequestDateTime() [2/2]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithCreationRequestDateTime ( const Aws::Utils::DateTime value)
inline

The date and time when the request to create this stream was issued.

Definition at line 328 of file StreamDescription.h.

◆ WithKeySchema() [1/2]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithKeySchema ( Aws::Vector< KeySchemaElement > &&  value)
inline

The key attribute(s) of the stream's DynamoDB table.

Definition at line 405 of file StreamDescription.h.

◆ WithKeySchema() [2/2]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithKeySchema ( const Aws::Vector< KeySchemaElement > &  value)
inline

The key attribute(s) of the stream's DynamoDB table.

Definition at line 400 of file StreamDescription.h.

◆ WithLastEvaluatedShardId() [1/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithLastEvaluatedShardId ( Aws::String &&  value)
inline

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Definition at line 541 of file StreamDescription.h.

◆ WithLastEvaluatedShardId() [2/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithLastEvaluatedShardId ( const Aws::String value)
inline

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Definition at line 529 of file StreamDescription.h.

◆ WithLastEvaluatedShardId() [3/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithLastEvaluatedShardId ( const char *  value)
inline

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Definition at line 553 of file StreamDescription.h.

◆ WithShards() [1/2]

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

The shards that comprise the stream.

Definition at line 446 of file StreamDescription.h.

◆ WithShards() [2/2]

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

The shards that comprise the stream.

Definition at line 441 of file StreamDescription.h.

◆ WithStreamArn() [1/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithStreamArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 80 of file StreamDescription.h.

◆ WithStreamArn() [2/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithStreamArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 75 of file StreamDescription.h.

◆ WithStreamArn() [3/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithStreamArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 85 of file StreamDescription.h.

◆ WithStreamLabel() [1/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithStreamLabel ( Aws::String &&  value)
inline

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

Definition at line 163 of file StreamDescription.h.

◆ WithStreamLabel() [2/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithStreamLabel ( const Aws::String value)
inline

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

Definition at line 152 of file StreamDescription.h.

◆ WithStreamLabel() [3/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithStreamLabel ( const char *  value)
inline

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

Definition at line 174 of file StreamDescription.h.

◆ WithStreamStatus() [1/2]

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

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

Definition at line 225 of file StreamDescription.h.

◆ WithStreamStatus() [2/2]

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

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

Definition at line 235 of file StreamDescription.h.

◆ WithStreamViewType() [1/2]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithStreamViewType ( const StreamViewType value)
inline

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

Definition at line 291 of file StreamDescription.h.

◆ WithStreamViewType() [2/2]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithStreamViewType ( StreamViewType &&  value)
inline

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

Definition at line 302 of file StreamDescription.h.

◆ WithTableName() [1/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithTableName ( Aws::String &&  value)
inline

The DynamoDB table with which the stream is associated.

Definition at line 369 of file StreamDescription.h.

◆ WithTableName() [2/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithTableName ( const Aws::String value)
inline

The DynamoDB table with which the stream is associated.

Definition at line 364 of file StreamDescription.h.

◆ WithTableName() [3/3]

StreamDescription& Aws::DynamoDBStreams::Model::StreamDescription::WithTableName ( const char *  value)
inline

The DynamoDB table with which the stream is associated.

Definition at line 374 of file StreamDescription.h.


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