KinesisSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.KinesisSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KinesisSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KinesisSettings()

Constructors
Constructor and Description
`KinesisSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KinesisSettings`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getIncludeControlDetails()` Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
`Boolean`	`getIncludePartitionValue()` Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type`.
`Boolean`	`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`.
`Boolean`	`getIncludeTransactionDetails()` Provides detailed transaction information from the source database.
`String`	`getMessageFormat()` The output format for the records created on the endpoint.
`Boolean`	`getPartitionIncludeSchemaTable()` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`String`	`getServiceAccessRoleArn()` The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
`String`	`getStreamArn()` The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
`int`	`hashCode()`
`Boolean`	`isIncludeControlDetails()` Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
`Boolean`	`isIncludePartitionValue()` Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type`.
`Boolean`	`isIncludeTableAlterOperations()` 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`	`isIncludeTransactionDetails()` Provides detailed transaction information from the source database.
`Boolean`	`isPartitionIncludeSchemaTable()` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIncludeControlDetails(Boolean includeControlDetails)` Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
`void`	`setIncludePartitionValue(Boolean includePartitionValue)` Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type`.
`void`	`setIncludeTableAlterOperations(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`.
`void`	`setIncludeTransactionDetails(Boolean includeTransactionDetails)` Provides detailed transaction information from the source database.
`void`	`setMessageFormat(String messageFormat)` The output format for the records created on the endpoint.
`void`	`setPartitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`void`	`setServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
`void`	`setStreamArn(String streamArn)` The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
`String`	`toString()` Returns a string representation of this object.
`KinesisSettings`	`withIncludeControlDetails(Boolean includeControlDetails)` Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
`KinesisSettings`	`withIncludePartitionValue(Boolean includePartitionValue)` Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type`.
`KinesisSettings`	`withIncludeTableAlterOperations(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`.
`KinesisSettings`	`withIncludeTransactionDetails(Boolean includeTransactionDetails)` Provides detailed transaction information from the source database.
`KinesisSettings`	`withMessageFormat(MessageFormatValue messageFormat)` The output format for the records created on the endpoint.
`KinesisSettings`	`withMessageFormat(String messageFormat)` The output format for the records created on the endpoint.
`KinesisSettings`	`withPartitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`KinesisSettings`	`withServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
`KinesisSettings`	`withStreamArn(String streamArn)` The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KinesisSettings
```
public KinesisSettings()
```
- Method Detail
  - setStreamArn
```
public void setStreamArn(String streamArn)
```
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    
    Parameters:
    
    streamArn - The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
  - getStreamArn
```
public String getStreamArn()
```
    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.
  - withStreamArn
```
public KinesisSettings withStreamArn(String streamArn)
```
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    
    Parameters:
    
    streamArn - The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageFormat
```
public void setMessageFormat(String 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).
    
    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).
    
    See Also:
    
    MessageFormatValue
  - getMessageFormat
```
public 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).
    
    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
  - withMessageFormat
```
public KinesisSettings withMessageFormat(String 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).
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageFormatValue
  - withMessageFormat
```
public KinesisSettings withMessageFormat(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).
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageFormatValue
  - setServiceAccessRoleArn
```
public void setServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
  - getServiceAccessRoleArn
```
public String getServiceAccessRoleArn()
```
    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
  - withServiceAccessRoleArn
```
public KinesisSettings withServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIncludeTransactionDetails
```
public void setIncludeTransactionDetails(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.
    
    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.
  - getIncludeTransactionDetails
```
public Boolean 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.
    
    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.
  - withIncludeTransactionDetails
```
public KinesisSettings withIncludeTransactionDetails(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeTransactionDetails
```
public Boolean isIncludeTransactionDetails()
```
    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.
  - setIncludePartitionValue
```
public void setIncludePartitionValue(Boolean includePartitionValue)
```
    Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is False.
    
    Parameters:
    
    includePartitionValue - Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is False.
  - getIncludePartitionValue
```
public Boolean getIncludePartitionValue()
```
    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.
  - withIncludePartitionValue
```
public KinesisSettings withIncludePartitionValue(Boolean includePartitionValue)
```
    Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is False.
    
    Parameters:
    
    includePartitionValue - Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is False.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludePartitionValue
```
public Boolean isIncludePartitionValue()
```
    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.
  - setPartitionIncludeSchemaTable
```
public void setPartitionIncludeSchemaTable(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.
    
    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.
  - getPartitionIncludeSchemaTable
```
public Boolean 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.
    
    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.
  - withPartitionIncludeSchemaTable
```
public KinesisSettings withPartitionIncludeSchemaTable(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPartitionIncludeSchemaTable
```
public Boolean isPartitionIncludeSchemaTable()
```
    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.
  - setIncludeTableAlterOperations
```
public void setIncludeTableAlterOperations(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.
    
    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.
  - getIncludeTableAlterOperations
```
public Boolean 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.
    
    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.
  - withIncludeTableAlterOperations
```
public KinesisSettings withIncludeTableAlterOperations(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeTableAlterOperations
```
public Boolean isIncludeTableAlterOperations()
```
    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.
  - setIncludeControlDetails
```
public void setIncludeControlDetails(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.
    
    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.
  - getIncludeControlDetails
```
public Boolean getIncludeControlDetails()
```
    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.
  - withIncludeControlDetails
```
public KinesisSettings withIncludeControlDetails(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeControlDetails
```
public Boolean isIncludeControlDetails()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public KinesisSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class KinesisSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KinesisSettings

Method Detail

setStreamArn

getStreamArn

withStreamArn

setMessageFormat

getMessageFormat

withMessageFormat

withMessageFormat

setServiceAccessRoleArn

getServiceAccessRoleArn

withServiceAccessRoleArn

setIncludeTransactionDetails

getIncludeTransactionDetails

withIncludeTransactionDetails

isIncludeTransactionDetails

setIncludePartitionValue

getIncludePartitionValue

withIncludePartitionValue

isIncludePartitionValue

setPartitionIncludeSchemaTable

getPartitionIncludeSchemaTable

withPartitionIncludeSchemaTable

isPartitionIncludeSchemaTable

setIncludeTableAlterOperations

getIncludeTableAlterOperations

withIncludeTableAlterOperations

isIncludeTableAlterOperations

setIncludeControlDetails

getIncludeControlDetails

withIncludeControlDetails

isIncludeControlDetails

toString

equals

hashCode

clone

marshall