了解 Amazon DocumentDB Amazon 资源名称 (ARN)
- 为 Amazon DocumentDB资源构造 ARN
- 查找 Amazon DocumentDB资源 ARN
  - 使用 AWS 管理控制台
  - 使用 AWS CLI

了解 Amazon DocumentDB Amazon 资源名称 (ARN)

您在 AWS 中创建的资源分别使用 Amazon 资源名称 (ARN) 进行唯一标识。对于某些 Amazon DocumentDB（与 MongoDB 兼容）操作，您必须通过指定 Amazon DocumentDB 资源的 ARN 来唯一标识该资源。例如，当您向资源中添加标签时，必须提供该资源的 ARN。

为 Amazon DocumentDB资源构造 ARN

可以使用以下语法为 Amazon DocumentDB资源构造 ARN。Amazon DocumentDB共享 Amazon Relational Database Service (Amazon RDS) ARN 的格式。Amazon DocumentDB ARN 包含 rds，不包含 docdb。

arn:aws:rds:`region`:`account_number`:`resource_type`:`resource_id`

区域名称	区域	可用性区域（计算）
美国东部（俄亥俄州）	`us-east-2`	3
美国东部（弗吉尼亚北部）	`us-east-1`	6
美国西部（俄勒冈）	`us-west-2`	4
南美洲（圣保罗）	`sa-east-1`	3
亚太地区（孟买）	`ap-south-1`	3
亚太区域（首尔）	`ap-northeast-2`	4
亚太区域（新加坡）	`ap-southeast-1`	3
亚太区域（悉尼）	`ap-southeast-2`	3
亚太区域（东京）	`ap-northeast-1`	3
加拿大 (中部)	`ca-central-1`	3
欧洲（法兰克福）	`eu-central-1`	3
欧洲（爱尔兰）	`eu-west-1`	3
欧洲（伦敦）	`eu-west-2`	3
欧洲（巴黎）	`eu-west-3`	3
AWS GovCloud (US)	`us-gov-west-1`	3

注意

Amazon DocumentDB 架构将存储和计算分开。对于存储层，Amazon DocumentDB 在三个 AWS 可用区 (AZ) 之间复制 6 个数据副本。上表中列出的 AZ 是指，您可以在给定区域中预置计算实例时使用的 AZ 数。例如，如果要在 ap-northeast-1 中启动一个 Amazon DocumentDB 集群，将在三个 AZ 之间的 6 个方向复制存储，但仅在两个 AZ 中具有计算实例。

下表显示在为特定 Amazon DocumentDB资源构造 ARN 时应使用的格式。Amazon DocumentDB会共享 Amazon RDS ARN 的格式。Amazon DocumentDB ARN 包含 rds，不包含 docdb。

资源类型	ARN 格式/示例
实例 (`db`)	`arn:aws:rds:region:account_number:db:resource_id` `arn:aws:rds:us-east-1:1234567890:db:sample-db-instance`
集群 (`cluster`)	`arn:aws:rds:region:account_number:cluster:resource_id` `arn:aws:rds:us-east-1:1234567890:cluster:sample-db-cluster`
集群参数组 (`cluster-pg`)	`arn:aws:rds:region:account_number:cluster-pg:resource_id` `arn:aws:rds:us-east-1:1234567890:cluster-pg:sample-db-cluster-parameter-group`
安全组 (`secgrp`)	`arn:aws:rds:region:account_number:secgrp:resource_id` `arn:aws:rds:us-east-1:1234567890:secgrp:sample-public-secgrp`
集群快照 (`cluster-snapshot`)	`arn:aws:rds:region:account_number:cluster-snapshot:resource_id` `arn:aws:rds:us-east-1:1234567890:cluster-snapshot:sample-db-cluster-snapshot`
子网组 (`subgrp`)	`arn:aws:rds:region:account_number:subgrp:resource_id` `arn:aws:rds:us-east-1:1234567890:subgrp:sample-subnet-10`

查找 Amazon DocumentDB资源 ARN

您可以使用 AWS 管理控制台或 AWS CLI 查找 Amazon DocumentDB资源的 ARN。

使用 AWS 管理控制台

要使用控制台查找 ARN，请导航到要获取其 ARN 的资源，然后查看该资源的详细信息。

例如，您可以在集群的详细信息窗格中获取集群的 ARN，如以下屏幕截图所示。

使用 AWS CLI

要使用 AWS CLI 获取特定 Amazon DocumentDB资源的 ARN，请对该资源使用 describe 操作。下表显示了每个 AWS CLI 操作，以及与操作配合使用以获取 ARN 的 ARN 属性。

AWS CLI 命令	ARN 属性
`describe-db-instances`	`DBInstanceArn`
`describe-db-clusters`	`DBClusterArn`
`describe-db-parameter-groups`	`DBParameterGroupArn`
`describe-db-cluster-parameter-groups`	`DBClusterParameterGroupArn`
`describe-db-security-groups`	`DBSecurityGroupArn`
`describe-db-snapshots`	`DBSnapshotArn`
`describe-db-cluster-snapshots`	`DBClusterSnapshotArn`
`describe-db-subnet-groups`	`DBSubnetGroupArn`

例 - 查找集群的 ARN

以下 AWS CLI 操作可查找集群 sample-cluster 的 ARN。

对于 Linux、macOS 或 Unix:

aws docdb describe-db-clusters \
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].DBClusterArn'

对于 Windows:

aws docdb describe-db-clusters ^
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].DBClusterArn'

此操作的输出将类似于下文（JSON 格式）。


[
    "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster"
]

例 - 查找多个参数组的 ARN