Package software.amazon.awssdk.services.databasemigration.model

Class KinesisSettings

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.KinesisSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KinesisSettings.Builder,KinesisSettings>

@Generated("software.amazon.awssdk:codegen")
public final class KinesisSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KinesisSettings.Builder,KinesisSettings>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KinesisSettings.Builder

Method Summary

Modifier and Type	Method	Description
static KinesisSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeControlDetails()	Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
Boolean	includeNullAndEmpty()	Include NULL and empty columns for records migrated to the endpoint.
Boolean	includePartitionValue()	Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type.
Boolean	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.
Boolean	includeTransactionDetails()	Provides detailed transaction information from the source database.
MessageFormatValue	messageFormat()	The output format for the records created on the endpoint.
String	messageFormatAsString()	The output format for the records created on the endpoint.
Boolean	noHexPrefix()	Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
Boolean	partitionIncludeSchemaTable()	Prefixes schema and table names to partition values, when the partition type is primary-key-type.
List<SdkField<?>>	sdkFields()
static Class<? extends KinesisSettings.Builder>	serializableBuilderClass()
String	serviceAccessRoleArn()	The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream.
String	streamArn()	The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
KinesisSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamArn

public final String streamArn()

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

Returns:

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

messageFormat

public final MessageFormatValue 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).

If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormatValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

Returns:

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

See Also:

MessageFormatValue

messageFormatAsString

public final String messageFormatAsString()

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

If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormatValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

Returns:

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

See Also:

MessageFormatValue

serviceAccessRoleArn

public final String 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.

Returns:

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.

includeTransactionDetails

public final Boolean 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:

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.

includePartitionValue

public final Boolean includePartitionValue()

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

Returns:

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

partitionIncludeSchemaTable

public final Boolean 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:

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.

includeTableAlterOperations

public final Boolean 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:

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.

includeControlDetails

public final Boolean 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:

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

includeNullAndEmpty

public final Boolean includeNullAndEmpty()

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

Returns:

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

noHexPrefix

public final Boolean 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 the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

Returns:

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 the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

toBuilder

public KinesisSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KinesisSettings.Builder,KinesisSettings>

builder

public static KinesisSettings.Builder builder()

serializableBuilderClass

public static Class<? extends KinesisSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo