Package software.amazon.awscdk.cfnpropertymixins.services.dms

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpointPropsMixin.KinesisSettingsProperty	build()	Builds the configured instance.
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includeControlDetails(Boolean includeControlDetails)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeControlDetails()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includeControlDetails(IResolvable includeControlDetails)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeControlDetails()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includeNullAndEmpty(Boolean includeNullAndEmpty)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeNullAndEmpty()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includeNullAndEmpty(IResolvable includeNullAndEmpty)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeNullAndEmpty()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includePartitionValue(Boolean includePartitionValue)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludePartitionValue()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includePartitionValue(IResolvable includePartitionValue)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludePartitionValue()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includeTableAlterOperations(Boolean includeTableAlterOperations)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeTableAlterOperations()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includeTableAlterOperations(IResolvable includeTableAlterOperations)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeTableAlterOperations()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includeTransactionDetails(Boolean includeTransactionDetails)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeTransactionDetails()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	includeTransactionDetails(IResolvable includeTransactionDetails)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeTransactionDetails()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	messageFormat(String messageFormat)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getMessageFormat()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	noHexPrefix(Boolean noHexPrefix)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getNoHexPrefix()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	noHexPrefix(IResolvable noHexPrefix)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getNoHexPrefix()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	partitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getPartitionIncludeSchemaTable()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	partitionIncludeSchemaTable(IResolvable partitionIncludeSchemaTable)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getPartitionIncludeSchemaTable()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	serviceAccessRoleArn(String serviceAccessRoleArn)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getServiceAccessRoleArn()
CfnEndpointPropsMixin.KinesisSettingsProperty.Builder	streamArn(String streamArn)	Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getStreamArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

includeControlDetails

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeControlDetails(Boolean includeControlDetails)

Sets the value of CfnEndpointPropsMixin.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 is false .

Returns:

this

includeControlDetails

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeControlDetails(IResolvable includeControlDetails)

Sets the value of CfnEndpointPropsMixin.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 is false .

Returns:

this

includeNullAndEmpty

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeNullAndEmpty(Boolean includeNullAndEmpty)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeNullAndEmpty()

Parameters:

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

Returns:

this

includeNullAndEmpty

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeNullAndEmpty(IResolvable includeNullAndEmpty)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeNullAndEmpty()

Parameters:

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

Returns:

this

includePartitionValue

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includePartitionValue(Boolean includePartitionValue)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludePartitionValue()

Parameters:

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

Returns:

this

includePartitionValue

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includePartitionValue(IResolvable includePartitionValue)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludePartitionValue()

Parameters:

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

Returns:

this

includeTableAlterOperations

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeTableAlterOperations(Boolean includeTableAlterOperations)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeTableAlterOperations()

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:

this

includeTableAlterOperations

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeTableAlterOperations(IResolvable includeTableAlterOperations)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeTableAlterOperations()

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:

this

includeTransactionDetails

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeTransactionDetails(Boolean includeTransactionDetails)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeTransactionDetails()

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:

this

includeTransactionDetails

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder includeTransactionDetails(IResolvable includeTransactionDetails)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getIncludeTransactionDetails()

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:

this

messageFormat

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder messageFormat(String messageFormat)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getMessageFormat()

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:

this

noHexPrefix

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder noHexPrefix(Boolean noHexPrefix)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getNoHexPrefix()

Parameters:

noHexPrefix - Set this optional parameter to true to 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 the NoHexPrefix endpoint 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 of CfnEndpointPropsMixin.KinesisSettingsProperty.getNoHexPrefix()

Parameters:

noHexPrefix - Set this optional parameter to true to 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 the NoHexPrefix endpoint 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)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getPartitionIncludeSchemaTable()

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:

this

partitionIncludeSchemaTable

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder partitionIncludeSchemaTable(IResolvable partitionIncludeSchemaTable)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getPartitionIncludeSchemaTable()

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:

this

serviceAccessRoleArn

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder serviceAccessRoleArn(String serviceAccessRoleArn)

Sets the value of CfnEndpointPropsMixin.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 the iam:PassRole action.

Returns:

this

streamArn

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty.Builder streamArn(String streamArn)

Sets the value of CfnEndpointPropsMixin.KinesisSettingsProperty.getStreamArn()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnEndpointPropsMixin.KinesisSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpointPropsMixin.KinesisSettingsProperty>

Returns:

a new instance of CfnEndpointPropsMixin.KinesisSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided