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

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

Overview

Note:

When making an API call, you may pass StreamJournalToKinesisRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclusive_end_timeTime

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)


1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1351

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_timeTime

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)


1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1351

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

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



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1351

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_nameString

The name of the ledger.

Returns:

  • (String)


1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1351

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


1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1351

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_nameString

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)


1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1351

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

#tagsHash<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>)


1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1351

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