Class CfnEndpoint.KinesisSettingsProperty
Provides information that describes an Amazon Kinesis Data Stream endpoint.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public class KinesisSettingsProperty : Object, CfnEndpoint.IKinesisSettingsProperty
Syntax (vb)
Public Class KinesisSettingsProperty
Inherits Object
Implements CfnEndpoint.IKinesisSettingsProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var kinesisSettingsProperty = new KinesisSettingsProperty {
IncludeControlDetails = false,
IncludeNullAndEmpty = false,
IncludePartitionValue = false,
IncludeTableAlterOperations = false,
IncludeTransactionDetails = false,
MessageFormat = "messageFormat",
NoHexPrefix = false,
PartitionIncludeSchemaTable = false,
ServiceAccessRoleArn = "serviceAccessRoleArn",
StreamArn = "streamArn"
};
Synopsis
Constructors
KinesisSettingsProperty() |
Properties
IncludeControlDetails | Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. |
IncludeNullAndEmpty | Include NULL and empty columns for records migrated to the endpoint. |
IncludePartitionValue | Shows the partition value within the Kinesis message output, unless the partition type is |
IncludeTableAlterOperations | Includes any data definition language (DDL) operations that change the table in the control data, such as |
IncludeTransactionDetails | Provides detailed transaction information from the source database. |
MessageFormat | The output format for the records created on the endpoint. |
NoHexPrefix | Set this optional parameter to |
PartitionIncludeSchemaTable | Prefixes schema and table names to partition values, when the partition type is |
ServiceAccessRoleArn | The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. |
StreamArn | The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint. |
Constructors
KinesisSettingsProperty()
public KinesisSettingsProperty()
Properties
IncludeControlDetails
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
public object IncludeControlDetails { get; set; }
Property Value
System.Object
Remarks
IncludeNullAndEmpty
Include NULL and empty columns for records migrated to the endpoint.
public object IncludeNullAndEmpty { get; set; }
Property Value
System.Object
Remarks
IncludePartitionValue
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type
.
public object IncludePartitionValue { get; set; }
Property Value
System.Object
Remarks
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
.
public object IncludeTableAlterOperations { get; set; }
Property Value
System.Object
Remarks
IncludeTransactionDetails
Provides detailed transaction information from the source database.
public object IncludeTransactionDetails { get; set; }
Property Value
System.Object
Remarks
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
.
MessageFormat
The output format for the records created on the endpoint.
public string MessageFormat { get; set; }
Property Value
System.String
Remarks
The message format is JSON
(default) or JSON_UNFORMATTED
(a single line with no tab).
NoHexPrefix
Set this optional parameter to true
to avoid adding a '0x' prefix to raw data in hexadecimal format.
public object NoHexPrefix { get; set; }
Property Value
System.Object
Remarks
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.
PartitionIncludeSchemaTable
Prefixes schema and table names to partition values, when the partition type is primary-key-type
.
public object PartitionIncludeSchemaTable { get; set; }
Property Value
System.Object
Remarks
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
.
ServiceAccessRoleArn
The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream.
public string ServiceAccessRoleArn { get; set; }
Property Value
System.String
Remarks
The role must allow the iam:PassRole
action.
StreamArn
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
public string StreamArn { get; set; }
Property Value
System.String