AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Database Migration Service CreateReplicationTask API operation.

Syntax

New-DMSReplicationTask
-ReplicationInstanceArn <String>
-CdcStartPosition <String>
-CdcStartTime <DateTime>
-CdcStopPosition <String>
-MigrationType <MigrationTypeValue>
-ReplicationTaskIdentifier <String>
-ReplicationTaskSetting <String>
-SourceEndpointArn <String>
-TableMapping <String>
-Tag <Tag[]>
-TargetEndpointArn <String>
-Force <SwitchParameter>

Description

Creates a replication task using the specified parameters.

Parameters

-CdcStartPosition <String>
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”
Required?False
Position?Named
Accept pipeline input?False
-CdcStartTime <DateTime>
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”
Required?False
Position?Named
Accept pipeline input?False
-CdcStopPosition <String>
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 “
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-MigrationType <MigrationTypeValue>
The migration type.
Required?False
Position?Named
Accept pipeline input?False
-ReplicationInstanceArn <String>
The Amazon Resource Name (ARN) of the replication instance.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ReplicationTaskIdentifier <String>
The replication task identifier.Constraints:
  • Must contain from 1 to 255 alphanumeric characters or hyphens.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.
Required?False
Position?Named
Accept pipeline input?False
-ReplicationTaskSetting <String>
Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration User Guide.
Required?False
Position?Named
Accept pipeline input?False
-SourceEndpointArn <String>
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
Required?False
Position?Named
Accept pipeline input?False
-TableMapping <String>
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
Required?False
Position?Named
Accept pipeline input?False
-Tag <Tag[]>
Tags to be added to the replication instance.
Required?False
Position?Named
Accept pipeline input?False
-TargetEndpointArn <String>
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

System.String
You can pipe a String object to this cmdlet for the ReplicationInstanceArn parameter.

Outputs

Amazon.DatabaseMigrationService.Model.ReplicationTask
This cmdlet returns a ReplicationTask object. The service call response (type Amazon.DatabaseMigrationService.Model.CreateReplicationTaskResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Schema Conversion User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z