CfnReplicationTask

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.dms.CfnReplicationTask

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.918Z")
public class CfnReplicationTask
extends CfnResource
implements IInspectable

A CloudFormation `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 Classes
Modifier and Type Class and Description

static class CfnReplicationTask.Builder
A fluent builder for CfnReplicationTask.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnReplicationTask.Builder` A fluent builder for `CfnReplicationTask`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
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)`

Method Summary

All Methods Instance Methods Concrete Methods
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`.

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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnReplicationTask
```
protected CfnReplicationTask(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnReplicationTask
```
protected CfnReplicationTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnReplicationTask
```
public CfnReplicationTask(Construct scope,
                          java.lang.String id,
                          CfnReplicationTaskProps props)
```
    Create a new `AWS::DMS::ReplicationTask`.
    
    Parameters:
    
    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.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    One or more tags to be assigned to the replication task.
  - getMigrationType
```
public java.lang.String getMigrationType()
```
    The migration type.
    Valid values: full-load | cdc | full-load-and-cdc
  - setMigrationType
```
public void setMigrationType(java.lang.String value)
```
    The migration type.
    Valid values: full-load | cdc | full-load-and-cdc
  - getReplicationInstanceArn
```
public java.lang.String getReplicationInstanceArn()
```
    The Amazon Resource Name (ARN) of a replication instance.
  - setReplicationInstanceArn
```
public void setReplicationInstanceArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of a replication instance.
  - getSourceEndpointArn
```
public java.lang.String getSourceEndpointArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
  - setSourceEndpointArn
```
public void setSourceEndpointArn(java.lang.String value)
```
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
  - getTableMappings
```
public java.lang.String 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
```
public void setTableMappings(java.lang.String value)
```
    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
```
public java.lang.String getTargetEndpointArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
  - setTargetEndpointArn
```
public void setTargetEndpointArn(java.lang.String value)
```
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
  - getCdcStartPosition
```
public java.lang.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, 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
```
public void setCdcStartPosition(java.lang.String value)
```
    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 .
  - getCdcStartTime
```
public java.lang.Number getCdcStartTime()
```
    Indicates the start time for a change data capture (CDC) operation.
  - setCdcStartTime
```
public void setCdcStartTime(java.lang.Number value)
```
    Indicates the start time for a change data capture (CDC) operation.
  - getCdcStopPosition
```
public java.lang.String 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
```
public void setCdcStopPosition(java.lang.String value)
```
    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
```
public java.lang.String 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
```
public void setReplicationTaskIdentifier(java.lang.String value)
```
    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
```
public java.lang.String 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
```
public void setReplicationTaskSettings(java.lang.String value)
```
    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
```
public 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.
    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 .
  - setResourceIdentifier
```
public 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.
    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 .
  - getTaskData
```
public java.lang.String getTaskData()
```
    `AWS::DMS::ReplicationTask.TaskData`.
  - setTaskData
```
public void setTaskData(java.lang.String value)
```
    `AWS::DMS::ReplicationTask.TaskData`.

Class CfnReplicationTask

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnReplicationTask

CfnReplicationTask

CfnReplicationTask

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getMigrationType

setMigrationType

getReplicationInstanceArn

setReplicationInstanceArn

getSourceEndpointArn

setSourceEndpointArn

getTableMappings

setTableMappings

getTargetEndpointArn

setTargetEndpointArn

getCdcStartPosition

setCdcStartPosition

getCdcStartTime

setCdcStartTime

getCdcStopPosition

setCdcStopPosition

getReplicationTaskIdentifier

setReplicationTaskIdentifier

getReplicationTaskSettings

setReplicationTaskSettings

getResourceIdentifier

setResourceIdentifier

getTaskData

setTaskData