View a markdown version of this page

Grundlegendes zu Amazon DocumentDB Amazon-Ressourcennamen (ARNs) - Amazon DocumentDB

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Grundlegendes zu Amazon DocumentDB Amazon-Ressourcennamen (ARNs)

Ressourcen, die Sie erstellen in AWS sind jeweils eindeutig mit einem Amazon-Ressourcennamen (ARN) identifiziert. Für bestimmte Amazon DocumentDB-Operationen (mit MongoDB-Kompatibilität) müssen Sie eine Amazon DocumentDB-Ressource eindeutig identifizieren, indem Sie ihren ARN angeben. Wenn Sie beispielsweise ein Tag zu einer Ressource hinzufügen, müssen Sie den ARN der Ressource angeben.

Erstellung eines ARN für eine Amazon DocumentDB-Ressource

Sie können einen ARN für eine Amazon DocumentDB-Ressource mithilfe der folgenden Syntax erstellen. Amazon DocumentDB verwendet das Format der ARNs von Amazon Relational Database Service (Amazon RDS). Amazon DocumentDB-ARNs enthalten rds und nicht docdb.

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

Name der Region Region Verfügbarkeitszonen (berechnen)

USA Ost (Ohio)

us-east-2

3

USA Ost (Nord-Virginia)

us-east-1

6

USA West (Oregon)

us-west-2

4

Afrika (Kapstadt)

af-south-1

3

Südamerika (São Paulo)

sa-east-1

3

Asien-Pazifik (Hongkong)

ap-east-1

3

Asien-Pazifik (Hyderabad)

ap-south-2

3

Asien-Pazifik (Malaysia)

ap-southeast-5

3

Asien-Pazifik (Mumbai)

ap-south-1

3

Asien-Pazifik (Osaka)

ap-northeast-3

3

Asien-Pazifik (Seoul)

ap-northeast-2

4

Asien-Pazifik (Singapur)

ap-southeast-1

3

Asien-Pazifik (Sydney)

ap-southeast-2

3

Asien-Pazifik (Jakarta)

ap-southeast-3

3

Asien-Pazifik (Melbourne)

ap-southeast-4

3

Asien-Pazifik (Thailand)

ap-southeast-7

3

Asien-Pazifik (Tokio)

ap-northeast-1

3

Kanada (Zentral)

ca-central-1

3

Kanada West (Calgary)

ca-west-1

3

Region China (Peking)

cn-north-1

3

China (Ningxia)

cn-northwest-1

3

Europa (Frankfurt)

eu-central-1

3

Europa (Zürich)

eu-central-2

3

Europa (Irland)

eu-west-1

3

Europa (London)

eu-west-2

3

Europa (Milan)

eu-south-1

3

Europa (Paris)

eu-west-3

3

Europa (Spain)

eu-south-2

3

Europa (Stockholm)

eu-north-1

3

Mexiko (Zentral)

mx-central-1

3

Naher Osten (VAE)

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

Anmerkung

Die Amazon DocumentDB-Architektur trennt Speicher und Rechenleistung. Für die Speicherebene repliziert Amazon DocumentDB sechs Kopien Ihrer Daten auf drei AWS Availability Zones (AZs). Die in der obigen Tabelle aufgeführten AZs geben die Anzahl der AZs an, die Sie in einer bestimmten Region zur Bereitstellung von Recheninstanzen verwenden können. Wenn Sie beispielsweise einen Amazon DocumentDB-Cluster in ap-northeast-1 starten, wird Ihr Speicher sechsmal über drei AZs repliziert, Ihre Recheninstanzen sind jedoch nur in zwei AZs verfügbar.

Die folgende Tabelle zeigt das Format, das Sie bei der Erstellung eines ARN für eine bestimmte Amazon DocumentDB-Ressource verwenden sollten. Amazon DocumentDB verwendet das Format der Amazon RDS-ARNs. Amazon DocumentDB-ARNs enthalten rds und nicht docdb.

Ressourcentyp ARN-Format/Beispiel

Instance (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

Cluster-Parametergruppe (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

Sicherheitsgruppe (secgrp)

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

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

Cluster-Snapshot (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

Subnetzgruppe (subgrp)

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

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

Jeder Amazon DocumentDB-Cluster hat auch eine Cluster-Ressourcen-ID, die dem Wert von DbClusterResourceId Feld (zum Beispiel cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ). Im Gegensatz zur Cluster-ID ändert sich die Cluster-Ressourcen-ID nicht, wenn Sie den Cluster umbenennen. Der Cluster-ARN, den Amazon DocumentDB-API-Operationen zurückgeben, wie z. B. DBClusterArn in der Ausgabe von describe-db-clusters, verwendet die Cluster-ID. Verwenden Sie diesen ARN, wenn Sie Amazon DocumentDB-API-Operationen aufrufen.

In Abrechnungsdaten, wie AWS Cost Explorer und der AWS Kosten- und Nutzungsbericht, Gebühren für einen Cluster können unter einem ARN erscheinen, der die Cluster-Ressourcen-ID in Kleinbuchstaben verwendet, zum Beispiel arn:aws:rds:us-east-1:123456789012:cluster:cluster-abcdefghijklmnopqrstuvwxyz. Um den Cluster zu finden, auf den sich der ARN bezieht, listen Sie den Bezeichner und die Ressourcen-ID jedes Ihrer Cluster auf und ordnen Sie dann die Ressourcen-ID ohne Berücksichtigung der Groß- und Kleinschreibung zu:

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

Suche nach einem ARN für eine Amazon DocumentDB-Ressource

Den ARN einer Amazon DocumentDB-Ressource finden Sie mit der AWS-Managementkonsole oder der AWS CLI.

Using the AWS-Managementkonsole

Um einen ARN über die Konsole zu suchen, navigieren Sie zu der Ressource, für die Sie einen ARN erhalten möchten, und zeigen Sie die Details für diese Ressource an.

Zum Beispiel können Sie den ARN für einen Cluster abrufen, indem Sie den Konfiguration Registerkarte auf der Cluster-Detailseite. Die ARN finden Sie in der Konfigurationen und Status Abschnitt, wie im folgenden Screenshot gezeigt.

Konsolen-Screenshot mit einem ARN im Konfigurations- und Statusbereich des Detailbereichs.
Using the AWS CLI

Um einen ARN zu erhalten, verwenden Sie den AWS CLI verwenden Sie für eine bestimmte Amazon DocumentDB-Ressource den describe Operation für diese Ressource. Die folgende Tabelle zeigt jeden AWS CLI Operation und die ARN-Eigenschaft, die zusammen mit der Operation verwendet wird, um einen ARN abzurufen.

AWS CLI Befehl ARN-Eigenschaft

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

Beispiel- ARN Ihres Clusters suchen

Das Folgende AWS CLI Die Operation findet den ARN für den Cluster sample-cluster.

Für Linux, macOS oder Unix:

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

Für Windows:

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

Die Ausgabe dieser Operation sieht in etwa folgendermaßen aus (JSON-Format).

[ "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster" ]
Beispiel- ARNs für mehrere Parametergruppen suchen

Für Linux, macOS oder Unix:

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

Für Windows:

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

Die Ausgabe dieser Operation sieht in etwa folgendermaßen aus (JSON-Format).

[ "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" ]