KinesisSettings - Amazon Database Migration Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

KinesisSettings

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.

Contents

IncludeControlDetails

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

Type: Boolean

Required: No

IncludeNullAndEmpty

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

Type: Boolean

Required: No

IncludePartitionValue

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

Type: Boolean

Required: No

IncludeTableAlterOperations

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.

Type: Boolean

Required: No

IncludeTransactionDetails

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.

Type: Boolean

Required: No

MessageFormat

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).

Type: String

Valid Values: json | json-unformatted

Required: No

NoHexPrefix

Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, Amazon DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

Type: Boolean

Required: No

PartitionIncludeSchemaTable

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.

Type: Boolean

Required: No

ServiceAccessRoleArn

The Amazon Resource Name (ARN) for the IAM role that Amazon DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.

Type: String

Required: No

StreamArn

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: