You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StreamJournalToKinesisRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  ledger_name: "LedgerName", # required
  role_arn: "Arn", # required
  tags: {
    "TagKey" => "TagValue",
  },
  inclusive_start_time: Time.now, # required
  exclusive_end_time: Time.now,
  kinesis_configuration: { # required
    stream_arn: "Arn", # required
    aggregation_enabled: false,
  },
  stream_name: "StreamName", # required
}

See Also:

Instance Attribute Summary collapse

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) —

    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. 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) —

    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.

Returns:

#ledger_name ⇒ String

The name of the ledger.

Returns:

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

Returns:

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

Returns:

  • (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. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Returns:

  • (Hash<String,String>) —

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