Amazon Relational Database Service
用户指南 (API Version 2014-10-31)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

在 Amazon RDS 中使用 Amazon 资源名称 (ARN)

Amazon Web Services 中创建的资源分别使用 Amazon 资源名称 (ARN) 进行唯一标识。对于某些 Amazon RDS 操作,您必须通过指定 Amazon RDS 资源的 ARN 来进行唯一标识。例如,当您创建 RDS 数据库实例只读副本时,必须提供源数据库实例的 ARN。

构建 Amazon RDS 的 ARN

Amazon Web Services 中创建的资源分别使用 Amazon 资源名称 (ARN) 进行唯一标识。您可以使用以下语法为 Amazon RDS 资源构建 ARN。

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

在此语法中,指出的项目具有以下含义:

  • <region> 是从中创建了 Amazon RDS 资源的 AWS 区域名称。有关区域名称的列表,请参阅区域和可用区

  • <account number> 是省略了短划线的账号。要查找您的账号,请在 https://www.amazonaws.cn 登录您的 AWS 账户,选择 My Account/Console,然后选择 My Account

  • <resourcetype> 是 Amazon RDS 资源的类型,例如数据库实例或群集。

  • <name> 是 Amazon RDS 资源的资源标识符。

下表显示在构造特定 Amazon RDS 资源类型的 ARN 时应使用的格式。

资源类型 ARN 格式
数据库实例

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

例如:

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

数据库群集

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

例如:

arn:aws-cn:rds:us-east-2:123456789012:cluster:my-aurora-cluster-1
事件订阅

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

例如:

arn:aws-cn:rds:us-east-2:123456789012:es:my-subscription
数据库选项组

arn:aws-cn:rds:<region>:<account>:og:< name>

例如:

arn:aws-cn:rds:us-east-2:123456789012:og:my-og-oracle-tde
数据库参数组

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

例如:

arn:aws-cn:rds:us-east-2:123456789012:pg:my-param-enable-logs
数据库群集参数组

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

例如:

arn:aws-cn:rds:us-east-2:123456789012:cluster-pg:my-cluster-param-timezone
预留数据库实例

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

例如:

arn:aws-cn:rds:us-east-2:123456789012:ri:my-reserved-postgresql
数据库安全组

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

例如:

arn:aws-cn:rds:us-east-2:123456789012:secgrp:my-public
数据库快照

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

例如:

arn:aws-cn:rds:us-east-2:123456789012:snapshot:my-mysql-snap-20130507
数据库群集快照

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

例如:

arn:aws-cn:rds:us-east-2:123456789012:cluster-snapshot:my-aurora-snap-20160809
数据库子网组

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

例如:

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

获取现有 ARN

您可以使用 AWS 管理控制台、AWS Command Line Interface (AWS CLI) 或 RDS API 来获取 RDS 资源的 ARN。

AWS 管理控制台

要从 AWS 管理控制台 获取 ARN,请导航到要为其获取 ARN 的资源,并对该资源选择 See Details。例如,您可以从 Configuration Details 页面为数据库实例获取 ARN,如下所示。

 数据库实例 ARN

AWS CLI

要从 AWS CLI 为特定 RDS 资源获取 ARN,请对该资源使用 describe 命令。下表显示了每个 RDS CLI 命令,以及与命令配合使用以获取 ARN 的 ARN 属性。

RDS CLI 命令 ARN 属性
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

例如,以下 AWS CLI 命令为数据库实例获取 ARN。

针对 Linux、OS X 或 Unix:

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

对于 Windows:

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

API

要为特定 RDS 资源获取 ARN,您可以调用以下 RDS API 操作并使用如下所示的 ARN 属性。

RDS CLI 命令 ARN 属性
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

相关主题