Menu
AWS Database Migration Service
User Guide (Version API Version 2016-01-01)

Constructing an Amazon Resource Name (ARN) for Use with AWS Database Migration Service

If you use the AWS CLI or AWS Database Migration Service API to automate your database migration, then you need to know about working with an Amazon Resource Name (ARN). Resources that are created in Amazon Web Services are identified by an ARN, which is a unique identifier. If you use the AWS CLI or AWS DMS API to set up your database migration, you must supply the ARN of the resource you want to work with.

An ARN for an AWS DMS resource uses the following syntax:

arn:aws:dms:<region>:<account number>:<resourcetype>:<resourcename>

In this syntax:

  • <region> is the AWS Region ID of the region where the AWS DMS resource was created, such as us-west-2.

    The following table shows AWS region names and the values you should use when constructing an ARN.

    Region Name
    Asia Pacific (Tokyo) Region ap-northeast-1
    Asia Pacific (Seoul) Region ap-northeast-2
    Asia Pacific (Mumbai) Region ap-south-1
    Asia Pacific (Singapore) Region ap-southeast-1
    Asia Pacific (Sydney) Region ap-southeast-2
    Canada (Central) Region ca-central-1
    EU (Frankfurt) Region eu-central-1
    EU (Ireland) Region eu-west-1
    EU (London) Region eu-west-2
    South America (São Paulo) Region sa-east-1
    US East (N. Virginia) Region us-east-1
    US East (Ohio) Region us-east-2
    US West (N. California) Region us-west-1
    US West (Oregon) Region us-west-2
  • <account number> is your account number with dashes omitted. To find your account number, log in to your AWS account at http://aws.amazon.com, choose My Account/Console, and then choose My Account.

  • <resourcetype> is the type of AWS DMS resource.

    The following table shows the resource types you should use when constructing an ARN for a particular AWS DMS resource.

    AWS DMS Resource Type ARN Format
    Replication instance arn:aws:dms:<region>: <account>:rep: <resourcename>
    Endpoint arn:aws:dms:<region>:<account>:endpoint: <resourcename>
    Replication task arn:aws:dms:<region>:<account>: task:<resourcename>
  • <resourcename> is the resource name assigned to the AWS DMS resource. This is a generated arbitrary string.

The following table shows examples of ARNs for AWS DMS resources with an AWS account of 123456789012, which were created in the US East (N. Virginia) region, and has a resource name :

Resource Type Sample ARN
Replication instance arn:aws:dms:us-east-1:123456789012:rep:QLXQZ64MH7CXF4QCQMGRVYVXAI
Endpoint arn:aws:dms:us-east-1:123456789012:endpoint:D3HMZ2IGUCGFF3NTAXUXGF6S5A
Migration task arn:aws:dms:us-east-1:123456789012:task:2PVREMWNPGYJCVU2IBPTOYTIV4