Class: Aws::KeyspacesStreams::Types::GetStreamOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_request_date_time ⇒ Time

The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.

Returns:

  • (Time) 


243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#keyspace_name ⇒ String

The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.

Returns:

  • (String) 


243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.

Returns:

  • (String) 


243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#shards ⇒ Array<Types::Shard>

An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data.

Returns:



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.

Returns:

  • (String) 


243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stream_label ⇒ String

A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.

Returns:

  • (String) 


243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stream_status ⇒ String

The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.

Returns:

  • (String) 


243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stream_view_type ⇒ String

The format of the data records in this stream. Currently, this can be one of the following options:

  • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

  • NEW_IMAGE - the version of the row after the change.

  • OLD_IMAGE - the version of the row before the change.

  • KEYS_ONLY - the partition and clustering keys of the row that was changed.

Returns:

  • (String) 


243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.

Returns:

  • (String) 


243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-keyspacesstreams/lib/aws-sdk-keyspacesstreams/types.rb', line 243

class GetStreamOutput < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :keyspace_name,
  :table_name,
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end