Class CfnEndpointPropsMixin.KinesisSettingsProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.dms.CfnEndpointPropsMixin.KinesisSettingsProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEndpointPropsMixin.KinesisSettingsProperty>
- Enclosing interface:
CfnEndpointPropsMixin.KinesisSettingsProperty
@Stability(Stable)
public static final class CfnEndpointPropsMixin.KinesisSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpointPropsMixin.KinesisSettingsProperty>
A builder for
CfnEndpointPropsMixin.KinesisSettingsProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.includeControlDetails(Boolean includeControlDetails) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeControlDetails()includeControlDetails(IResolvable includeControlDetails) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeControlDetails()includeNullAndEmpty(Boolean includeNullAndEmpty) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeNullAndEmpty()includeNullAndEmpty(IResolvable includeNullAndEmpty) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeNullAndEmpty()includePartitionValue(Boolean includePartitionValue) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludePartitionValue()includePartitionValue(IResolvable includePartitionValue) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludePartitionValue()includeTableAlterOperations(Boolean includeTableAlterOperations) includeTableAlterOperations(IResolvable includeTableAlterOperations) includeTransactionDetails(Boolean includeTransactionDetails) includeTransactionDetails(IResolvable includeTransactionDetails) messageFormat(String messageFormat) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getMessageFormat()noHexPrefix(Boolean noHexPrefix) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getNoHexPrefix()noHexPrefix(IResolvable noHexPrefix) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getNoHexPrefix()partitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable) partitionIncludeSchemaTable(IResolvable partitionIncludeSchemaTable) serviceAccessRoleArn(String serviceAccessRoleArn) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getServiceAccessRoleArn()Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getStreamArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
includeControlDetails
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeControlDetails(Boolean includeControlDetails) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeControlDetails()- 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:
this
-
includeControlDetails
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeControlDetails(IResolvable includeControlDetails) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeControlDetails()- 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:
this
-
includeNullAndEmpty
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeNullAndEmpty(Boolean includeNullAndEmpty) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeNullAndEmpty()- Parameters:
includeNullAndEmpty- Include NULL and empty columns for records migrated to the endpoint. The default isfalse.- Returns:
this
-
includeNullAndEmpty
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeNullAndEmpty(IResolvable includeNullAndEmpty) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeNullAndEmpty()- Parameters:
includeNullAndEmpty- Include NULL and empty columns for records migrated to the endpoint. The default isfalse.- Returns:
this
-
includePartitionValue
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includePartitionValue(Boolean includePartitionValue) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludePartitionValue()- Parameters:
includePartitionValue- Shows the partition value within the Kinesis message output, unless the partition type isschema-table-type. The default isfalse.- Returns:
this
-
includePartitionValue
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includePartitionValue(IResolvable includePartitionValue) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getIncludePartitionValue()- Parameters:
includePartitionValue- Shows the partition value within the Kinesis message output, unless the partition type isschema-table-type. The default isfalse.- Returns:
this
-
includeTableAlterOperations
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeTableAlterOperations(Boolean includeTableAlterOperations) - 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:
this
-
includeTableAlterOperations
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeTableAlterOperations(IResolvable includeTableAlterOperations) - 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:
this
-
includeTransactionDetails
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeTransactionDetails(Boolean includeTransactionDetails) - 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:
this
-
includeTransactionDetails
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeTransactionDetails(IResolvable includeTransactionDetails) - 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:
this
-
messageFormat
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder messageFormat(String messageFormat) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getMessageFormat()- 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:
this
-
noHexPrefix
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder noHexPrefix(Boolean noHexPrefix) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getNoHexPrefix()- Parameters:
noHexPrefix- Set this optional parameter totrueto avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use theNoHexPrefixendpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.- Returns:
this
-
noHexPrefix
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder noHexPrefix(IResolvable noHexPrefix) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getNoHexPrefix()- Parameters:
noHexPrefix- Set this optional parameter totrueto avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use theNoHexPrefixendpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.- Returns:
this
-
partitionIncludeSchemaTable
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder partitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable) - 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:
this
-
partitionIncludeSchemaTable
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder partitionIncludeSchemaTable(IResolvable partitionIncludeSchemaTable) - 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:
this
-
serviceAccessRoleArn
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder serviceAccessRoleArn(String serviceAccessRoleArn) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getServiceAccessRoleArn()- Parameters:
serviceAccessRoleArn- The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. The role must allow theiam:PassRoleaction.- Returns:
this
-
streamArn
@Stability(Stable) public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder streamArn(String streamArn) Sets the value ofCfnEndpointPropsMixin.KinesisSettingsProperty.getStreamArn()- Parameters:
streamArn- The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnEndpointPropsMixin.KinesisSettingsProperty>- Returns:
- a new instance of
CfnEndpointPropsMixin.KinesisSettingsProperty - Throws:
NullPointerException- if any required attribute was not provided
-