class Aws::DatabaseMigrationService::Types::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.

@note When making an API call, you may pass KinesisSettings

data as a hash:

    {
      stream_arn: "String",
      message_format: "json", # accepts json, json-unformatted
      service_access_role_arn: "String",
      include_transaction_details: false,
      include_partition_value: false,
      partition_include_schema_table: false,
      include_table_alter_operations: false,
      include_control_details: false,
      include_null_and_empty: false,
      no_hex_prefix: false,
    }

@!attribute [rw] stream_arn

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
endpoint.
@return [String]

@!attribute [rw] message_format

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).
@return [String]

@!attribute [rw] service_access_role_arn

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

@!attribute [rw] include_transaction_details

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`.
@return [Boolean]

@!attribute [rw] include_partition_value

Shows the partition value within the Kinesis message output, unless
the partition type is `schema-table-type`. The default is `false`.
@return [Boolean]

@!attribute [rw] partition_include_schema_table

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`.
@return [Boolean]

@!attribute [rw] include_table_alter_operations

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`.
@return [Boolean]

@!attribute [rw] include_control_details

Shows detailed control information for table definition, column
definition, and table and column changes in the Kinesis message
output. The default is `false`.
@return [Boolean]

@!attribute [rw] include_null_and_empty

Include NULL and empty columns for records migrated to the endpoint.
The default is `false`.
@return [Boolean]

@!attribute [rw] no_hex_prefix

Set this optional parameter to `true` to avoid adding a '0x'
prefix to raw data in hexadecimal format. For example, by default,
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.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KinesisSettings AWS API Documentation

Constants

SENSITIVE