Class CfnReplicationTask
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::DMS::ReplicationTask
.
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();
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnReplicationTask
(Construct scope, String id, CfnReplicationTaskProps props) Create a newAWS::DMS::ReplicationTask
.protected
CfnReplicationTask
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnReplicationTask
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionIndicates when you want a change data capture (CDC) operation to start.Indicates the start time for a change data capture (CDC) operation.Indicates when you want a change data capture (CDC) operation to stop.The migration type.The Amazon Resource Name (ARN) of a replication instance.An identifier for the replication task.Overall settings for the task, in JSON format.A display name for the resource identifier at the end of theEndpointArn
response parameter that is returned in the createdEndpoint
object.An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.The table mappings for the task, in JSON format.getTags()
One or more tags to be assigned to the replication task.An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.AWS::DMS::ReplicationTask.TaskData
.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setCdcStartPosition
(String value) Indicates when you want a change data capture (CDC) operation to start.void
setCdcStartTime
(Number value) Indicates the start time for a change data capture (CDC) operation.void
setCdcStopPosition
(String value) Indicates when you want a change data capture (CDC) operation to stop.void
setMigrationType
(String value) The migration type.void
setReplicationInstanceArn
(String value) The Amazon Resource Name (ARN) of a replication instance.void
An identifier for the replication task.void
setReplicationTaskSettings
(String value) Overall settings for the task, in JSON format.void
setResourceIdentifier
(String value) A display name for the resource identifier at the end of theEndpointArn
response parameter that is returned in the createdEndpoint
object.void
setSourceEndpointArn
(String value) An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.void
setTableMappings
(String value) The table mappings for the task, in JSON format.void
setTargetEndpointArn
(String value) An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.void
setTaskData
(String value) AWS::DMS::ReplicationTask.TaskData
.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnReplicationTask
protected CfnReplicationTask(software.amazon.jsii.JsiiObjectRef objRef) -
CfnReplicationTask
protected CfnReplicationTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnReplicationTask
@Stability(Stable) public CfnReplicationTask(@NotNull Construct scope, @NotNull String id, @NotNull CfnReplicationTaskProps props) Create a newAWS::DMS::ReplicationTask
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
One or more tags to be assigned to the replication task. -
getMigrationType
The migration type.Valid values:
full-load
|cdc
|full-load-and-cdc
-
setMigrationType
The migration type.Valid values:
full-load
|cdc
|full-load-and-cdc
-
getReplicationInstanceArn
The Amazon Resource Name (ARN) of a replication instance. -
setReplicationInstanceArn
The Amazon Resource Name (ARN) of a replication instance. -
getSourceEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. -
setSourceEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. -
getTableMappings
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 .
-
setTableMappings
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 .
-
getTargetEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. -
setTargetEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. -
getCdcStartPosition
Indicates when you want a change data capture (CDC) operation to start.Use either
CdcStartPosition
orCdcStartTime
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 . -
setCdcStartPosition
Indicates when you want a change data capture (CDC) operation to start.Use either
CdcStartPosition
orCdcStartTime
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 . -
getCdcStartTime
Indicates the start time for a change data capture (CDC) operation. -
setCdcStartTime
Indicates the start time for a change data capture (CDC) operation. -
getCdcStopPosition
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"
-
setCdcStopPosition
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"
-
getReplicationTaskIdentifier
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.
-
setReplicationTaskIdentifier
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.
-
getReplicationTaskSettings
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 .
-
setReplicationTaskSettings
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 .
-
getResourceIdentifier
A display name for the resource identifier at the end of theEndpointArn
response parameter that is returned in the createdEndpoint
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
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify aResourceIdentifier
value, AWS DMS generates a default identifier value for the end ofEndpointArn
. -
setResourceIdentifier
A display name for the resource identifier at the end of theEndpointArn
response parameter that is returned in the createdEndpoint
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
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify aResourceIdentifier
value, AWS DMS generates a default identifier value for the end ofEndpointArn
. -
getTaskData
AWS::DMS::ReplicationTask.TaskData
. -
setTaskData
AWS::DMS::ReplicationTask.TaskData
.
-