« blib/lib/Paws/QLDB/S3ExportConfiguration.pm
↑ Summary
blib/lib/Paws/QLDB/StreamJournalToKinesisResponse.pm »
| 1 | |||
| 2 | package Paws::QLDB::StreamJournalToKinesis; | ||
| 3 | use Moose; | ||
| 4 | has ExclusiveEndTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has InclusiveStartTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has KinesisConfiguration => (is => 'ro', isa => 'Paws::QLDB::KinesisConfiguration', required => 1); | ||
| 7 | has LedgerName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 8 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has StreamName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has Tags => (is => 'ro', isa => 'Paws::QLDB::Tags'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StreamJournalToKinesis'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ledgers/{name}/journal-kinesis-streams'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::QLDB::StreamJournalToKinesisResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::QLDB::StreamJournalToKinesis - Arguments for method StreamJournalToKinesis on L<Paws::QLDB> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method StreamJournalToKinesis on the | ||
| 29 | L<Amazon QLDB|Paws::QLDB> service. Use the attributes of this class | ||
| 30 | as arguments to method StreamJournalToKinesis. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StreamJournalToKinesis. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $qldb = Paws->service('QLDB'); | ||
| 37 | my $StreamJournalToKinesisResponse = $qldb->StreamJournalToKinesis( | ||
| 38 | InclusiveStartTime => '1970-01-01T01:00:00', | ||
| 39 | KinesisConfiguration => { | ||
| 40 | StreamArn => 'MyArn', # min: 20, max: 1600 | ||
| 41 | AggregationEnabled => 1, # OPTIONAL | ||
| 42 | }, | ||
| 43 | LedgerName => 'MyLedgerName', | ||
| 44 | RoleArn => 'MyArn', | ||
| 45 | StreamName => 'MyStreamName', | ||
| 46 | ExclusiveEndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 47 | Tags => { | ||
| 48 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 49 | }, # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $StreamId = $StreamJournalToKinesisResponse->StreamId; | ||
| 54 | |||
| 55 | # Returns a L<Paws::QLDB::StreamJournalToKinesisResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/qldb/StreamJournalToKinesis> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ExclusiveEndTime => Str | ||
| 64 | |||
| 65 | The exclusive date and time that specifies when the stream ends. If you | ||
| 66 | don't define this parameter, the stream runs indefinitely until you | ||
| 67 | cancel it. | ||
| 68 | |||
| 69 | The C<ExclusiveEndTime> must be in C<ISO 8601> date and time format and | ||
| 70 | in Universal Coordinated Time (UTC). For example: | ||
| 71 | C<2019-06-13T21:36:34Z>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> InclusiveStartTime => Str | ||
| 76 | |||
| 77 | The inclusive start date and time from which to start streaming journal | ||
| 78 | data. This parameter must be in C<ISO 8601> date and time format and in | ||
| 79 | Universal Coordinated Time (UTC). For example: C<2019-06-13T21:36:34Z>. | ||
| 80 | |||
| 81 | The C<InclusiveStartTime> cannot be in the future and must be before | ||
| 82 | C<ExclusiveEndTime>. | ||
| 83 | |||
| 84 | If you provide an C<InclusiveStartTime> that is before the ledger's | ||
| 85 | C<CreationDateTime>, QLDB effectively defaults it to the ledger's | ||
| 86 | C<CreationDateTime>. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> KinesisConfiguration => L<Paws::QLDB::KinesisConfiguration> | ||
| 91 | |||
| 92 | The configuration settings of the Kinesis Data Streams destination for | ||
| 93 | your stream request. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> LedgerName => Str | ||
| 98 | |||
| 99 | The name of the ledger. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> RoleArn => Str | ||
| 104 | |||
| 105 | The Amazon Resource Name (ARN) of the IAM role that grants QLDB | ||
| 106 | permissions for a journal stream to write data records to a Kinesis | ||
| 107 | Data Streams resource. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> StreamName => Str | ||
| 112 | |||
| 113 | The name that you want to assign to the QLDB journal stream. | ||
| 114 | User-defined names can help identify and indicate the purpose of a | ||
| 115 | stream. | ||
| 116 | |||
| 117 | Your stream name must be unique among other I<active> streams for a | ||
| 118 | given ledger. Stream names have the same naming constraints as ledger | ||
| 119 | names, as defined in Quotas in Amazon QLDB | ||
| 120 | (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) | ||
| 121 | in the I<Amazon QLDB Developer Guide>. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 Tags => L<Paws::QLDB::Tags> | ||
| 126 | |||
| 127 | The key-value pairs to add as tags to the stream that you want to | ||
| 128 | create. Tag keys are case sensitive. Tag values are case sensitive and | ||
| 129 | can be null. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, documenting arguments for method StreamJournalToKinesis in L<Paws::QLDB> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |