Getting an existing ARN for Amazon RDS
You can get the ARN of an RDS resource by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or RDS API.
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.
![DB instance ARN.](/images/AmazonRDS/latest/UserGuide/images/DB-instance-arn.png)
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-option-groups | OptionGroupArn |
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, macOS, or Unix:
aws rds describe-db-instances \ --db-instance-identifier
DBInstanceIdentifier
\ --regionus-west-2
\ --query "*[].{DBInstanceIdentifier:DBInstanceIdentifier,DBInstanceArn:DBInstanceArn}"
For Windows:
aws rds describe-db-instances ^ --db-instance-identifier
DBInstanceIdentifier
^ --regionus-west-2
^ --query "*[].{DBInstanceIdentifier:DBInstanceIdentifier,DBInstanceArn:DBInstanceArn}"
The output of that command is like the following:
[
{
"DBInstanceArn": "arn:aws:rds:us-west-2:account_id
:db:instance_id
",
"DBInstanceIdentifier": "instance_id
"
}
]
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 |
DescribeOptionGroups | OptionGroupArn |
DescribeDBClusters | DBClusterArn |
DescribeDBClusterSnapshots | DBClusterSnapshotArn |