NAME

Paws::DMS::KinesisSettings

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::DMS::KinesisSettings object:

  $service_obj->Method(Att1 => { IncludeControlDetails => $value, ..., StreamArn => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::KinesisSettings object:

  $result = $service_obj->Method(...);
  $result->Att1->IncludeControlDetails

DESCRIPTION

Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

ATTRIBUTES

IncludeControlDetails => Bool

Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is "false".

IncludeNullAndEmpty => Bool

Include NULL and empty columns for records migrated to the endpoint. The default is "false".

IncludePartitionValue => Bool

Shows the partition value within the Kinesis message output, unless the partition type is "schema-table-type". The default is "false".

IncludeTableAlterOperations => Bool

Includes any data definition language (DDL) operations that change the table in the control data, such as "rename-table", "drop-table", "add-column", "drop-column", and "rename-column". The default is "false".

IncludeTransactionDetails => Bool

Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for "transaction_id", previous "transaction_id", and "transaction_record_id" (the record offset within a transaction). The default is "false".

MessageFormat => Str

The output format for the records created on the endpoint. The message format is "JSON" (default) or "JSON_UNFORMATTED" (a single line with no tab).

PartitionIncludeSchemaTable => Bool

Prefixes schema and table names to partition values, when the partition type is "primary-key-type". Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is "false".

ServiceAccessRoleArn => Str

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.

StreamArn => Str

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

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>