com.amazonaws.services.databasemigrationservice.model

Class ModifyReplicationTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.databasemigrationservice.model.ModifyReplicationTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyReplicationTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyReplicationTaskRequest()

Method Summary

Modifier and Type	Method and Description
ModifyReplicationTaskRequest	clone()
boolean	equals(Object obj)
String	getCdcStartPosition() Indicates when you want a change data capture (CDC) operation to start.
Date	getCdcStartTime() Indicates the start time for a change data capture (CDC) operation.
String	getCdcStopPosition() Indicates when you want a change data capture (CDC) operation to stop.
String	getMigrationType() The migration type.
String	getReplicationTaskArn() The Amazon Resource Name (ARN) of the replication task.
String	getReplicationTaskIdentifier() The replication task identifier.
String	getReplicationTaskSettings() JSON file that contains settings for the task, such as task metadata settings.
String	getTableMappings() When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings.
String	getTaskData() Supplemental information that the task requires to migrate the data for certain source and target endpoints.
int	hashCode()
void	setCdcStartPosition(String cdcStartPosition) Indicates when you want a change data capture (CDC) operation to start.
void	setCdcStartTime(Date cdcStartTime) Indicates the start time for a change data capture (CDC) operation.
void	setCdcStopPosition(String cdcStopPosition) Indicates when you want a change data capture (CDC) operation to stop.
void	setMigrationType(MigrationTypeValue migrationType) The migration type.
void	setMigrationType(String migrationType) The migration type.
void	setReplicationTaskArn(String replicationTaskArn) The Amazon Resource Name (ARN) of the replication task.
void	setReplicationTaskIdentifier(String replicationTaskIdentifier) The replication task identifier.
void	setReplicationTaskSettings(String replicationTaskSettings) JSON file that contains settings for the task, such as task metadata settings.
void	setTableMappings(String tableMappings) When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings.
void	setTaskData(String taskData) Supplemental information that the task requires to migrate the data for certain source and target endpoints.
String	toString() Returns a string representation of this object.
ModifyReplicationTaskRequest	withCdcStartPosition(String cdcStartPosition) Indicates when you want a change data capture (CDC) operation to start.
ModifyReplicationTaskRequest	withCdcStartTime(Date cdcStartTime) Indicates the start time for a change data capture (CDC) operation.
ModifyReplicationTaskRequest	withCdcStopPosition(String cdcStopPosition) Indicates when you want a change data capture (CDC) operation to stop.
ModifyReplicationTaskRequest	withMigrationType(MigrationTypeValue migrationType) The migration type.
ModifyReplicationTaskRequest	withMigrationType(String migrationType) The migration type.
ModifyReplicationTaskRequest	withReplicationTaskArn(String replicationTaskArn) The Amazon Resource Name (ARN) of the replication task.
ModifyReplicationTaskRequest	withReplicationTaskIdentifier(String replicationTaskIdentifier) The replication task identifier.
ModifyReplicationTaskRequest	withReplicationTaskSettings(String replicationTaskSettings) JSON file that contains settings for the task, such as task metadata settings.
ModifyReplicationTaskRequest	withTableMappings(String tableMappings) When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings.
ModifyReplicationTaskRequest	withTaskData(String taskData) Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyReplicationTaskRequest

public ModifyReplicationTaskRequest()

Method Detail

setReplicationTaskArn

public void setReplicationTaskArn(String replicationTaskArn)

The Amazon Resource Name (ARN) of the replication task.

Parameters:

replicationTaskArn - The Amazon Resource Name (ARN) of the replication task.

getReplicationTaskArn

public String getReplicationTaskArn()

The Amazon Resource Name (ARN) of the replication task.

Returns:

The Amazon Resource Name (ARN) of the replication task.

withReplicationTaskArn

public ModifyReplicationTaskRequest withReplicationTaskArn(String replicationTaskArn)

The Amazon Resource Name (ARN) of the replication task.

Parameters:

replicationTaskArn - The Amazon Resource Name (ARN) of the replication task.

Returns:

Returns a reference to this object so that method calls can be chained together.

setReplicationTaskIdentifier

