Amazon Aurora
User Guide for Aurora

Working with Amazon Resource Names (ARNs) in Amazon RDS

Resources created in Amazon Web Services are each uniquely identified with an Amazon Resource Name (ARN). For certain Amazon RDS operations, you must uniquely identify an Amazon RDS resource by specifying its ARN. For example, when you create an RDS DB instance Read Replica, you must supply the ARN for the source DB instance.

Constructing an ARN for Amazon RDS

Resources created in Amazon Web Services are each uniquely identified with an Amazon Resource Name (ARN). You can construct an ARN for an Amazon RDS resource using the following syntax.

arn:aws:rds:<region>:<account number>:<resourcetype>:<name>

Region Name Region Endpoint Protocol
US East (Ohio) us-east-2 rds.us-east-2.amazonaws.com HTTPS
US East (N. Virginia) us-east-1 rds.us-east-1.amazonaws.com HTTPS
US West (N. California) us-west-1 rds.us-west-1.amazonaws.com HTTPS
US West (Oregon) us-west-2 rds.us-west-2.amazonaws.com HTTPS
Asia Pacific (Hong Kong) ap-east-1 rds.ap-east-1.amazonaws.com HTTPS
Asia Pacific (Mumbai) ap-south-1 rds.ap-south-1.amazonaws.com HTTPS
Asia Pacific (Osaka-Local) ap-northeast-3 rds.ap-northeast-3.amazonaws.com HTTPS
Asia Pacific (Seoul) ap-northeast-2 rds.ap-northeast-2.amazonaws.com HTTPS
Asia Pacific (Singapore) ap-southeast-1 rds.ap-southeast-1.amazonaws.com HTTPS
Asia Pacific (Sydney) ap-southeast-2 rds.ap-southeast-2.amazonaws.com HTTPS
Asia Pacific (Tokyo) ap-northeast-1 rds.ap-northeast-1.amazonaws.com HTTPS
Canada (Central) ca-central-1 rds.ca-central-1.amazonaws.com HTTPS
China (Beijing) cn-north-1 rds.cn-north-1.amazonaws.com.cn HTTPS
China (Ningxia) cn-northwest-1 rds.cn-northwest-1.amazonaws.com.cn HTTPS
EU (Frankfurt) eu-central-1 rds.eu-central-1.amazonaws.com HTTPS
EU (Ireland) eu-west-1 rds.eu-west-1.amazonaws.com HTTPS
EU (London) eu-west-2 rds.eu-west-2.amazonaws.com HTTPS
EU (Paris) eu-west-3 rds.eu-west-3.amazonaws.com HTTPS
EU (Stockholm) eu-north-1 rds.eu-north-1.amazonaws.com HTTPS
Middle East (Bahrain) me-south-1 rds.me-south-1.amazonaws.com HTTPS
South America (Sao Paulo) sa-east-1 rds.sa-east-1.amazonaws.com HTTPS
AWS GovCloud (US-East) us-gov-east-1 rds.us-gov-east-1.amazonaws.com HTTPS
AWS GovCloud (US-West) us-gov-west-1 rds.us-gov-west-1.amazonaws.com HTTPS

The following table shows the format that you should use when constructing an ARN for a particular Amazon RDS resource type.

Resource Type ARN Format
DB instance

arn:aws:rds:<region>:<account>:db:<name>

For example:

arn:aws:rds:us-east-2:123456789012:db:my-mysql-instance-1

DB cluster

arn:aws:rds:<region>:<account>:cluster:<name>

For example:

arn:aws:rds:us-east-2:123456789012:cluster:my-aurora-cluster-1
Event subscription

arn:aws:rds:<region>:<account>:es:<name>

For example:

arn:aws:rds:us-east-2:123456789012:es:my-subscription
DB parameter group

arn:aws:rds:<region>:<account>:pg:<name>

For example:

arn:aws:rds:us-east-2:123456789012:pg:my-param-enable-logs
DB cluster parameter group

