Class: Aws::DSQL::Types::GetStreamOutput

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

Overview

The output of a retrieved stream.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the retrieved stream.

Returns:

  • (String) 


622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifier ⇒ String

The ID of the cluster for the retrieved stream.

Returns:

  • (String) 


622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time when the stream was created.

Returns:

  • (Time) 


622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The format of the stream records.

Returns:

  • (String) 


622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ordering ⇒ String

The ordering mode of the stream.

Returns:

  • (String) 


622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the retrieved stream.

Returns:

  • (String) 


622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ Types::StatusReason

Stream status reason with error code and timestamp (if applicable).

Returns:



622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stream_identifier ⇒ String

The ID of the retrieved stream.

Returns:

  • (String) 


622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of tags associated with the stream.

Returns:

  • (Hash<String,String>) 


622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_definition ⇒ Types::TargetDefinition

The target definition for the stream destination.

Returns:



622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 622

class GetStreamOutput < Struct.new(
  :cluster_identifier,
  :stream_identifier,
  :arn,
  :status,
  :creation_time,
  :ordering,
  :format,
  :target_definition,
  :status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end