Interface KinesisSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<KinesisSettings.Builder,
,KinesisSettings> SdkBuilder<KinesisSettings.Builder,
,KinesisSettings> SdkPojo
- Enclosing class:
KinesisSettings
-
Method Summary
Modifier and TypeMethodDescriptionincludeControlDetails
(Boolean includeControlDetails) Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.includeNullAndEmpty
(Boolean includeNullAndEmpty) Include NULL and empty columns for records migrated to the endpoint.includePartitionValue
(Boolean includePartitionValue) Shows the partition value within the Kinesis message output, unless the partition type isschema-table-type
.includeTableAlterOperations
(Boolean includeTableAlterOperations) Includes any data definition language (DDL) operations that change the table in the control data, such asrename-table
,drop-table
,add-column
,drop-column
, andrename-column
.includeTransactionDetails
(Boolean includeTransactionDetails) Provides detailed transaction information from the source database.messageFormat
(String messageFormat) The output format for the records created on the endpoint.messageFormat
(MessageFormatValue messageFormat) The output format for the records created on the endpoint.noHexPrefix
(Boolean noHexPrefix) Set this optional parameter totrue
to avoid adding a '0x' prefix to raw data in hexadecimal format.partitionIncludeSchemaTable
(Boolean partitionIncludeSchemaTable) Prefixes schema and table names to partition values, when the partition type isprimary-key-type
.serviceAccessRoleArn
(String serviceAccessRoleArn) The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream.The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The output format for the records created on the endpoint. The message format is
JSON
(default) orJSON_UNFORMATTED
(a single line with no tab).- Parameters:
messageFormat
- The output format for the records created on the endpoint. The message format isJSON
(default) orJSON_UNFORMATTED
(a single line with no tab).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
messageFormat
The output format for the records created on the endpoint. The message format is
JSON
(default) orJSON_UNFORMATTED
(a single line with no tab).- Parameters:
messageFormat
- The output format for the records created on the endpoint. The message format isJSON
(default) orJSON_UNFORMATTED
(a single line with no tab).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theiam:PassRole
action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeTransactionDetails
Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for
transaction_id
, previoustransaction_id
, andtransaction_record_id
(the record offset within a transaction). The default isfalse
.- Parameters:
includeTransactionDetails
- Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values fortransaction_id
, previoustransaction_id
, andtransaction_record_id
(the record offset within a transaction). The default isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includePartitionValue
Shows the partition value within the Kinesis message output, unless the partition type is
schema-table-type
. The default isfalse
.- Parameters:
includePartitionValue
- Shows the partition value within the Kinesis message output, unless the partition type isschema-table-type
. The default isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isfalse
.- Parameters:
partitionIncludeSchemaTable
- Prefixes schema and table names to partition values, when the partition type isprimary-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 isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, andrename-column
. The default isfalse
.- Parameters:
includeTableAlterOperations
- Includes any data definition language (DDL) operations that change the table in the control data, such asrename-table
,drop-table
,add-column
,drop-column
, andrename-column
. The default isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theNoHexPrefix
endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.- Parameters:
noHexPrefix
- Set this optional parameter totrue
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 theNoHexPrefix
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.
-