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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_timeTime

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)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_causeString

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)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_timeTime

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)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_timeTime

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

Returns:

  • (Time)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_configurationTypes::KinesisConfiguration

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



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_nameString

The name of the ledger.

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_arnString

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)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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

#statusString

The current state of the QLDB journal stream.

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_idString

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

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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_nameString

The user-defined name of the QLDB journal stream.

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 762

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