Package software.amazon.awscdk.services.dms

Class CfnReplicationTaskProps.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnReplicationTaskProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnReplicationTaskProps>

Enclosing interface:

CfnReplicationTaskProps

@Stability(Stable)
public static final class CfnReplicationTaskProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnReplicationTaskProps>

A builder for CfnReplicationTaskProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnReplicationTaskProps	build()	Builds the configured instance.
CfnReplicationTaskProps.Builder	cdcStartPosition(String cdcStartPosition)	Sets the value of CfnReplicationTaskProps.getCdcStartPosition()
CfnReplicationTaskProps.Builder	cdcStartTime(Number cdcStartTime)	Sets the value of CfnReplicationTaskProps.getCdcStartTime()
CfnReplicationTaskProps.Builder	cdcStopPosition(String cdcStopPosition)	Sets the value of CfnReplicationTaskProps.getCdcStopPosition()
CfnReplicationTaskProps.Builder	migrationType(String migrationType)	Sets the value of CfnReplicationTaskProps.getMigrationType()
CfnReplicationTaskProps.Builder	replicationInstanceArn(String replicationInstanceArn)	Sets the value of CfnReplicationTaskProps.getReplicationInstanceArn()
CfnReplicationTaskProps.Builder	replicationTaskIdentifier(String replicationTaskIdentifier)	Sets the value of CfnReplicationTaskProps.getReplicationTaskIdentifier()
CfnReplicationTaskProps.Builder	replicationTaskSettings(String replicationTaskSettings)	Sets the value of CfnReplicationTaskProps.getReplicationTaskSettings()
CfnReplicationTaskProps.Builder	resourceIdentifier(String resourceIdentifier)	Sets the value of CfnReplicationTaskProps.getResourceIdentifier()
CfnReplicationTaskProps.Builder	sourceEndpointArn(String sourceEndpointArn)	Sets the value of CfnReplicationTaskProps.getSourceEndpointArn()
CfnReplicationTaskProps.Builder	tableMappings(String tableMappings)	Sets the value of CfnReplicationTaskProps.getTableMappings()
CfnReplicationTaskProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnReplicationTaskProps.getTags()
CfnReplicationTaskProps.Builder	targetEndpointArn(String targetEndpointArn)	Sets the value of CfnReplicationTaskProps.getTargetEndpointArn()
CfnReplicationTaskProps.Builder	taskData(String taskData)	Sets the value of CfnReplicationTaskProps.getTaskData()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

migrationType

@Stability(Stable)
public CfnReplicationTaskProps.Builder migrationType(String migrationType)

Sets the value of CfnReplicationTaskProps.getMigrationType()

Parameters:

migrationType - The migration type. This parameter is required. Valid values: full-load | cdc | full-load-and-cdc

Returns:

this

replicationInstanceArn

@Stability(Stable)
public CfnReplicationTaskProps.Builder replicationInstanceArn(String replicationInstanceArn)

Sets the value of CfnReplicationTaskProps.getReplicationInstanceArn()

Parameters:

replicationInstanceArn - The Amazon Resource Name (ARN) of a replication instance. This parameter is required.

Returns:

this

sourceEndpointArn

@Stability(Stable)
public CfnReplicationTaskProps.Builder sourceEndpointArn(String sourceEndpointArn)

Sets the value of CfnReplicationTaskProps.getSourceEndpointArn()

Parameters:

sourceEndpointArn - An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. This parameter is required.

Returns:

this

tableMappings

@Stability(Stable)
public CfnReplicationTaskProps.Builder tableMappings(String tableMappings)

Sets the value of CfnReplicationTaskProps.getTableMappings()

Parameters:

tableMappings - The table mappings for the task, in JSON format. This parameter is required. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide .

Returns:

this

targetEndpointArn

@Stability(Stable)
public CfnReplicationTaskProps.Builder targetEndpointArn(String targetEndpointArn)

Sets the value of CfnReplicationTaskProps.getTargetEndpointArn()

Parameters:

targetEndpointArn - An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. This parameter is required.

Returns:

this

cdcStartPosition

@Stability(Stable)
public CfnReplicationTaskProps.Builder cdcStartPosition(String cdcStartPosition)

Sets the value of CfnReplicationTaskProps.getCdcStartPosition()

Parameters:

cdcStartPosition - Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, log sequence number (LSN), or system change number (SCN) format.

Here is a date example: --cdc-start-position "2018-03-08T12:12:12"

Here is a checkpoint example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

Here is an LSN example: --cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

this

cdcStartTime

@Stability(Stable)
public CfnReplicationTaskProps.Builder cdcStartTime(Number cdcStartTime)

Sets the value of CfnReplicationTaskProps.getCdcStartTime()

Parameters:

cdcStartTime - Indicates the start time for a change data capture (CDC) operation.

Returns:

this

cdcStopPosition

@Stability(Stable)
public CfnReplicationTaskProps.Builder cdcStopPosition(String cdcStopPosition)

Sets the value of CfnReplicationTaskProps.getCdcStopPosition()

Parameters:

cdcStopPosition - Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Here is a server time example: --cdc-stop-position "server_time:2018-02-09T12:12:12"

Here is a commit time example: --cdc-stop-position "commit_time: 2018-02-09T12:12:12"

Returns:

this

replicationTaskIdentifier

@Stability(Stable)
public CfnReplicationTaskProps.Builder replicationTaskIdentifier(String replicationTaskIdentifier)

Sets the value of CfnReplicationTaskProps.getReplicationTaskIdentifier()

Parameters:

replicationTaskIdentifier - An identifier for the replication task. Constraints:

• Must contain 1-255 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

this

replicationTaskSettings

@Stability(Stable)
public CfnReplicationTaskProps.Builder replicationTaskSettings(String replicationTaskSettings)

Sets the value of CfnReplicationTaskProps.getReplicationTaskSettings()

Parameters:

replicationTaskSettings - Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide .

Returns:

this

resourceIdentifier

@Stability(Stable)
public CfnReplicationTaskProps.Builder resourceIdentifier(String resourceIdentifier)

Sets the value of CfnReplicationTaskProps.getResourceIdentifier()

Parameters:

resourceIdentifier - A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1 .

For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don't specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn .

Returns:

this

tags

@Stability(Stable)
public CfnReplicationTaskProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnReplicationTaskProps.getTags()

Parameters:

tags - One or more tags to be assigned to the replication task.

Returns:

this

taskData

@Stability(Stable)
public CfnReplicationTaskProps.Builder taskData(String taskData)

Sets the value of CfnReplicationTaskProps.getTaskData()

Parameters:

taskData - Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Returns:

this

build

@Stability(Stable)
public CfnReplicationTaskProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnReplicationTaskProps>

Returns:

a new instance of CfnReplicationTaskProps

Throws:

NullPointerException - if any required attribute was not provided