Comprendre les noms de ressources Amazon (ARN) Amazon DocumentDB

Les ressources que vous créez dans AWS sont toutes identifiées de manière unique par un Amazon Resource Name (ARN). Pour certaines opérations Amazon DocumentDB (compatibles avec MongoDB), vous devez identifier de manière unique une ressource Amazon DocumentDB en spécifiant son ARN. Par exemple, lorsque vous ajoutez une balise à une ressource, vous devez fournir l'ARN de la ressource.

Création d'un ARN pour une ressource Amazon DocumentDB

Vous pouvez créer un ARN pour une ressource Amazon DocumentDB en utilisant la syntaxe suivante. Amazon DocumentDB partage le format des ARNS d'Amazon Relational Database Service (Amazon RDS). Les ARN Amazon DocumentDB contiennent rds et non. docdb

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

Nom de la région	Région	Zones de disponibilité (calcul)
USA Est (Ohio)	us-east-2	3
USA Est (Virginie du Nord)	us-east-1	6
USA Ouest (Oregon)	us-west-2	4
Amérique du Sud (São Paulo)	sa-east-1	3
Asie-Pacifique (Hong Kong)	ap-east-1	3
Asie-Pacifique (Hyderabad)	ap-south-2	3
Asie-Pacifique (Mumbai)	ap-south-1	3
Asie-Pacifique (Séoul)	ap-northeast-2	4
Asie-Pacifique (Singapour)	ap-southeast-1	3
Asie-Pacifique (Sydney)	ap-southeast-2	3
Asie-Pacifique (Tokyo)	ap-northeast-1	3
Canada (Centre)	ca-central-1	3
Région Chine (Beijing)	cn-north-1	3
Chine (Ningxia)	cn-northwest-1	3
Europe (Francfort)	eu-central-1	3
Europe (Irlande)	eu-west-1	3
Europe (Londres)	eu-west-2	3
Europe (Milan)	eu-south-1	3
Europe (Paris)	eu-west-3	3
Moyen-Orient (EAU)	me-central-1	3
AWS GovCloud (US-Ouest)	us-gov-west-1	3
AWS GovCloud (USA Est)	us-gov-east-1	3

Note

L'architecture Amazon DocumentDB sépare le stockage et le calcul. Pour la couche de stockage, Amazon DocumentDB réplique six copies de vos données dans trois zones de AWS disponibilité (AZ). Les zones de disponibilité répertoriées dans le tableau ci-dessus représentent le nombre de zones que vous pouvez utiliser dans une région donnée afin d’approvisionner des instances de calcul. Par exemple, si vous lancez un cluster Amazon DocumentDB dans ap-northeast-1, votre stockage sera répliqué de six manières sur trois zones de disponibilité, mais vos instances de calcul ne seront disponibles que dans deux zones de disponibilité.

Le tableau suivant indique le format que vous devez utiliser lors de la création d'un ARN pour une ressource Amazon DocumentDB spécifique. Amazon DocumentDB partage le format d'Amazon RDS ARNS. Les ARN Amazon DocumentDB contiennent rds et non. docdb

Type de ressource	Format ARN/Exemple
Instance (db)	arn:aws:rds:region:account_number:db:resource_id arn:aws:rds:us-east-1:1234567890:db:sample-db-instance
Cluster (cluster)	arn:aws:rds:region:account_number:cluster:resource_id arn:aws:rds:us-east-1:1234567890:cluster:sample-db-cluster
Groupe de paramètres du 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
Groupe de sécurité (secgrp)	arn:aws:rds:region:account_number:secgrp:resource_id arn:aws:rds:us-east-1:1234567890:secgrp:sample-public-secgrp
Instantané du cluster (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
Groupe de sous-réseaux (subgrp)	arn:aws:rds:region:account_number:subgrp:resource_id arn:aws:rds:us-east-1:1234567890:subgrp:sample-subnet-10

Trouver un ARN de ressource Amazon DocumentDB

Vous pouvez trouver l'ARN d'une ressource Amazon DocumentDB en utilisant le AWS Management Console ou le. AWS CLI

Using the AWS Management Console

Pour trouver un ARN à l'aide de la console, accédez à la ressource pour laquelle vous souhaitez obtenir un ARN, puis consultez les détails de cette ressource.

Par exemple, vous pouvez obtenir l'ARN pour un cluster dans le volet Détails pour le cluster, comme illustré dans la capture d'écran suivante.

Using the AWS CLI

Pour obtenir un ARN en utilisant le AWS CLI pour une ressource Amazon DocumentDB particulière, utilisez l'describeopération pour cette ressource. Le tableau suivant indique chaque AWS CLI opération et la propriété ARN utilisée avec l'opération pour obtenir un ARN.

AWS CLI Commande	Propriété d'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

Exemple - Recherche de l'ARN d'un cluster

L' AWS CLI opération suivante permet de trouver l'ARN du clustersample-cluster.

Pour Linux, macOS ou Unix :

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

Pour Windows :

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

La sortie de cette opération ressemble à ceci (format JSON).

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

Exemple - Recherche des ARN pour plusieurs groupes de paramètres

Pour Linux, macOS ou Unix :

aws docdb describe-db-cluster-parameter-groups \
   --query 'DBClusterParameterGroups[*].DBClusterParameterGroupArn'

Pour Windows :

aws docdb describe-db-cluster-parameter-groups ^
   --query 'DBClusterParameterGroups[*].DBClusterParameterGroupArn'

La sortie de cette opération ressemble à ceci (format 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"
]