Descripción de nombres de recurso de Amazon (ARN) en Amazon DocumentDB

Cada uno de los recursos que cree AWS se identifica de forma única con un nombre de recurso de Amazon (ARN). Para determinadas operaciones de Amazon DocumentDB (con compatibilidad con MongoDB), debe identificar de forma inequívoca un recurso de Amazon DocumentDB mediante su ARN. Por ejemplo, cuando añade una etiqueta a un recurso, debe proporcionar el ARN del recurso.

Creación de un ARN para un recurso de Amazon DocumentDB

Puede crear un ARN para un recurso de Amazon DocumentDB utilizando la siguiente sintaxis. Amazon DocumentDB comparte el formato de los ARN de Amazon Relational Database Service (Amazon RDS). Los ARN de Amazon DocumentDB contienen rds y no docdb

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

Nombre de la región	Región	Zonas de disponibilidad (cálculo)
Este de EE. UU. (Ohio)	us-east-2	3
Este de EE. UU. (Norte de Virginia)	us-east-1	6
Oeste de EE. UU. (Oregón)	us-west-2	4
América del Sur (São Paulo)	sa-east-1	3
Asia-Pacífico (Hong Kong)	ap-east-1	3
Asia-Pacífico (Hyderabad)	ap-south-2	3
Asia-Pacífico (Bombay)	ap-south-1	3
Asia-Pacífico (Seúl)	ap-northeast-2	4
Asia-Pacífico (Singapur)	ap-southeast-1	3
Asia-Pacífico (Sídney)	ap-southeast-2	3
Asia-Pacífico (Tokio)	ap-northeast-1	3
Canadá (centro)	ca-central-1	3
Región China (Pekín)	cn-north-1	3
China (Ningxia)	cn-northwest-1	3
Europa (Fráncfort)	eu-central-1	3
Europa (Irlanda)	eu-west-1	3
Europa (Londres)	eu-west-2	3
Europa (Milán)	eu-south-1	3
Europa (París)	eu-west-3	3
Medio Oriente (EAU)	me-central-1	3
AWS GovCloud (EE. UU.-Oeste)	us-gov-west-1	3
AWS GovCloud (EE. UU.-Este)	us-gov-east-1	3

nota

La arquitectura de Amazon DocumentDB separa el almacenamiento y la computación. Para la capa de almacenamiento, Amazon DocumentDB replica seis copias de los datos en tres zonas de AWS disponibilidad (AZ). Las zonas de disponibilidad que aparecen en la tabla anterior son el número de zonas de disponibilidad que puede utilizar en una región determinada para aprovisionar las instancias de computación. Por ejemplo, si lanza un clúster de Amazon DocumentDB en ap-northeast-1, el almacenamiento se replicará de seis formas en tres zonas de disponibilidad, pero sus instancias de computación solo estarán disponibles en dos zonas de disponibilidad.

En la siguiente tabla se muestra el formato que debe utilizar al crear un ARN para un tipo de recurso concreto de Amazon DocumentDB. Amazon DocumentDB comparte el formato de los ARN de Amazon RDS. Los ARN de Amazon DocumentDB contienen rds y no docdb

Tipo de recurso	Formato de ARN / Ejemplo
Instancia (db)	arn:aws:rds:region:account_number:db:resource_id arn:aws:rds:us-east-1:1234567890:db:sample-db-instance
Clúster (cluster)	arn:aws:rds:region:account_number:cluster:resource_id arn:aws:rds:us-east-1:1234567890:cluster:sample-db-cluster
Grupo de parámetros del clúster (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
Grupo de seguridad (secgrp)	arn:aws:rds:region:account_number:secgrp:resource_id arn:aws:rds:us-east-1:1234567890:secgrp:sample-public-secgrp
Instantánea de clúster (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
Grupo de subredes (subgrp)	arn:aws:rds:region:account_number:subgrp:resource_id arn:aws:rds:us-east-1:1234567890:subgrp:sample-subnet-10

Búsqueda de un ARN de recurso de Amazon DocumentDB

Puede encontrar el ARN de un recurso de Amazon DocumentDB mediante AWS Management Console el o el. AWS CLI

Using the AWS Management Console

Para buscar un ARN mediante la consola, vaya al recurso cuyo ARN desea obtener y consulte los detalles de ese recurso.

Por ejemplo, puede obtener el ARN de un clúster en el panel Details (Detalles) del clúster, tal y como se muestra en la siguiente captura de pantalla.

Using the AWS CLI

Para obtener un ARN utilizando el AWS CLI para un recurso concreto de Amazon DocumentDB, utilice describe la operación para ese recurso. En la tabla siguiente se muestran cada AWS CLI operación y la propiedad ARN que se utiliza con la operación para obtener un ARN.

AWS CLI Comando	Propiedad 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

ejemplo - Búsqueda del ARN de un clúster

La siguiente AWS CLI operación busca el ARN del clúster. sample-cluster

Para Linux, macOS o Unix:

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

Para Windows:

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

La salida de esta operación será similar a lo que se indica a continuación (formato JSON).

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

ejemplo - Búsqueda de los ARN de varios grupos de parámetros

Para Linux, macOS o Unix:

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

Para Windows:

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

La salida de esta operación será similar a lo que se indica a continuación (formato 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"
]