@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.918Z") public class CfnReplicationTask extends CfnResource implements IInspectable
The AWS::DMS::ReplicationTask
resource creates an AWS DMS replication task.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.dms.*; CfnReplicationTask cfnReplicationTask = CfnReplicationTask.Builder.create(this, "MyCfnReplicationTask") .migrationType("migrationType") .replicationInstanceArn("replicationInstanceArn") .sourceEndpointArn("sourceEndpointArn") .tableMappings("tableMappings") .targetEndpointArn("targetEndpointArn") // the properties below are optional .cdcStartPosition("cdcStartPosition") .cdcStartTime(123) .cdcStopPosition("cdcStopPosition") .replicationTaskIdentifier("replicationTaskIdentifier") .replicationTaskSettings("replicationTaskSettings") .resourceIdentifier("resourceIdentifier") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .taskData("taskData") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnReplicationTask.Builder
A fluent builder for
CfnReplicationTask . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnReplicationTask(Construct scope,
java.lang.String id,
CfnReplicationTaskProps props)
Create a new `AWS::DMS::ReplicationTask`.
|
protected |
CfnReplicationTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnReplicationTask(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCdcStartPosition()
Indicates when you want a change data capture (CDC) operation to start.
|
java.lang.Number |
getCdcStartTime()
Indicates the start time for a change data capture (CDC) operation.
|
java.lang.String |
getCdcStopPosition()
Indicates when you want a change data capture (CDC) operation to stop.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getMigrationType()
The migration type.
|
java.lang.String |
getReplicationInstanceArn()
The Amazon Resource Name (ARN) of a replication instance.
|
java.lang.String |
getReplicationTaskIdentifier()
An identifier for the replication task.
|
java.lang.String |
getReplicationTaskSettings()
Overall settings for the task, in JSON format.
|
java.lang.String |
getResourceIdentifier()
A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
|
java.lang.String |
getSourceEndpointArn()
An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
|
java.lang.String |
getTableMappings()
The table mappings for the task, in JSON format.
|
TagManager |
getTags()
One or more tags to be assigned to the replication task.
|
java.lang.String |
getTargetEndpointArn()
An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
|
java.lang.String |
getTaskData()
`AWS::DMS::ReplicationTask.TaskData`.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCdcStartPosition(java.lang.String value)
Indicates when you want a change data capture (CDC) operation to start.
|
void |
setCdcStartTime(java.lang.Number value)
Indicates the start time for a change data capture (CDC) operation.
|
void |
setCdcStopPosition(java.lang.String value)
Indicates when you want a change data capture (CDC) operation to stop.
|
void |
setMigrationType(java.lang.String value)
The migration type.
|
void |
setReplicationInstanceArn(java.lang.String value)
The Amazon Resource Name (ARN) of a replication instance.
|
void |
setReplicationTaskIdentifier(java.lang.String value)
An identifier for the replication task.
|
void |
setReplicationTaskSettings(java.lang.String value)
Overall settings for the task, in JSON format.
|
void |
setResourceIdentifier(java.lang.String value)
A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
|
void |
setSourceEndpointArn(java.lang.String value)
An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
|
void |
setTableMappings(java.lang.String value)
The table mappings for the task, in JSON format.
|
void |
setTargetEndpointArn(java.lang.String value)
An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
|
void |
setTaskData(java.lang.String value)
`AWS::DMS::ReplicationTask.TaskData`.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnReplicationTask(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnReplicationTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnReplicationTask(Construct scope, java.lang.String id, CfnReplicationTaskProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getMigrationType()
Valid values: full-load
| cdc
| full-load-and-cdc
public void setMigrationType(java.lang.String value)
Valid values: full-load
| cdc
| full-load-and-cdc
public java.lang.String getReplicationInstanceArn()
public void setReplicationInstanceArn(java.lang.String value)
public java.lang.String getSourceEndpointArn()
public void setSourceEndpointArn(java.lang.String value)
public java.lang.String getTableMappings()
For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide .
public void setTableMappings(java.lang.String value)
For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide .
public java.lang.String getTargetEndpointArn()
public void setTargetEndpointArn(java.lang.String value)
public java.lang.String getCdcStartPosition()
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 .
public void setCdcStartPosition(java.lang.String value)
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 .
public java.lang.Number getCdcStartTime()
public void setCdcStartTime(java.lang.Number value)
public java.lang.String getCdcStopPosition()
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"
public void setCdcStopPosition(java.lang.String value)
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"
public java.lang.String getReplicationTaskIdentifier()
Constraints:
public void setReplicationTaskIdentifier(java.lang.String value)
Constraints:
public java.lang.String getReplicationTaskSettings()
For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide .
public void setReplicationTaskSettings(java.lang.String value)
For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide .
public java.lang.String getResourceIdentifier()
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
.
public void setResourceIdentifier(java.lang.String value)
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
.
public java.lang.String getTaskData()
public void setTaskData(java.lang.String value)