Class: Aws::QLDB::Types::StreamJournalToKinesisRequest

Inherits:

Struct

• Object
• Struct
• Aws::QLDB::Types::StreamJournalToKinesisRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qldb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #exclusive_end_time ⇒ Time

  The exclusive date and time that specifies when the stream ends.

• #inclusive_start_time ⇒ Time

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

• #kinesis_configuration ⇒ Types::KinesisConfiguration

  The configuration settings of the Kinesis Data Streams destination for your stream request.

• #ledger_name ⇒ String

  The name of the ledger.

• #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.

• #stream_name ⇒ String

  The name that you want to assign to the QLDB journal stream.

• #tags ⇒ Hash<String,String>

  The key-value pairs to add as tags to the stream that you want to create.

Instance Attribute Details

#exclusive_end_time ⇒ Time

The exclusive date and time that specifies when the stream ends. If you don’t define this parameter, the stream runs indefinitely until you cancel it.

The ‘ExclusiveEndTime` must be in `ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z`.

Returns:

• (Time)

# File 'lib/aws-sdk-qldb/types.rb', line 1373

class StreamJournalToKinesisRequest < Struct.new(
  :ledger_name,
  :role_arn,
  :tags,
  :inclusive_start_time,
  :exclusive_end_time,
  :kinesis_configuration,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#inclusive_start_time ⇒ Time

The inclusive start date and time from which to start streaming journal data. This parameter must be in ‘ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z`.

The ‘InclusiveStartTime` cannot be in the future and must be before `ExclusiveEndTime`.

If you provide an ‘InclusiveStartTime` that is before the ledger’s ‘CreationDateTime`, QLDB effectively defaults it to the ledger’s ‘CreationDateTime`.

Returns:

• (Time)

# File 'lib/aws-sdk-qldb/types.rb', line 1373

class StreamJournalToKinesisRequest < Struct.new(
  :ledger_name,
  :role_arn,
  :tags,
  :inclusive_start_time,
  :exclusive_end_time,
  :kinesis_configuration,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_configuration ⇒ Types::KinesisConfiguration

The configuration settings of the Kinesis Data Streams destination for your stream request.

Returns:

• (Types::KinesisConfiguration)

# File 'lib/aws-sdk-qldb/types.rb', line 1373

class StreamJournalToKinesisRequest < Struct.new(
  :ledger_name,
  :role_arn,
  :tags,
  :inclusive_start_time,
  :exclusive_end_time,
  :kinesis_configuration,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#ledger_name ⇒ String

The name of the ledger.

Returns:

• (String)

# File 'lib/aws-sdk-qldb/types.rb', line 1373

class StreamJournalToKinesisRequest < Struct.new(
  :ledger_name,
  :role_arn,
  :tags,
  :inclusive_start_time,
  :exclusive_end_time,
  :kinesis_configuration,
  :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.

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the ‘iam:PassRole` action on the IAM role resource. This is required for all journal stream requests.

Returns:

• (String)

# File 'lib/aws-sdk-qldb/types.rb', line 1373

class StreamJournalToKinesisRequest < Struct.new(
  :ledger_name,
  :role_arn,
  :tags,
  :inclusive_start_time,
  :exclusive_end_time,
  :kinesis_configuration,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ String

The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in [Quotas in Amazon QLDB] in the *Amazon QLDB Developer Guide*.

[1]: docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming

Returns:

• (String)

# File 'lib/aws-sdk-qldb/types.rb', line 1373

class StreamJournalToKinesisRequest < Struct.new(
  :ledger_name,
  :role_arn,
  :tags,
  :inclusive_start_time,
  :exclusive_end_time,
  :kinesis_configuration,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-qldb/types.rb', line 1373

class StreamJournalToKinesisRequest < Struct.new(
  :ledger_name,
  :role_arn,
  :tags,
  :inclusive_start_time,
  :exclusive_end_time,
  :kinesis_configuration,
  :stream_name)
  SENSITIVE = []
  include Aws::Structure
end