Amazon DocumentDB Amazon リソースネームについて (ARNs）

で作成したリソースは AWS 、それぞれ Amazon リソースネーム () で一意に識別されますARN。特定の Amazon DocumentDB (MongoDB 互換) オペレーションでは、 を指定して Amazon DocumentDB リソースを一意に識別する必要がありますARN。例えば、リソースにタグを追加するときは、リソースの を指定する必要がありますARN。

Amazon DocumentDB リソースARNの の構築

次の構文を使用して、Amazon DocumentDB リソースARNの を構築できます。Amazon DocumentDB は、Amazon Relational Database Service (Amazon RDS) の形式を共有しますARNS。Amazon DocumentDB ARNsには 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-east-1	3
アジアパシフィック (ハイデラバード)	ap-south-2	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
中国 (北京) リージョン	cn-north-1	3
中国 (寧夏)	cn-northwest-1	3
欧州 (フランクフルト)	eu-central-1	3
欧州 (アイルランド)	eu-west-1	3
欧州 (ロンドン)	eu-west-2	3
欧州 (ミラノ)	eu-south-1	3
欧州 (パリ)	eu-west-3	3
中東 (UAE）	me-central-1	3
AWS GovCloud （米国西部）	us-gov-west-1	3
AWS GovCloud （米国東部）	us-gov-east-1	3

注記

Amazon DocumentDB アーキテクチャは、ストレージとコンピューティングを分離します。ストレージレイヤーの場合、Amazon DocumentDB は 3 つの AWS アベイラビリティーゾーン () にデータの 6 つのコピーをレプリケートしますAZs。上記の表にAZs示されている は、特定のリージョンでコンピューティングインスタンスをプロビジョニングするためにAZs使用できる の数です。例えば、ap-northeast-1 で Amazon DocumentDB クラスターを起動する場合、ストレージは 3 つの 間で 6 つの方法でレプリケートされますAZsが、コンピューティングインスタンスは 2 つの でのみ使用できますAZs。

次の表は、特定の Amazon DocumentDB リソースARNの を構築するときに使用する形式を示しています。Amazon DocumentDB は Amazon RDS の形式を共有しますARNS。Amazon DocumentDB ARNsには 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

Amazon DocumentDB リソースARNの は、 AWS Management Console または を使用して見つけることができます AWS CLI。

Using the AWS Management Console

コンソールARNを使用して を検索するには、 ARNが必要なリソースに移動し、そのリソースの詳細を表示します。

例えば、次のスクリーンショットに示すように、ARNクラスターの詳細ペインでクラスターの を取得できます。

Using the AWS CLI

特定の Amazon DocumentDB リソース AWS CLI の 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 オペレーションでは、クラスター 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"
]

例 - 複数のパラメータグループ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"
]