| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::QLDB::KinesisConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AggregationEnabled => (is => 'ro', isa => 'Bool'); | ||
| 5 | has StreamArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::QLDB::KinesisConfiguration | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::QLDB::KinesisConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { AggregationEnabled => $value, ..., StreamArn => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::QLDB::KinesisConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->AggregationEnabled | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The configuration settings of the Amazon Kinesis Data Streams | ||
| 38 | destination for an Amazon QLDB journal stream. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 AggregationEnabled => Bool | ||
| 44 | |||
| 45 | Enables QLDB to publish multiple data records in a single Kinesis Data | ||
| 46 | Streams record, increasing the number of records sent per API call. | ||
| 47 | |||
| 48 | I<This option is enabled by default.> Record aggregation has important | ||
| 49 | implications for processing records and requires de-aggregation in your | ||
| 50 | stream consumer. To learn more, see KPL Key Concepts | ||
| 51 | (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) | ||
| 52 | and Consumer De-aggregation | ||
| 53 | (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) | ||
| 54 | in the I<Amazon Kinesis Data Streams Developer Guide>. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> StreamArn => Str | ||
| 58 | |||
| 59 | The Amazon Resource Name (ARN) of the Kinesis Data Streams resource. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, describing an object used in L<Paws::QLDB> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |