| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DMS::KinesisSettings; | ||
| 3 | use Moose; | ||
| 4 | has IncludeControlDetails => (is => 'ro', isa => 'Bool'); | ||
| 5 | has IncludeNullAndEmpty => (is => 'ro', isa => 'Bool'); | ||
| 6 | has IncludePartitionValue => (is => 'ro', isa => 'Bool'); | ||
| 7 | has IncludeTableAlterOperations => (is => 'ro', isa => 'Bool'); | ||
| 8 | has IncludeTransactionDetails => (is => 'ro', isa => 'Bool'); | ||
| 9 | has MessageFormat => (is => 'ro', isa => 'Str'); | ||
| 10 | has PartitionIncludeSchemaTable => (is => 'ro', isa => 'Bool'); | ||
| 11 | has ServiceAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 12 | has StreamArn => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::DMS::KinesisSettings | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::DMS::KinesisSettings object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { IncludeControlDetails => $value, ..., StreamArn => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::KinesisSettings object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->IncludeControlDetails | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Provides information that describes an Amazon Kinesis Data Stream | ||
| 45 | endpoint. This information includes the output format of records | ||
| 46 | applied to the endpoint and details of transaction and control table | ||
| 47 | data information. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 IncludeControlDetails => Bool | ||
| 53 | |||
| 54 | Shows detailed control information for table definition, column | ||
| 55 | definition, and table and column changes in the Kinesis message output. | ||
| 56 | The default is C<false>. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 IncludeNullAndEmpty => Bool | ||
| 60 | |||
| 61 | Include NULL and empty columns for records migrated to the endpoint. | ||
| 62 | The default is C<false>. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 IncludePartitionValue => Bool | ||
| 66 | |||
| 67 | Shows the partition value within the Kinesis message output, unless the | ||
| 68 | partition type is C<schema-table-type>. The default is C<false>. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 IncludeTableAlterOperations => Bool | ||
| 72 | |||
| 73 | Includes any data definition language (DDL) operations that change the | ||
| 74 | table in the control data, such as C<rename-table>, C<drop-table>, | ||
| 75 | C<add-column>, C<drop-column>, and C<rename-column>. The default is | ||
| 76 | C<false>. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 IncludeTransactionDetails => Bool | ||
| 80 | |||
| 81 | Provides detailed transaction information from the source database. | ||
| 82 | This information includes a commit timestamp, a log position, and | ||
| 83 | values for C<transaction_id>, previous C<transaction_id>, and | ||
| 84 | C<transaction_record_id> (the record offset within a transaction). The | ||
| 85 | default is C<false>. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 MessageFormat => Str | ||
| 89 | |||
| 90 | The output format for the records created on the endpoint. The message | ||
| 91 | format is C<JSON> (default) or C<JSON_UNFORMATTED> (a single line with | ||
| 92 | no tab). | ||
| 93 | |||
| 94 | |||
| 95 | =head2 PartitionIncludeSchemaTable => Bool | ||
| 96 | |||
| 97 | Prefixes schema and table names to partition values, when the partition | ||
| 98 | type is C<primary-key-type>. Doing this increases data distribution | ||
| 99 | among Kinesis shards. For example, suppose that a SysBench schema has | ||
| 100 | thousands of tables and each table has only limited range for a primary | ||
| 101 | key. In this case, the same primary key is sent from thousands of | ||
| 102 | tables to the same shard, which causes throttling. The default is | ||
| 103 | C<false>. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 ServiceAccessRoleArn => Str | ||
| 107 | |||
| 108 | The Amazon Resource Name (ARN) for the AWS Identity and Access | ||
| 109 | Management (IAM) role that AWS DMS uses to write to the Kinesis data | ||
| 110 | stream. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 StreamArn => Str | ||
| 114 | |||
| 115 | The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams | ||
| 116 | endpoint. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, describing an object used in L<Paws::DMS> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |