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

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)`
`String`	`getMessageFormat()` The output format for the records created on the endpoint.
`String`	`getServiceAccessRoleArn()` The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
`String`	`getStreamArn()` The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMessageFormat(String messageFormat)` The output format for the records created on the endpoint.
`void`	`setServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon 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`	`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`	`withServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon 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.
    
    Parameters:
    
    messageFormat - The output format for the records created on the endpoint. The message format is JSON.
    
    See Also:
    
    MessageFormatValue
  - getMessageFormat
```
public String getMessageFormat()
```
    The output format for the records created on the endpoint. The message format is JSON.
    
    Returns:
    
    The output format for the records created on the endpoint. The message format is JSON.
    
    See Also:
    
    MessageFormatValue
  - withMessageFormat
```
public KinesisSettings withMessageFormat(String messageFormat)
```
    The output format for the records created on the endpoint. The message format is JSON.
    
    Parameters:
    
    messageFormat - The output format for the records created on the endpoint. The message format is JSON.
    
    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.
    
    Parameters:
    
    messageFormat - The output format for the records created on the endpoint. The message format is JSON.
    
    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 IAM role that DMS uses to write to the Amazon Kinesis data stream.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
  - getServiceAccessRoleArn
```
public String getServiceAccessRoleArn()
```
    The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
  - withServiceAccessRoleArn
```
public KinesisSettings withServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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

toString

equals

hashCode

clone

marshall