software.amazon.awssdk.services.databasemigration.model

Interface KinesisSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<KinesisSettings.Builder,KinesisSettings>, SdkBuilder<KinesisSettings.Builder,KinesisSettings>, SdkPojo

Enclosing class:

KinesisSettings

public static interface KinesisSettings.Builder
extends SdkPojo, CopyableBuilder<KinesisSettings.Builder,KinesisSettings>

Method Summary

Modifier and Type	Method and Description
KinesisSettings.Builder	includeControlDetails(Boolean includeControlDetails) Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
KinesisSettings.Builder	includeNullAndEmpty(Boolean includeNullAndEmpty) Include NULL and empty columns for records migrated to the endpoint.
KinesisSettings.Builder	includePartitionValue(Boolean includePartitionValue) Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type.
KinesisSettings.Builder	includeTableAlterOperations(Boolean 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.
KinesisSettings.Builder	includeTransactionDetails(Boolean includeTransactionDetails) Provides detailed transaction information from the source database.
KinesisSettings.Builder	messageFormat(MessageFormatValue messageFormat) The output format for the records created on the endpoint.
KinesisSettings.Builder	messageFormat(String messageFormat) The output format for the records created on the endpoint.
KinesisSettings.Builder	noHexPrefix(Boolean noHexPrefix) Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
KinesisSettings.Builder	partitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable) Prefixes schema and table names to partition values, when the partition type is primary-key-type .
KinesisSettings.Builder	serviceAccessRoleArn(String serviceAccessRoleArn) The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream.
KinesisSettings.Builder	streamArn(String streamArn) The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

streamArn

KinesisSettings.Builder streamArn(String streamArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

messageFormat

KinesisSettings.Builder messageFormat(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageFormatValue, MessageFormatValue

messageFormat

KinesisSettings.Builder messageFormat(MessageFormatValue 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageFormatValue, MessageFormatValue

serviceAccessRoleArn

KinesisSettings.Builder serviceAccessRoleArn(String serviceAccessRoleArn)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

includeTransactionDetails

KinesisSettings.Builder includeTransactionDetails(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

includePartitionValue

KinesisSettings.Builder includePartitionValue(Boolean includePartitionValue)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

partitionIncludeSchemaTable

KinesisSettings.Builder partitionIncludeSchemaTable(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

includeTableAlterOperations

KinesisSettings.Builder includeTableAlterOperations(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

includeControlDetails

KinesisSettings.Builder includeControlDetails(Boolean includeControlDetails)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

includeNullAndEmpty

KinesisSettings.Builder includeNullAndEmpty(Boolean includeNullAndEmpty)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

noHexPrefix

KinesisSettings.Builder noHexPrefix(Boolean noHexPrefix)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.