arn:aws:rds:<region>:<account>:cluster-pg:<name>

For example:

arn:aws:rds:us-east-2:123456789012:cluster-pg:my-cluster-param-timezone
Reserved DB instance

arn:aws:rds:<region>:<account>:ri:<name>

For example:

arn:aws:rds:us-east-2:123456789012:ri:my-reserved-postgresql
DB security group

arn:aws:rds:<region>:<account>:secgrp:<name>

For example:

arn:aws:rds:us-east-2:123456789012:secgrp:my-public
Automated DB snapshot

arn:aws:rds:<region>:<account>:snapshot:rds:<name>

For example:

arn:aws:rds:us-east-2:123456789012:snapshot:rds:my-mysql-db-2019-07-22-07-23
Automated DB cluster snapshot

arn:aws:rds:<region>:<account>:cluster-snapshot:rds:<name>

For example:

arn:aws:rds:us-east-2:123456789012:cluster-snapshot:rds:my-aurora-cluster-2019-07-22-16-16
Manual DB snapshot

arn:aws:rds:<region>:<account>:snapshot:<name>

For example:

arn:aws:rds:us-east-2:123456789012:snapshot:my-mysql-db-snap
Manual DB cluster snapshot

arn:aws:rds:<region>:<account>:cluster-snapshot:<name>

For example:

arn:aws:rds:us-east-2:123456789012:cluster-snapshot:my-aurora-cluster-snap
DB subnet group

arn:aws:rds:<region>:<account>:subgrp:<name>

For example:

arn:aws:rds:us-east-2:123456789012:subgrp:my-subnet-10

Getting an Existing ARN

You can get the ARN of an RDS resource by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or RDS API.

Console

To get an ARN from the AWS Management Console, navigate to the resource you want an ARN for, and view the details for that resource. For example, you can get the ARN for a DB instance from the Configuration tab of the DB instance details, as shown following.


    				DB instance ARN

AWS CLI

To get an ARN from the AWS CLI for a particular RDS resource, you use the describe command for that resource. The following table shows each AWS CLI command, and the ARN property used with the command to get an ARN.

AWS CLI Command ARN Property
describe-event-subscriptions EventSubscriptionArn
describe-certificates CertificateArn
describe-db-parameter-groups DBParameterGroupArn
describe-db-cluster-parameter-groups DBClusterParameterGroupArn
describe-db-instances DBInstanceArn
describe-db-security-groups DBSecurityGroupArn
describe-db-snapshots DBSnapshotArn
describe-events SourceArn
describe-reserved-db-instances ReservedDBInstanceArn
describe-db-subnet-groups DBSubnetGroupArn
describe-db-clusters DBClusterArn
describe-db-cluster-snapshots DBClusterSnapshotArn

For example, the following AWS CLI command gets the ARN for a DB instance.

Example

For Linux, OS X, or Unix:

aws rds describe-db-instances \ --db-instance-identifier DBInstanceIdentifier \ --region us-west-2

For Windows:

aws rds describe-db-instances ^ --db-instance-identifier DBInstanceIdentifier ^ --region us-west-2

RDS API

To get an ARN for a particular RDS resource, you can call the following RDS API operations and use the ARN properties shown following.

RDS API Operation ARN Property
DescribeEventSubscriptions EventSubscriptionArn
DescribeCertificates CertificateArn
DescribeDBParameterGroups DBParameterGroupArn
DescribeDBClusterParameterGroups DBClusterParameterGroupArn
DescribeDBInstances DBInstanceArn
DescribeDBSecurityGroups DBSecurityGroupArn
DescribeDBSnapshots DBSnapshotArn
DescribeEvents SourceArn
DescribeReservedDBInstances ReservedDBInstanceArn
DescribeDBSubnetGroups DBSubnetGroupArn
DescribeDBClusters DBClusterArn
DescribeDBClusterSnapshots DBClusterSnapshotArn