NAME

Paws::QLDB::StreamJournalToKinesis - Arguments for method StreamJournalToKinesis on Paws::QLDB

DESCRIPTION

This class represents the parameters used for calling the method StreamJournalToKinesis on the Amazon QLDB service. Use the attributes of this class as arguments to method StreamJournalToKinesis.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StreamJournalToKinesis.

SYNOPSIS

my $qldb = Paws->service('QLDB');
my $StreamJournalToKinesisResponse = $qldb->StreamJournalToKinesis(
  InclusiveStartTime   => '1970-01-01T01:00:00',
  KinesisConfiguration => {
    StreamArn          => 'MyArn',    # min: 20, max: 1600
    AggregationEnabled => 1,          # OPTIONAL
  },
  LedgerName       => 'MyLedgerName',
  RoleArn          => 'MyArn',
  StreamName       => 'MyStreamName',
  ExclusiveEndTime => '1970-01-01T01:00:00',    # OPTIONAL
  Tags             => {
    'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
  },    # OPTIONAL
);

# Results:
my $StreamId = $StreamJournalToKinesisResponse->StreamId;

# Returns a L<Paws::QLDB::StreamJournalToKinesisResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/qldb/StreamJournalToKinesis

ATTRIBUTES

ExclusiveEndTime => Str

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.

REQUIRED InclusiveStartTime => Str

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.

REQUIRED KinesisConfiguration => Paws::QLDB::KinesisConfiguration

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

REQUIRED LedgerName => Str

The name of the ledger.

REQUIRED RoleArn => Str

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.

REQUIRED StreamName => Str

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 (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the Amazon QLDB Developer Guide.

Tags => Paws::QLDB::Tags

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method StreamJournalToKinesis in Paws::QLDB

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues