software.amazon.awscdk.services.dms

Interface CfnEndpoint.KinesisSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.KinesisSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(value=Stable)
public static interface CfnEndpoint.KinesisSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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. For more information about other available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 KinesisSettingsProperty kinesisSettingsProperty = KinesisSettingsProperty.builder()
         .includeControlDetails(false)
         .includeNullAndEmpty(false)
         .includePartitionValue(false)
         .includeTableAlterOperations(false)
         .includeTransactionDetails(false)
         .messageFormat("messageFormat")
         .noHexPrefix(false)
         .partitionIncludeSchemaTable(false)
         .serviceAccessRoleArn("serviceAccessRoleArn")
         .streamArn("streamArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEndpoint.KinesisSettingsProperty.Builder A builder for CfnEndpoint.KinesisSettingsProperty
static class	CfnEndpoint.KinesisSettingsProperty.Jsii$Proxy An implementation for CfnEndpoint.KinesisSettingsProperty

Method Summary

Modifier and Type	Method and Description
static CfnEndpoint.KinesisSettingsProperty.Builder	builder()
default Object	getIncludeControlDetails() Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
default Object	getIncludeNullAndEmpty() Include NULL and empty columns for records migrated to the endpoint.
default Object	getIncludePartitionValue() Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type` .
default Object	getIncludeTableAlterOperations() 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` .
default Object	getIncludeTransactionDetails() Provides detailed transaction information from the source database.
default String	getMessageFormat() The output format for the records created on the endpoint.
default Object	getNoHexPrefix() Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
default Object	getPartitionIncludeSchemaTable() Prefixes schema and table names to partition values, when the partition type is `primary-key-type` .
default String	getServiceAccessRoleArn() The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream.
default String	getStreamArn() The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIncludeControlDetails

@Stability(value=Stable)
 @Nullable
default Object getIncludeControlDetails()

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

The default is false .

getIncludeNullAndEmpty

@Stability(value=Stable)
 @Nullable
default Object getIncludeNullAndEmpty()

Include NULL and empty columns for records migrated to the endpoint.

The default is false .

getIncludePartitionValue

@Stability(value=Stable)
 @Nullable
default Object getIncludePartitionValue()

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

The default is false .

getIncludeTableAlterOperations

@Stability(value=Stable)
 @Nullable
default Object getIncludeTableAlterOperations()

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 .

getIncludeTransactionDetails

@Stability(value=Stable)
 @Nullable
default Object getIncludeTransactionDetails()

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 .

getMessageFormat

@Stability(value=Stable)
 @Nullable
default String getMessageFormat()

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

getNoHexPrefix

@Stability(value=Stable)
 @Nullable
default Object getNoHexPrefix()

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.

getPartitionIncludeSchemaTable

@Stability(value=Stable)
 @Nullable
default Object getPartitionIncludeSchemaTable()

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 .

getServiceAccessRoleArn

@Stability(value=Stable)
 @Nullable
default String getServiceAccessRoleArn()

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.

getStreamArn

@Stability(value=Stable)
 @Nullable
default String getStreamArn()

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

builder

@Stability(value=Stable)
static CfnEndpoint.KinesisSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.KinesisSettingsProperty.Builder of CfnEndpoint.KinesisSettingsProperty