public void setReplicationTaskIdentifier(String replicationTaskIdentifier)

The replication task identifier.

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 - The replication task identifier.

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.

getReplicationTaskIdentifier

public String getReplicationTaskIdentifier()

The replication task identifier.

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:

The replication task identifier.

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.

withReplicationTaskIdentifier

public ModifyReplicationTaskRequest withReplicationTaskIdentifier(String replicationTaskIdentifier)

The replication task identifier.

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 - The replication task identifier.

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:

Returns a reference to this object so that method calls can be chained together.

setMigrationType

public void setMigrationType(String migrationType)

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Parameters:

migrationType - The migration type. Valid values: full-load | cdc | full-load-and-cdc

See Also:

MigrationTypeValue

getMigrationType

public String getMigrationType()

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Returns:

The migration type. Valid values: full-load | cdc | full-load-and-cdc

See Also:

MigrationTypeValue

withMigrationType

public ModifyReplicationTaskRequest withMigrationType(String migrationType)

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Parameters:

migrationType - The migration type. Valid values: full-load | cdc | full-load-and-cdc

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MigrationTypeValue

setMigrationType

public void setMigrationType(MigrationTypeValue migrationType)

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Parameters:

migrationType - The migration type. Valid values: full-load | cdc | full-load-and-cdc

See Also:

MigrationTypeValue

withMigrationType

public ModifyReplicationTaskRequest withMigrationType(MigrationTypeValue migrationType)

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Parameters:

migrationType - The migration type. Valid values: full-load | cdc | full-load-and-cdc

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MigrationTypeValue

setTableMappings

public void setTableMappings(String tableMappings)

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

Parameters:

tableMappings - When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

getTableMappings

public String getTableMappings()

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

Returns:

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

withTableMappings

public ModifyReplicationTaskRequest withTableMappings(String tableMappings)

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

Parameters:

tableMappings - When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

Returns:

Returns a reference to this object so that method calls can be chained together.

setReplicationTaskSettings

public void setReplicationTaskSettings(String replicationTaskSettings)

JSON file that contains settings for the task, such as task metadata settings.

Parameters:

replicationTaskSettings - JSON file that contains settings for the task, such as task metadata settings.

getReplicationTaskSettings

public String getReplicationTaskSettings()

JSON file that contains settings for the task, such as task metadata settings.

Returns:

JSON file that contains settings for the task, such as task metadata settings.

withReplicationTaskSettings

public ModifyReplicationTaskRequest withReplicationTaskSettings(String replicationTaskSettings)

JSON file that contains settings for the task, such as task metadata settings.

Parameters:

replicationTaskSettings - JSON file that contains settings for the task, such as task metadata settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCdcStartTime

public void setCdcStartTime(Date cdcStartTime)

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

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

Parameters:

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

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

getCdcStartTime

public Date getCdcStartTime()

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

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

Returns:

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

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

withCdcStartTime

public ModifyReplicationTaskRequest withCdcStartTime(Date cdcStartTime)

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

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

Parameters:

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

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

Returns:

Returns a reference to this object so that method calls can be chained together.

setCdcStartPosition

public void setCdcStartPosition(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, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

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"

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.

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, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

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"

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.

getCdcStartPosition

public String getCdcStartPosition()

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, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

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"

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.

Returns:

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, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

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"

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.

withCdcStartPosition

public ModifyReplicationTaskRequest withCdcStartPosition(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, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

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"

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.

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, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

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"

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCdcStopPosition

public void setCdcStopPosition(String cdcStopPosition)

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

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

Parameters:

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

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

getCdcStopPosition

public String getCdcStopPosition()

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

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

Returns:

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

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

withCdcStopPosition

public ModifyReplicationTaskRequest withCdcStopPosition(String cdcStopPosition)

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

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

Parameters:

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

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

Returns:

Returns a reference to this object so that method calls can be chained together.

setTaskData

public void setTaskData(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. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

getTaskData

public String getTaskData()

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:

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.

withTaskData

public ModifyReplicationTaskRequest withTaskData(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. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

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 ModifyReplicationTaskRequest clone()

Overrides:

clone in class AmazonWebServiceRequest