View a markdown version of this page

Compreender os nomes do recursos da Amazon (ARN) do Amazon DocumentDB - Amazon DocumentDB

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Compreender os nomes do recursos da Amazon (ARN) do Amazon DocumentDB

Recursos que você cria no AWS cada um deles é identificado exclusivamente com um nome de recurso da Amazon (ARN). Para determinadas operações do Amazon DocumentDB (compatível com MongoDB), você precisará identificar exclusivamente um recurso do Amazon DocumentDB especificando seu ARN. Por exemplo, quando você adiciona uma tag a um recurso, deve fornecer o ARN do recurso.

Criar um ARN para um recurso do Amazon DocumentDB

É possível criar um ARN para um recurso do Amazon DocumentDB usando a seguinte sintaxe. O Amazon DocumentDB compartilha o formato de ARNs do Amazon Relational Database Service (Amazon RDS). Os ARNs do Amazon DocumentDB contêm rds e não docdb.

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

Nome da região Região Zonas de disponibilidade (computação)

Leste dos EUA (Ohio)

us-east-2

3

Leste dos EUA (Norte da Virgínia)

us-east-1

6

Oeste dos EUA (Oregon)

us-west-2

4

África (Cidade do Cabo)

af-south-1

3

América do Sul (São Paulo)

sa-east-1

3

Ásia-Pacífico (Hong Kong)

ap-east-1

3

Ásia-Pacífico (Hyderabad)

ap-south-2

3

Ásia-Pacífico (Malásia)

ap-southeast-5

3

Ásia-Pacífico (Mumbai)

ap-south-1

3

Ásia-Pacífico (Osaka)

ap-northeast-3

3

Ásia-Pacífico (Seul)

ap-northeast-2

4

Ásia-Pacífico (Singapura)

ap-southeast-1

3

Ásia-Pacífico (Sydney)

ap-southeast-2

3

Ásia-Pacífico (Jacarta)

ap-southeast-3

3

Ásia-Pacífico (Melbourne)

ap-southeast-4

3

Ásia-Pacífico (Tailândia)

ap-southeast-7

3

Ásia-Pacífico (Tóquio)

ap-northeast-1

3

Canadá (Central)

ca-central-1

3

Oeste do Canadá (Calgary)

ca-west-1

3

Região China (Pequim)

cn-north-1

3

China (Ningxia)

cn-northwest-1

3

Europa (Frankfurt)

eu-central-1

3

Europa (Zurique)

eu-central-2

3

Europa (Irlanda)

eu-west-1

3

Europa (Londres)

eu-west-2

3

Europa (Milão)

eu-south-1

3

Europa (Paris)

eu-west-3

3

Europa (Espanha)

eu-south-2

3

Europa (Estocolmo)

eu-north-1

3

México (Centro)

mx-central-1

3

Oriente Médio (Emirados Árabes Unidos)

me-central-1

3

Israel (Tel Aviv)

il-central-1

3

AWS GovCloud (US-West)

us-gov-west-1

3

AWS GovCloud (US-East)

us-gov-east-1

3

nota

A arquitetura do Amazon DocumentDB separa armazenamento e computação. Para a camada de armazenamento, o Amazon DocumentDB replica seis cópias de seus dados em três AWS Zonas de disponibilidade (AZs). As AZs listadas na tabela acima são o número de AZs que você pode usar em uma determinada região para provisionar instâncias de computação. Por exemplo, se você estiver executando um cluster do Amazon DocumentDB em ap-northeast-1, seu armazenamento será replicado de seis maneiras em três AZs, mas suas instâncias de computação só estarão disponíveis em duas AZs.

A tabela a seguir mostra o formato que deve ser usado para criar um ARN para um recurso específico do Amazon DocumentDB. O Amazon DocumentDB compartilha o formato de ARNs do Amazon RDS. Os ARNs do Amazon DocumentDB contêm rds e não docdb.

Tipo de recurso Formato/exemplo de ARN

Instância (db)

arn:aws:rds:region:account_number:db:resource_id

arn:aws:rds:us-east-1:123456789012:db:sample-db-instance

Cluster (cluster)

arn:aws:rds:region:account_number:cluster:resource_id

arn:aws:rds:us-east-1:123456789012:cluster:sample-db-cluster

Grupo de parâmetros do cluster (cluster-pg)

arn:aws:rds:region:account_number:cluster-pg:resource_id

arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-db-cluster-parameter-group

Grupo de segurança (secgrp)

arn:aws:rds:region:account_number:secgrp:resource_id

arn:aws:rds:us-east-1:123456789012:secgrp:sample-public-secgrp

Snapshot de cluster (cluster-snapshot)

arn:aws:rds:region:account_number:cluster-snapshot:resource_id

arn:aws:rds:us-east-1:123456789012:cluster-snapshot:sample-db-cluster-snapshot

Grupo de sub-rede (subgrp)

arn:aws:rds:region:account_number:subgrp:resource_id

arn:aws:rds:us-east-1:123456789012:subgrp:sample-subnet-10
nota

Cada cluster do Amazon DocumentDB também tem um ID de recurso de cluster, que é o valor do DbClusterResourceId campo (por exemplo, cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ). Diferentemente do identificador do cluster, o ID do recurso do cluster não muda se você renomear o cluster. O ARN do cluster que as operações da API Amazon DocumentDB retornam, como DBClusterArn na saída de describe-db-clusters, usa o identificador do cluster. Use esse ARN ao chamar as operações da API Amazon DocumentDB.

Em dados de faturamento, como AWS Cost Explorer e o AWS Relatório de custo e uso, as cobranças de um cluster podem aparecer em um ARN que usa o ID do recurso do cluster em minúsculas, por exemplo arn:aws:rds:us-east-1:123456789012:cluster:cluster-abcdefghijklmnopqrstuvwxyz. Para encontrar o cluster ao qual o ARN se refere, liste o identificador e o ID do recurso de cada um dos seus clusters e, em seguida, combine o ID do recurso independentemente do caso:

aws docdb describe-db-clusters \ --filter Name=engine,Values=docdb \ --query "DBClusters[*].[DBClusterIdentifier,DbClusterResourceId]" \ --output table

Localizar um ARN de recurso do Amazon DocumentDB

Você pode encontrar o ARN de um recurso do Amazon DocumentDB usando o Console de gerenciamento da AWS ou o AWS CLI.

Using the Console de gerenciamento da AWS

Para localizar um ARN usando o console, navegue até o recurso para o qual deseja um ARN e veja os detalhes desse recurso.

Por exemplo, é possível obter o ARN de um cluster selecionando a guia Configuração na página de detalhes do cluster. O ARN pode ser encontrado na seção Configurações e status, conforme mostrado na captura de tela a seguir.

Captura de tela do console mostrando um ARN na seção de configurações e status do painel de detalhes.
Using the AWS CLI

Para obter um ARN usando o AWS CLI para um recurso específico do Amazon DocumentDB, use o describe operação para esse recurso. A tabela a seguir mostra cada AWS CLI operação e a propriedade ARN que é usada com a operação para obter um ARN.

AWS CLI Comando Propriedade do 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

exemplo- Localização do ARN de um cluster

O seguinte AWS CLI operação localiza o ARN para o cluster sample-cluster.

Para Linux, macOS ou 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'

A saída dessa operação é semelhante ao seguinte (formato JSON).

[ "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster" ]
exemplo- Localização de ARNs para vários grupos de parâmetros

Para Linux, macOS ou Unix:

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

Para Windows:

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

A saída dessa operação é semelhante ao seguinte (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" ]