Package software.amazon.awscdk.services.dms

Class CfnReplicationTask.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnReplicationTask.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnReplicationTask>

Enclosing class:

CfnReplicationTask

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

A fluent builder for CfnReplicationTask.

Method Summary

Modifier and Type	Method	Description
CfnReplicationTask	build()
CfnReplicationTask.Builder	cdcStartPosition(String cdcStartPosition)	Indicates when you want a change data capture (CDC) operation to start.
CfnReplicationTask.Builder	cdcStartTime(Number cdcStartTime)	Indicates the start time for a change data capture (CDC) operation.
CfnReplicationTask.Builder	cdcStopPosition(String cdcStopPosition)	Indicates when you want a change data capture (CDC) operation to stop.
static CfnReplicationTask.Builder	create(software.constructs.Construct scope, String id)
CfnReplicationTask.Builder	migrationType(String migrationType)	The migration type.
CfnReplicationTask.Builder	replicationInstanceArn(String replicationInstanceArn)	The Amazon Resource Name (ARN) of a replication instance.
CfnReplicationTask.Builder	replicationTaskIdentifier(String replicationTaskIdentifier)	An identifier for the replication task.
CfnReplicationTask.Builder	replicationTaskSettings(String replicationTaskSettings)	Overall settings for the task, in JSON format.
CfnReplicationTask.Builder	resourceIdentifier(String resourceIdentifier)	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
CfnReplicationTask.Builder	sourceEndpointArn(String sourceEndpointArn)	An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
CfnReplicationTask.Builder	tableMappings(String tableMappings)	The table mappings for the task, in JSON format.
CfnReplicationTask.Builder	tags(List<? extends CfnTag> tags)	One or more tags to be assigned to the replication task.
CfnReplicationTask.Builder	targetEndpointArn(String targetEndpointArn)	An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
CfnReplicationTask.Builder	taskData(String taskData)	Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnReplicationTask.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnReplicationTask.Builder.

migrationType

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

The migration type.

Valid values: full-load | cdc | full-load-and-cdc

Parameters:

migrationType - The migration type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype

replicationInstanceArn

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

The Amazon Resource Name (ARN) of a replication instance.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn

sourceEndpointArn

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

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn

tableMappings

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

The table mappings for the task, in JSON format.

For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide .

Parameters:

tableMappings - The table mappings for the task, in JSON format. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings

targetEndpointArn

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

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn

cdcStartPosition

@Stability(Stable)
public CfnReplicationTask.Builder cdcStartPosition(String 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 .

Parameters:

cdcStartPosition - Indicates when you want a change data capture (CDC) operation to start. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition

cdcStartTime

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime

cdcStopPosition

@Stability(Stable)
public CfnReplicationTask.Builder cdcStopPosition(String 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"

Parameters:

cdcStopPosition - Indicates when you want a change data capture (CDC) operation to stop. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition

replicationTaskIdentifier

@Stability(Stable)
public CfnReplicationTask.Builder replicationTaskIdentifier(String 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.

Parameters:

replicationTaskIdentifier - An identifier for the replication task. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier

replicationTaskSettings

@Stability(Stable)
public CfnReplicationTask.Builder replicationTaskSettings(String 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 .

Parameters:

replicationTaskSettings - Overall settings for the task, in JSON format. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings

resourceIdentifier

@Stability(Stable)
public CfnReplicationTask.Builder resourceIdentifier(String 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 .

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-resourceidentifier

tags

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

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

Parameters:

tags - One or more tags to be assigned to the replication task. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags

taskData

@Stability(Stable)
public CfnReplicationTask.Builder taskData(String 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.

Parameters:

taskData - Supplemental information that the task requires to migrate the data for certain source and target endpoints. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata

build

@Stability(Stable)
public CfnReplicationTask build()

Specified by:

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

Returns:

a newly built instance of CfnReplicationTask.