本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 了解亚马逊 DocumentDB 亚马逊资源名称 () ARNs
<a name="documentdb-arns"></a>

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

**Topics**
+ [构建 ARN](#documentdb-arns-constructing)
+ [查找 ARN](#documentdb-arns-find)

## 为 Amazon DocumentDB 资源构造 ARN
<a name="documentdb-arns-constructing"></a>

您可以使用以下语法为 Amazon DocumentDB 资源构造 ARN。亚马逊 DocumentDB 采用亚马逊关系数据库服务（亚马逊 RDS）的格式。 ARNs亚马逊 DocumentDB ARNs 包含但不包含`rds`。`docdb`

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


| 区域名称 | Region | 可用区（计算） | 
| --- | --- | --- | 
| 美国东部（俄亥俄州） | `us-east-2` | 3 | 
| 美国东部（弗吉尼亚州北部） | `us-east-1` | 6 | 
| 美国西部（俄勒冈州） | `us-west-2` | 4 | 
| 非洲（开普敦） | `af-south-1` | 3 | 
| 南美洲（圣保罗） | `sa-east-1` | 3 | 
| 亚太地区（香港） | `ap-east-1` | 3 | 
| 亚太地区（海得拉巴） | `ap-south-2` | 3 | 
| 亚太地区（马来西亚） | `ap-southeast-5` | 3 | 
| 亚太地区（孟买） | `ap-south-1` | 3 | 
| 亚太地区（大阪） | `ap-northeast-3` | 3 | 
| 亚太地区（首尔） | `ap-northeast-2` | 4 | 
| 亚太地区（新加坡） | `ap-southeast-1` | 3 | 
| 亚太地区（悉尼） | `ap-southeast-2` | 3 | 
| 亚太地区（雅加达） | `ap-southeast-3` | 3 | 
| 亚太地区（墨尔本） | `ap-southeast-4` | 3 | 
| 亚太地区（泰国） | `ap-southeast-7` | 3 | 
| 亚太地区（东京） | `ap-northeast-1` | 3 | 
| 加拿大（中部） | `ca-central-1` | 3 | 
| 中国（北京）区域 | `cn-north-1` | 3 | 
| 中国（宁夏） | `cn-northwest-1` | 3 | 
| 欧洲地区（法兰克福） | `eu-central-1` | 3 | 
| 欧洲（苏黎世） | `eu-central-2` | 3 | 
| 欧洲地区（爱尔兰） | `eu-west-1` | 3 | 
| 欧洲地区（伦敦） | `eu-west-2` | 3 | 
| 欧洲地区（米兰） | `eu-south-1` | 3 | 
| 欧洲地区（巴黎） | `eu-west-3` | 3 | 
| 欧洲（西班牙） | `eu-south-2` | 3 | 
| 欧洲地区（斯德哥尔摩） | `eu-north-1` | 3 | 
| 墨西哥（中部） | `mx-central-1` | 3 | 
| 中东（阿联酋）： | `me-central-1` | 3 | 
| 以色列（特拉维夫） | `il-central-1` | 3 | 
| AWS GovCloud （美国西部） | `us-gov-west-1` | 3 | 
| AWS GovCloud （美国东部） | `us-gov-east-1` | 3 | 

**注意**  
Amazon DocumentDB 架构将存储和计算分开。对于存储层，Amazon DocumentDB 会在三个 AWS 可用区复制六份数据副本 ()。AZs上表中 AZs 列出的是在给定区域中可用于预置计算实例的数量。 AZs 例如，如果您在 ap-northeast-1 中启动一个 Amazon DocumentDB 集群，则您的存储将在三种方式中以六种方式进行复制，但您的计算实例只能以两种方式可用。 AZs AZs

下表显示在构造特定 Amazon DocumentDB 资源的 ARN 时应使用的格式。亚马逊 DocumentDB 采用亚马逊 RDS 的格式。 ARNs亚马逊 DocumentDB ARNs 包含但不包含`rds`。`docdb`


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

## 查找 Amazon DocumentDB 资源 ARN
<a name="documentdb-arns-find"></a>

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

------
#### [ Using the AWS 管理控制台 ]

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

例如，您可以通过选择集群详细信息页面上的**配置**选项卡来获取集群的 ARN。如以下屏幕截图所示，您可以在**配置和状态**部分中找到 ARN。

![\[控制台屏幕截图显示详细信息窗格的配置和状态部分中的 ARN。\]](http://docs.aws.amazon.com/zh_cn/documentdb/latest/developerguide/images/documentdb-arn.png)


------
#### [ Using the AWS CLI ]

要使用特定的 Amazon DocumentDB 资源获取 ARN，请`describe`对该资源使用操作。 AWS CLI 下表显示了每项 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`  | 

**Example - 查找集群的 ARN**  
以下 AWS CLI 操作查找集群的 ARN。`sample-cluster`  
对于 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"
]
```

**Example - ARNs 查找多个参数组**  
对于 Linux、macOS 或 Unix：  

```
aws docdb describe-db-cluster-parameter-groups \
   --query 'DBClusterParameterGroups[*].DBClusterParameterGroupArn'
```
对于 Windows：  

```
aws docdb describe-db-cluster-parameter-groups ^
   --query 'DBClusterParameterGroups[*].DBClusterParameterGroupArn'
```
此操作的输出将类似于下文（JSON 格式）。  

```
[
    "arn:aws:rds:us-east-1:123456789012:cluster-pg:custom3-6-param-grp",
    "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6",
    "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.docdb3.6"
]
```

------