Class: Aws::QLDB::Types::JournalKinesisStreamDescription

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

Overview

Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the QLDB journal stream.

Returns:

  • (String) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

Returns:

  • (Time) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#error_cause ⇒ String

The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

Returns:

  • (String) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#exclusive_end_time ⇒ Time

The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

Returns:

  • (Time) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#inclusive_start_time ⇒ Time

The inclusive start date and time from which to start streaming journal data.

Returns:

  • (Time) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_configuration ⇒ Types::KinesisConfiguration

The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

Returns:



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#ledger_name ⇒ String

The name of the ledger.

Returns:

  • (String) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

Returns:

  • (String) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current state of the QLDB journal stream.

Returns:

  • (String) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#stream_id ⇒ String

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

Returns:

  • (String) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ String

The user-defined name of the QLDB journal stream.

Returns:

  • (String) 


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 675

class JournalKinesisStreamDescription < Struct.new(
  :ledger_name,
  :creation_time,
  :inclusive_start_time,
  :exclusive_end_time,
  :role_arn,
  :stream_id,
  :arn,
  :status,
  :kinesis_configuration,
  :error_cause,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end