Weitere AWS SDK-Beispiele sind im GitHub Repo [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) verfügbar.
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.
# Amazon DocumentDB DocumentDB-Beispiele mit AWS CLI
Die folgenden Codebeispiele zeigen Ihnen, wie Sie AWS Command Line Interface mit Amazon DocumentDB Aktionen ausführen und allgemeine Szenarien implementieren.
*Aktionen* sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.
Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anweisungen zum Einrichten und Ausführen des Codes im Kodex finden.
**Topics**
+ [Aktionen](#actions)
## Aktionen
### `add-tags-to-resource`
Das folgende Codebeispiel zeigt, wie Sie`add-tags-to-resource`.
**AWS CLI**
**So fügen Sie der angegebenen Ressource ein oder mehrere Tags hinzu**
Im folgenden Beispiel für `add-tags-to-resource` werden `sample-cluster` 3 Tags hinzugefügt. Ein Tag (`CropB`) hat einen Schlüsselnamen, aber keinen Wert.
```
aws docdb add-tags-to-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
--tags Key="CropA",Value="Apple" Key="CropB" Key="CropC",Value="Corn"
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Taggen von Amazon-DocumentDB-Ressourcen](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/add-tags-to-resource.html)in der *AWS CLI Befehlsreferenz*.
### `apply-pending-maintenance-action`
Das folgende Codebeispiel zeigt die Verwendung`apply-pending-maintenance-action`.
**AWS CLI**
**So sorgen Sie dafür, dass ausstehende Wartungsaktionen während des nächsten Wartungsfensters ausgeführt werden**
Im folgenden Beispiel für `apply-pending-maintenance-action` werden alle Aktionen zur Aktualisierung des Systems während des nächsten geplanten Wartungsfensters ausgeführt.
```
aws docdb apply-pending-maintenance-action \
--resource-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
--apply-action system-update \
--opt-in-type next-maintenance
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Anwenden von Amazon-DocumentDB-Aktualisierungen](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#db-instance-updates-apply) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html)in der *AWS CLI Befehlsreferenz*.
### `copy-db-cluster-parameter-group`
Das folgende Codebeispiel zeigt die Verwendung`copy-db-cluster-parameter-group`.
**AWS CLI**
**So duplizieren Sie eine vorhandene DB-Cluster-Parametergruppe**
Im folgenden Beispiel für `copy-db-cluster-parameter-group` wird eine Kopie der Parametergruppe `custom-docdb3-6` mit dem Namen `custom-docdb3-6-copy` erstellt. Beim Kopieren werden der neuen Parametergruppe Tags hinzugefügt.
```
aws docdb copy-db-cluster-parameter-group \
--source-db-cluster-parameter-group-identifier custom-docdb3-6 \
--target-db-cluster-parameter-group-identifier custom-docdb3-6-copy \
--target-db-cluster-parameter-group-description "Copy of custom-docdb3-6" \
--tags Key="CopyNumber",Value="1" Key="Modifiable",Value="Yes"
```
Ausgabe:
```
{
"DBClusterParameterGroup": {
"DBParameterGroupFamily": "docdb3.6",
"DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:12345678901:cluster-pg:custom-docdb3-6-copy",
"DBClusterParameterGroupName": "custom-docdb3-6-copy",
"Description": "Copy of custom-docdb3-6"
}
}
```
Weitere Informationen finden Sie unter [Kopieren einer Cluster-Parametergruppe von Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-copy.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-parameter-group.html)in der *AWS CLI Befehlsreferenz*.
### `copy-db-cluster-snapshot`
Das folgende Codebeispiel zeigt die Verwendung`copy-db-cluster-snapshot`.
**AWS CLI**
**So erstellen Sie eine Kopie eines Snapshots**
Im folgenden Beispiel für `copy-db-cluster-snapshot` wird eine Kopie von `sample-cluster-snapshot` mit dem Namen `sample-cluster-snapshot-copy` erstellt. Die Kopie enthält alle Tags des Originals sowie ein neues Tag mit dem Schlüsselnamen `CopyNumber`.
```
aws docdb copy-db-cluster-snapshot \
--source-db-cluster-snapshot-identifier sample-cluster-snapshot \
--target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \
--copy-tags \
--tags Key="CopyNumber",Value="1"
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Kopieren eines Cluster-Snapshots](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-copy.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-snapshot.html)in der *AWS CLI Befehlsreferenz*.
### `create-db-cluster-parameter-group`
Das folgende Codebeispiel zeigt die Verwendung`create-db-cluster-parameter-group`.
**AWS CLI**
**So erstellen Sie eine Parametergruppe für einen Amazon-DocumentDB-Cluster**
Im folgenden Beispiel für `create-db-cluster-parameter-group` wird die DB-Cluster-Parametergruppe `sample-parameter-group` mithilfe der Familie `docdb3.6` erstellt.
```
aws docdb create-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group \
--db-parameter-group-family docdb3.6 \
--description "Sample parameter group based on docdb3.6"
```
Ausgabe:
```
{
"DBClusterParameterGroup": {
"Description": "Sample parameter group based on docdb3.6",
"DBParameterGroupFamily": "docdb3.6",
"DBClusterParameterGroupArn": "arn:aws:rds:us-west-2:123456789012:cluster-pg:sample-parameter-group",
"DBClusterParameterGroupName": "sample-parameter-group"
}
}
```
Weitere Informationen finden Sie unter [Erstellen einer Cluster-Parametergruppe in Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-parameter-group.html)in der *AWS CLI Befehlsreferenz*.
### `create-db-cluster-snapshot`
Das folgende Codebeispiel zeigt die Verwendung`create-db-cluster-snapshot`.
**AWS CLI**
**So erstellen Sie einen manuellen Snapshot eines Amazon DocumentDB-Clusters**
Im folgenden `create-db-cluster-snapshot` Beispiel wird ein Amazon-DB-Cluster-Snapshot mit dem Namen erstellt sample-cluster-snapshot.
```
aws docdb create-db-cluster-snapshot \
--db-cluster-identifier sample-cluster \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Ausgabe:
```
{
"DBClusterSnapshot": {
"MasterUsername": "master-user",
"SnapshotCreateTime": "2019-03-18T18:27:14.794Z",
"AvailabilityZones": [
"us-west-2a",
"us-west-2b",
"us-west-2c",
"us-west-2d",
"us-west-2e",
"us-west-2f"
],
"SnapshotType": "manual",
"DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
"EngineVersion": "3.6.0",
"PercentProgress": 0,
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
"Engine": "docdb",
"DBClusterIdentifier": "sample-cluster",
"Status": "creating",
"ClusterCreateTime": "2019-03-15T20:29:58.836Z",
"Port": 0,
"StorageEncrypted": false,
"VpcId": "vpc-91280df6"
}
}
```
Weitere Informationen finden Sie unter [Erstellen eines manuellen Cluster-Snapshots](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-create.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-snapshot.html)unter *AWS CLI Befehlsreferenz*.
### `create-db-cluster`
Das folgende Codebeispiel zeigt die Verwendung`create-db-cluster`.
**AWS CLI**
**So erstellen Sie einen Amazon-DocumentDB-Cluster**
Im folgenden Beispiel für `create-db-cluster` wird ein Amazon-DocumentDB-Cluster mit dem Namen `sample-cluster` im bevorzugten Wartungsfenster sonntags zwischen 20:30 Uhr und 11:00 Uhr erstellt.
```
aws docdb create-db-cluster \
--db-cluster-identifier sample-cluster \
--engine docdb \
--master-username master-user \
--master-user-password password \
--preferred-maintenance-window Sun:20:30-Sun:21:00
```
Ausgabe:
```
{
"DBCluster": {
"DBClusterParameterGroup": "default.docdb3.6",
"AssociatedRoles": [],
"DBSubnetGroup": "default",
"ClusterCreateTime": "2019-03-18T18:06:34.616Z",
"Status": "creating",
"Port": 27017,
"PreferredMaintenanceWindow": "sun:20:30-sun:21:00",
"HostedZoneId": "ZNKXH85TT8WVW",
"DBClusterMembers": [],
"Engine": "docdb",
"DBClusterIdentifier": "sample-cluster",
"PreferredBackupWindow": "10:12-10:42",
"AvailabilityZones": [
"us-west-2d",
"us-west-2f",
"us-west-2e"
],
"MasterUsername": "master-user",
"BackupRetentionPeriod": 1,
"ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"StorageEncrypted": false,
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q",
"MultiAZ": false,
"Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"EngineVersion": "3.6.0"
}
}
```
Weitere Informationen finden Sie unter [Erstellen eines Amazon-DocumentDB-Clusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-create.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster.html)in der *AWS CLI Befehlsreferenz*.
### `create-db-instance`
Das folgende Codebeispiel zeigt die Verwendung`create-db-instance`.
**AWS CLI**
**So erstellen Sie eine Instance in einem Amazon-DocumentDB-Cluster**
Mit dem folgenden `create-db-instance`-Beispielcode wird die Instance `sample-cluster-instance-2` im Amazon-DocumentDB-Cluster `sample-cluster` erstellt.
```
aws docdb create-db-instance \
--db-cluster-identifier sample-cluster \
--db-instance-class db.r4.xlarge \
--db-instance-identifier sample-cluster-instance-2 \
--engine docdb
```
Ausgabe:
```
{
"DBInstance": {
"DBInstanceStatus": "creating",
"PendingModifiedValues": {
"PendingCloudwatchLogsExports": {
"LogTypesToEnable": [
"audit"
]
}
},
"PubliclyAccessible": false,
"PreferredBackupWindow": "00:00-00:30",
"PromotionTier": 1,
"EngineVersion": "3.6.0",
"BackupRetentionPeriod": 3,
"DBInstanceIdentifier": "sample-cluster-instance-2",
"PreferredMaintenanceWindow": "tue:10:28-tue:10:58",
"StorageEncrypted": false,
"Engine": "docdb",
"DBClusterIdentifier": "sample-cluster",
"DBSubnetGroup": {
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
},
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-4e26d263"
},
{
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
},
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-afc329f4"
},
{
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
},
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-53ab3636"
},
{
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
},
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-991cb8d0"
}
],
"DBSubnetGroupDescription": "default",
"SubnetGroupStatus": "Complete",
"VpcId": "vpc-91280df6",
"DBSubnetGroupName": "default"
},
"DBInstanceClass": "db.r4.xlarge",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
],
"DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2",
"DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE"
}
}
```
Weitere Informationen finden Sie unter [Hinzufügen einer Amazon-DocumentDB-Instance zu einem Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [CreateDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-instance.html)in der *AWS CLI Befehlsreferenz*.
### `create-db-subnet-group`
Das folgende Codebeispiel zeigt die Verwendung`create-db-subnet-group`.
**AWS CLI**
**So erstellen Sie eine Amazon-DocumentDB-Subnetzgruppe**
Im folgenden Beispiel für `create-db-subnet-group` wird eine Amazon-DocumentDB-Subnetzgruppe mit dem Namen `sample-subnet-group` erstellt.
```
aws docdb create-db-subnet-group \
--db-subnet-group-description "a sample subnet group" \
--db-subnet-group-name sample-subnet-group \
--subnet-ids "subnet-29ab1025" "subnet-991cb8d0" "subnet-53ab3636"
```
Ausgabe:
```
{
"DBSubnetGroup": {
"SubnetGroupStatus": "Complete",
"DBSubnetGroupName": "sample-subnet-group",
"DBSubnetGroupDescription": "a sample subnet group",
"VpcId": "vpc-91280df6",
"DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group",
"Subnets": [
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-53ab3636",
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
}
},
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-991cb8d0",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
}
},
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-29ab1025",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
}
}
]
}
}
```
Weitere Informationen finden Sie unter [Erstellen einer Amazon-DocumentDB-Subnetzgruppe](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-create) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-subnet-group.html)in der *AWS CLI Befehlsreferenz*.
### `delete-db-cluster-parameter-group`
Das folgende Codebeispiel zeigt die Verwendung`delete-db-cluster-parameter-group`.
**AWS CLI**
**So löschen Sie eine Parametergruppe für einen Amazon-DocumentDB-Cluster**
Im folgenden Beispiel für `delete-db-cluster-parameter-group` wird die Amazon-DocumentDB-Parametergruppe `sample-parameter-group` gelöscht.
```
aws docdb delete-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Löschen einer Cluster-Parametergruppe von Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-delete.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-parameter-group.html)in der *AWS CLI Befehlsreferenz*.
### `delete-db-cluster-snapshot`
Das folgende Codebeispiel zeigt die Verwendung`delete-db-cluster-snapshot`.
**AWS CLI**
**So löschen Sie den Snapshot eines Amazon-DocumentDB-Clusters**
Im folgenden Beispiel für `delete-db-cluster-snapshot` wird der Snapshot `sample-cluster-snapshot` des Amazon-DocumentDB-Clusters gelöscht.
```
aws docdb delete-db-cluster-snapshot \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Ausgabe:
```
{
"DBClusterSnapshot": {
"DBClusterIdentifier": "sample-cluster",
"AvailabilityZones": [
"us-west-2a",
"us-west-2b",
"us-west-2c",
"us-west-2d"
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
"VpcId": "vpc-91280df6",
"DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
"EngineVersion": "3.6.0",
"Engine": "docdb",
"SnapshotCreateTime": "2019-03-18T18:27:14.794Z",
"Status": "available",
"MasterUsername": "master-user",
"ClusterCreateTime": "2019-03-15T20:29:58.836Z",
"PercentProgress": 100,
"StorageEncrypted": false,
"SnapshotType": "manual",
"Port": 0
}
}
```
Weitere Informationen finden Sie unter [Löschen eines Cluster-Snapshots](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-delete.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-snapshot.html)in der *AWS CLI Befehlsreferenz*.
### `delete-db-cluster`
Das folgende Codebeispiel zeigt die Verwendung`delete-db-cluster`.
**AWS CLI**
**So löschen Sie einen Amazon-DocumentDB-Cluster**
Im folgenden Beispiel für `delete-db-cluster` wird der Amazon-DocumentDB-Cluster `sample-cluster` gelöscht. Vor dem Löschen des Clusters wird keine Sicherungskopie erstellt. HINWEIS: Sie müssen alle dem Cluster zugeordneten Instances löschen, bevor Sie ihn entfernen können.
```
aws docdb delete-db-cluster \
--db-cluster-identifier sample-cluster \
--skip-final-snapshot
```
Ausgabe:
```
{
"DBCluster": {
"DBClusterIdentifier": "sample-cluster",
"DBSubnetGroup": "default",
"EngineVersion": "3.6.0",
"Engine": "docdb",
"LatestRestorableTime": "2019-03-18T18:07:24.610Z",
"PreferredMaintenanceWindow": "sun:20:30-sun:21:00",
"StorageEncrypted": false,
"EarliestRestorableTime": "2019-03-18T18:07:24.610Z",
"Port": 27017,
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
],
"MultiAZ": false,
"MasterUsername": "master-user",
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"Status": "available",
"PreferredBackupWindow": "10:12-10:42",
"ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"AvailabilityZones": [
"us-west-2c",
"us-west-2b",
"us-west-2a"
],
"Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q",
"ClusterCreateTime": "2019-03-18T18:06:34.616Z",
"AssociatedRoles": [],
"DBClusterParameterGroup": "default.docdb3.6",
"HostedZoneId": "ZNKXH85TT8WVW",
"BackupRetentionPeriod": 1,
"DBClusterMembers": []
}
}
```
Weitere Informationen finden Sie unter [Löschen eines Amazon-DocumentDB-Clusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-delete.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster.html)in der *AWS CLI Befehlsreferenz*.
### `delete-db-instance`
Das folgende Codebeispiel zeigt die Verwendung`delete-db-instance`.
**AWS CLI**
**So löschen Sie eine Amazon-DocumentDB-Instance**
Im folgenden Beispiel für `delete-db-instance` wird die Amazon-DocumentDB-Instance `sample-cluster-instance-2` gelöscht.
```
aws docdb delete-db-instance \
--db-instance-identifier sample-cluster-instance-2
```
Ausgabe:
```
{
"DBInstance": {
"DBSubnetGroup": {
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
},
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-4e26d263"
},
{
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
},
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-afc329f4"
},
{
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
},
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-53ab3636"
},
{
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
},
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-991cb8d0"
}
],
"DBSubnetGroupName": "default",
"DBSubnetGroupDescription": "default",
"VpcId": "vpc-91280df6",
"SubnetGroupStatus": "Complete"
},
"PreferredBackupWindow": "00:00-00:30",
"InstanceCreateTime": "2019-03-18T18:37:33.709Z",
"DBInstanceClass": "db.r4.xlarge",
"DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE",
"BackupRetentionPeriod": 3,
"Engine": "docdb",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
],
"AutoMinorVersionUpgrade": true,
"PromotionTier": 1,
"EngineVersion": "3.6.0",
"Endpoint": {
"Address": "sample-cluster-instance-2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"HostedZoneId": "ZNKXH85TT8WVW",
"Port": 27017
},
"DBInstanceIdentifier": "sample-cluster-instance-2",
"PreferredMaintenanceWindow": "tue:10:28-tue:10:58",
"EnabledCloudwatchLogsExports": [
"audit"
],
"PendingModifiedValues": {},
"DBInstanceStatus": "deleting",
"PubliclyAccessible": false,
"DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2",
"DBClusterIdentifier": "sample-cluster",
"AvailabilityZone": "us-west-2c",
"StorageEncrypted": false
}
}
```
Weitere Informationen finden Sie unter [Löschen einer Amazon-DocumentDB-Instance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-delete.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DeleteDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-instance.html)in der *AWS CLI Befehlsreferenz*.
### `delete-db-subnet-group`
Das folgende Codebeispiel zeigt die Verwendung`delete-db-subnet-group`.
**AWS CLI**
**So löschen Sie eine Amazon-DocumentDB-Subnetzgruppe**
Im folgenden Beispiel für `delete-db-subnet-group` wird die Amazon-DocumentDB-Subnetzgruppe `sample-subnet-group` gelöscht.
```
aws docdb delete-db-subnet-group \
--db-subnet-group-name sample-subnet-group
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Löschen einer Amazon-DocumentDB-Subnetzgruppe](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-delete) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-subnet-group.html)in der *AWS CLI Befehlsreferenz*.
### `describe-db-cluster-parameter-groups`
Das folgende Codebeispiel zeigt die Verwendung`describe-db-cluster-parameter-groups`.
**AWS CLI**
**So sehen Sie die Details einer oder mehrerer Parametergruppen eines Amazon-DocumentDB-Clusters**
Im folgenden Beispiel für `describe-db-cluster-parameter-groups` werden die Details für die Parametergruppe `custom3-6-param-grp` des Amazon-DocumentDB-Clusters angezeigt.
```
aws docdb describe-db-cluster-parameter-groups \
--db-cluster-parameter-group-name custom3-6-param-grp
```
Ausgabe:
```
{
"DBClusterParameterGroups": [
{
"DBParameterGroupFamily": "docdb3.6",
"DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:custom3-6-param-grp",
"Description": "Custom docdb3.6 parameter group",
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
]
}
```
Weitere Informationen finden Sie unter [Anzeigen der Cluster-Parametergruppen von Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-describe.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameter-groups.html)in der *AWS CLI Befehlsreferenz*.
### `describe-db-cluster-parameters`
Das folgende Codebeispiel zeigt die Verwendung`describe-db-cluster-parameters`.
**AWS CLI**
**So zeigen Sie die detaillierte Parameterliste für eine Parametergruppe eines Amazon-DocumentDB-Clusters an.**
Im folgenden Beispiel für `describe-db-cluster-parameters` werden die Parameter für die Amazon-DocumentDB-Parametergruppe custom3-6-param-grp aufgelistet.
```
aws docdb describe-db-cluster-parameters \
--db-cluster-parameter-group-name custom3-6-param-grp
```
Ausgabe:
```
{
"Parameters": [
{
"DataType": "string",
"ParameterName": "audit_logs",
"IsModifiable": true,
"ApplyMethod": "pending-reboot",
"Source": "system",
"ApplyType": "dynamic",
"AllowedValues": "enabled,disabled",
"Description": "Enables auditing on cluster.",
"ParameterValue": "disabled"
},
{
"DataType": "string",
"ParameterName": "tls",
"IsModifiable": true,
"ApplyMethod": "pending-reboot",
"Source": "system",
"ApplyType": "static",
"AllowedValues": "disabled,enabled",
"Description": "Config to enable/disable TLS",
"ParameterValue": "enabled"
},
{
"DataType": "string",
"ParameterName": "ttl_monitor",
"IsModifiable": true,
"ApplyMethod": "pending-reboot",
"Source": "user",
"ApplyType": "dynamic",
"AllowedValues": "disabled,enabled",
"Description": "Enables TTL Monitoring",
"ParameterValue": "enabled"
}
]
}
```
Weitere Informationen finden Sie unter [Anzeigen der Cluster-Parameter von Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameters-describe.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameters.html)in der *AWS CLI Befehlsreferenz*.
### `describe-db-cluster-snapshot-attributes`
Das folgende Codebeispiel zeigt die Verwendung`describe-db-cluster-snapshot-attributes`.
**AWS CLI**
**So listen Sie die Attributnamen und -werte eines Amazon-DocumentDB-Snapshots auf**
Im folgenden Beispiel für `describe-db-cluster-snapshot-attributes` werden die Attributnamen und -werte für den Amazon-DocumentDB-Snapshot `sample-cluster-snapshot` aufgeführt.
```
aws docdb describe-db-cluster-snapshot-attributes \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Ausgabe:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": []
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
Weitere Informationen finden Sie unter [Describe DBCluster SnapshotAttributes](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshotAttributes.html) im *Amazon DocumentDB Developer Guide*.
+ Einzelheiten zur API finden Sie [DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshot-attributes.html)in der *AWS CLI Befehlsreferenz.*
### `describe-db-cluster-snapshots`
Das folgende Codebeispiel zeigt die Verwendung`describe-db-cluster-snapshots`.
**AWS CLI**
**So beschreiben Sie Amazon-DocumentDB-Snapshots**
Im folgenden Beispiel für `describe-db-cluster-snapshots` werden Details für den Amazon-DocumentDB-Snapshot `sample-cluster-snapshot` angezeigt.
```
aws docdb describe-db-cluster-snapshots \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Ausgabe:
```
{
"DBClusterSnapshots": [
{
"AvailabilityZones": [
"us-west-2a",
"us-west-2b",
"us-west-2c",
"us-west-2d"
],
"Status": "available",
"DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
"SnapshotCreateTime": "2019-03-15T20:41:26.515Z",
"SnapshotType": "manual",
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
"DBClusterIdentifier": "sample-cluster",
"MasterUsername": "master-user",
"StorageEncrypted": false,
"VpcId": "vpc-91280df6",
"EngineVersion": "3.6.0",
"PercentProgress": 100,
"Port": 0,
"Engine": "docdb",
"ClusterCreateTime": "2019-03-15T20:29:58.836Z"
}
]
}
```
Weitere Informationen finden Sie unter [Describe DBCluster Snapshots](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshots.html) im *Amazon DocumentDB Developer Guide*.
+ Einzelheiten zur API finden Sie [DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshots.html)in der *AWS CLI Befehlsreferenz*.
### `describe-db-clusters`
Das folgende Codebeispiel zeigt die Verwendung`describe-db-clusters`.
**AWS CLI**
**So rufen Sie detaillierte Informationen über einen oder mehrere Amazon-DocumentDB-Cluster ab.**
Im folgenden Beispiel für `describe-db-clusters` werden die Details für den Amazon-DocumentDB-Cluster `sample-cluster` angezeigt. Wenn Sie den Parameter `--db-cluster-identifier` weglassen, können Sie Informationen von bis zu 100 Clustern abrufen.
```
aws docdb describe-db-clusters
--db-cluster-identifier sample-cluster
```
Ausgabe:
```
{
"DBClusters": [
{
"DBClusterParameterGroup": "default.docdb3.6",
"Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"PreferredBackupWindow": "00:00-00:30",
"DBClusterIdentifier": "sample-cluster",
"ClusterCreateTime": "2019-03-15T20:29:58.836Z",
"LatestRestorableTime": "2019-03-18T20:28:03.239Z",
"MasterUsername": "master-user",
"DBClusterMembers": [
{
"PromotionTier": 1,
"DBClusterParameterGroupStatus": "in-sync",
"IsClusterWriter": false,
"DBInstanceIdentifier": "sample-cluster"
},
{
"PromotionTier": 1,
"DBClusterParameterGroupStatus": "in-sync",
"IsClusterWriter": true,
"DBInstanceIdentifier": "sample-cluster2"
}
],
"PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"Engine": "docdb",
"ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"DBSubnetGroup": "default",
"MultiAZ": true,
"AvailabilityZones": [
"us-west-2a",
"us-west-2c",
"us-west-2b"
],
"EarliestRestorableTime": "2019-03-15T20:30:47.020Z",
"DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE",
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"BackupRetentionPeriod": 3,
"HostedZoneId": "ZNKXH85TT8WVW",
"StorageEncrypted": false,
"EnabledCloudwatchLogsExports": [
"audit"
],
"AssociatedRoles": [],
"EngineVersion": "3.6.0",
"Port": 27017,
"Status": "available"
}
]
}
```
Weitere Informationen finden Sie unter [Beschreiben von Amazon-DocumentDB-Clustern](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-view-details.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-clusters.html)in der *AWS CLI Befehlsreferenz*.
### `describe-db-engine-versions`
Das folgende Codebeispiel zeigt die Verwendung`describe-db-engine-versions`.
**AWS CLI**
**So listen Sie verfügbare Engine-Versionen von Amazon DocumentDB auf**
Im folgenden Beispiel für `describe-db-engine-versions` werden alle verfügbaren Engine-Versionen von Amazon DocumentDB aufgelistet.
```
aws docdb describe-db-engine-versions \
--engine docdb
```
Ausgabe:
```
{
"DBEngineVersions": [
{
"DBEngineVersionDescription": "DocDB version 1.0.200837",
"DBParameterGroupFamily": "docdb3.6",
"EngineVersion": "3.6.0",
"ValidUpgradeTarget": [],
"DBEngineDescription": "Amazon DocumentDB (with MongoDB compatibility)",
"SupportsLogExportsToCloudwatchLogs": true,
"Engine": "docdb",
"ExportableLogTypes": [
"audit"
]
}
]
}
```
Weitere Informationen finden Sie unter [DBEngineVersionen beschreiben](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBEngineVersions.html) im *Amazon DocumentDB Developer Guide*.
+ Einzelheiten zur API finden Sie [DescribeDbEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-engine-versions.html)in der *AWS CLI Befehlsreferenz.*
### `describe-db-instances`
Das folgende Codebeispiel zeigt die Verwendung`describe-db-instances`.
**AWS CLI**
**So suchen Sie Informationen über bereitgestellte Amazon-DocumentDB-Instances**
Im folgenden Beispiel für `describe-db-instances` werden die Details für die Amazon-DocumentDB-Instance `sample-cluster-instance` angezeigt. Wenn Sie den Parameter `--db-instance-identifier` weglassen, können Sie Informationen von bis zu 100 Instances abrufen.
```
aws docdb describe-db-instances \
--db-instance-identifier sample-cluster-instance
```
Ausgabe:
```
{
"DBInstances": [
{
"Endpoint": {
"HostedZoneId": "ZNKXH85TT8WVW",
"Address": "sample-cluster-instance.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"Port": 27017
},
"PreferredBackupWindow": "00:00-00:30",
"DBInstanceStatus": "available",
"DBInstanceClass": "db.r4.large",
"EnabledCloudwatchLogsExports": [
"audit"
],
"DBInstanceIdentifier": "sample-cluster-instance",
"DBSubnetGroup": {
"Subnets": [
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-4e26d263",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
}
},
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-afc329f4",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
}
},
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-53ab3636",
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
}
},
{
"SubnetStatus": "Active",
"SubnetIdentifier": "subnet-991cb8d0",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
}
}
],
"DBSubnetGroupName": "default",
"SubnetGroupStatus": "Complete",
"DBSubnetGroupDescription": "default",
"VpcId": "vpc-91280df6"
},
"InstanceCreateTime": "2019-03-15T20:36:06.338Z",
"Engine": "docdb",
"StorageEncrypted": false,
"AutoMinorVersionUpgrade": true,
"DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance",
"PreferredMaintenanceWindow": "tue:08:39-tue:09:09",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
],
"DBClusterIdentifier": "sample-cluster",
"PendingModifiedValues": {},
"BackupRetentionPeriod": 3,
"PubliclyAccessible": false,
"EngineVersion": "3.6.0",
"PromotionTier": 1,
"AvailabilityZone": "us-west-2c",
"DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA"
}
]
}
```
Weitere Informationen finden Sie unter [Beschreiben von Amazon-DocumentDB-Instances](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-view-details.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribeDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-instances.html)in der *AWS CLI Befehlsreferenz*.
### `describe-db-subnet-groups`
Das folgende Codebeispiel zeigt die Verwendung`describe-db-subnet-groups`.
**AWS CLI**
**So rufen Sie eine Liste mit Amazon-DocumentDB-Subnetzbeschreibungen ab**
Im folgenden Beispiel für `describe-db-subnet-groups` werden Details für das Amazon-DocumentDB-Subnetz namens `default` beschrieben.
```
aws docdb describe-db-subnet-groups \
--db-subnet-group-name default
```
Ausgabe:
```
{
"DBSubnetGroups": [
{
"VpcId": "vpc-91280df6",
"DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:default",
"Subnets": [
{
"SubnetIdentifier": "subnet-4e26d263",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
}
},
{
"SubnetIdentifier": "subnet-afc329f4",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
}
},
{
"SubnetIdentifier": "subnet-53ab3636",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
}
},
{
"SubnetIdentifier": "subnet-991cb8d0",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
}
}
],
"DBSubnetGroupName": "default",
"SubnetGroupStatus": "Complete",
"DBSubnetGroupDescription": "default"
}
]
}
```
Weitere Informationen finden Sie unter [Beschreiben von Subnetzgruppen](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-groups-describe) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-subnet-groups.html)in der *AWS CLI Befehlsreferenz*.
### `describe-engine-default-cluster-parameters`
Das folgende Codebeispiel zeigt die Verwendung`describe-engine-default-cluster-parameters`.
**AWS CLI**
**So beschreiben Sie die Standard-Engine- und Systemparameterinformationen für Amazon DocumentDB**
Im folgenden Beispiel für `describe-engine-default-cluster-parameters` werden Details zur Standard-Engine sowie Systemparameterinformationen für die Amazon-DocumentDB-Parametergruppe `docdb3.6` angezeigt.
```
aws docdb describe-engine-default-cluster-parameters \
--db-parameter-group-family docdb3.6
```
Ausgabe:
```
{
"EngineDefaults": {
"DBParameterGroupFamily": "docdb3.6",
"Parameters": [
{
"ApplyType": "dynamic",
"ParameterValue": "disabled",
"Description": "Enables auditing on cluster.",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "enabled,disabled",
"ParameterName": "audit_logs",
"IsModifiable": true
},
{
"ApplyType": "static",
"ParameterValue": "enabled",
"Description": "Config to enable/disable TLS",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "disabled,enabled",
"ParameterName": "tls",
"IsModifiable": true
},
{
"ApplyType": "dynamic",
"ParameterValue": "enabled",
"Description": "Enables TTL Monitoring",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "disabled,enabled",
"ParameterName": "ttl_monitor",
"IsModifiable": true
}
]
}
}
```
Weitere Informationen finden Sie [DescribeEngineDefaultClusterParameters](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeEngineDefaultClusterParameters.html)im *Amazon DocumentDB Developer Guide*.
+ Einzelheiten zur API finden Sie [DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-engine-default-cluster-parameters.html)in der *AWS CLI Befehlsreferenz.*
### `describe-event-categories`
Das folgende Codebeispiel zeigt die Verwendung`describe-event-categories`.
**AWS CLI**
**So beschreiben Sie alle Amazon-DocumentDB-Ereigniskategorien**
Im folgenden Beispiel für `describe-event-categories` werden alle Kategorien für den Amazon-DocumentDB-Ereignisquellentyp `db-instance` aufgelistet.
```
aws docdb describe-event-categories \
--source-type db-cluster
```
Ausgabe:
```
{
"EventCategoriesMapList": [
{
"SourceType": "db-cluster",
"EventCategories": [
"failover",
"maintenance",
"notification",
"failure"
]
}
]
}
```
Weitere Informationen finden Sie unter [Anzeigen von Ereigniskategorien](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-event-categories) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-event-categories.html)in der *AWS CLI Befehlsreferenz*.
### `describe-events`
Das folgende Codebeispiel zeigt die Verwendung`describe-events`.
**AWS CLI**
**So listen Sie Amazon-DocumentDB-Ereignisse auf**
Im folgenden Beispiel für `describe-events` werden alle Amazon-DocumentDB-Ereignisse der letzten 24 Stunden (1 440 Minuten) aufgelistet.
```
aws docdb describe-events \
--duration 1440
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben. Ausgabe:
```
{
"Events": [
{
"EventCategories": [
"failover"
],
"Message": "Started cross AZ failover to DB instance: sample-cluster",
"Date": "2019-03-18T21:36:29.807Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"SourceIdentifier": "sample-cluster",
"SourceType": "db-cluster"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance restarted",
"Date": "2019-03-18T21:36:40.793Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster",
"SourceIdentifier": "sample-cluster",
"SourceType": "db-instance"
},
{
"EventCategories": [],
"Message": "A new writer was promoted. Restarting database as a reader.",
"Date": "2019-03-18T21:36:43.873Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance restarted",
"Date": "2019-03-18T21:36:51.257Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"failover"
],
"Message": "Completed failover to DB instance: sample-cluster",
"Date": "2019-03-18T21:36:53.462Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"SourceIdentifier": "sample-cluster",
"SourceType": "db-cluster"
},
{
"Date": "2019-03-19T16:51:48.847Z",
"EventCategories": [
"configuration change"
],
"Message": "Updated parameter audit_logs to enabled with apply method pending-reboot",
"SourceIdentifier": "custom3-6-param-grp",
"SourceType": "db-parameter-group"
},
{
"EventCategories": [
"configuration change"
],
"Message": "Applying modification to database instance class",
"Date": "2019-03-19T17:55:20.095Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance shutdown",
"Date": "2019-03-19T17:56:31.127Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"configuration change"
],
"Message": "Finished applying modification to DB instance class",
"Date": "2019-03-19T18:00:45.822Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance restarted",
"Date": "2019-03-19T18:00:53.397Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance shutdown",
"Date": "2019-03-19T18:23:36.045Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance restarted",
"Date": "2019-03-19T18:23:46.209Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"Date": "2019-03-19T18:39:05.822Z",
"EventCategories": [
"configuration change"
],
"Message": "Updated parameter ttl_monitor to enabled with apply method immediate",
"SourceIdentifier": "custom3-6-param-grp",
"SourceType": "db-parameter-group"
},
{
"Date": "2019-03-19T18:39:48.067Z",
"EventCategories": [
"configuration change"
],
"Message": "Updated parameter audit_logs to disabled with apply method immediate",
"SourceIdentifier": "custom3-6-param-grp",
"SourceType": "db-parameter-group"
}
]
}
```
Weitere Informationen finden Sie unter [Anzeigen von Amazon DocumentDB-Ereignissen](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-events) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-events.html)in der *AWS CLI Befehlsreferenz*.
### `describe-orderable-db-instance-options`
Das folgende Codebeispiel zeigt die Verwendung`describe-orderable-db-instance-options`.
**AWS CLI**
**So suchen Sie die Instance-Optionen für Amazon DocumentDB, die Sie bestellen können**
Im folgenden Beispiel für `describe-orderable-db-instance-options` werden alle Instance-Optionen für Amazon DocumentDB für eine Region aufgelistet.
```
aws docdb describe-orderable-db-instance-options \
--engine docdb \
--region us-east-1
```
Ausgabe:
```
{
"OrderableDBInstanceOptions": [
{
"Vpc": true,
"AvailabilityZones": [
{
"Name": "us-east-1a"
},
{
"Name": "us-east-1b"
},
{
"Name": "us-east-1c"
},
{
"Name": "us-east-1d"
}
],
"EngineVersion": "3.6.0",
"DBInstanceClass": "db.r4.16xlarge",
"LicenseModel": "na",
"Engine": "docdb"
},
{
"Vpc": true,
"AvailabilityZones": [
{
"Name": "us-east-1a"
},
{
"Name": "us-east-1b"
},
{
"Name": "us-east-1c"
},
{
"Name": "us-east-1d"
}
}
],
"EngineVersion": "3.6.0",
"DBInstanceClass": "db.r4.2xlarge",
"LicenseModel": "na",
"Engine": "docdb"
},
{
"Vpc": true,
"AvailabilityZones": [
{
"Name": "us-east-1a"
},
{
"Name": "us-east-1b"
},
{
"Name": "us-east-1c"
},
{
"Name": "us-east-1d"
}
],
"EngineVersion": "3.6.0",
"DBInstanceClass": "db.r4.4xlarge",
"LicenseModel": "na",
"Engine": "docdb"
},
{
"Vpc": true,
"AvailabilityZones": [
{
"Name": "us-east-1a"
},
{
"Name": "us-east-1b"
},
{
"Name": "us-east-1c"
},
{
"Name": "us-east-1d"
}
],
"EngineVersion": "3.6.0",
"DBInstanceClass": "db.r4.8xlarge",
"LicenseModel": "na",
"Engine": "docdb"
},
{
"Vpc": true,
"AvailabilityZones": [
{
"Name": "us-east-1a"
},
{
"Name": "us-east-1b"
},
{
"Name": "us-east-1c"
},
{
"Name": "us-east-1d"
}
],
"EngineVersion": "3.6.0",
"DBInstanceClass": "db.r4.large",
"LicenseModel": "na",
"Engine": "docdb"
},
{
"Vpc": true,
"AvailabilityZones": [
{
"Name": "us-east-1a"
},
{
"Name": "us-east-1b"
},
{
"Name": "us-east-1c"
},
{
"Name": "us-east-1d"
}
],
"EngineVersion": "3.6.0",
"DBInstanceClass": "db.r4.xlarge",
"LicenseModel": "na",
"Engine": "docdb"
}
]
}
```
Weitere Informationen finden Sie unter [Hinzufügen einer Amazon-DocumentDB-Instance zu einem Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribeOrderableDbInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-orderable-db-instance-options.html)in der *AWS CLI Befehlsreferenz*.
### `describe-pending-maintenance-actions`
Das folgende Codebeispiel zeigt die Verwendung`describe-pending-maintenance-actions`.
**AWS CLI**
**So listen Sie Ihre ausstehenden Amazon-DocumentDB-Wartungsaktionen auf**
Im folgenden Beispiel für `describe-pending-maintenance-actions` werden alle Ihre ausstehenden Amazon-DocumentDB-Wartungsaktionen aufgelistet.
```
aws docdb describe-pending-maintenance-actions
```
Ausgabe:
```
{
"PendingMaintenanceActions": []
}
```
Weitere Informationen finden Sie unter [Warten von Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html)in der *AWS CLI Befehlsreferenz*.
### `failover-db-cluster`
Das folgende Codebeispiel zeigt die Verwendung`failover-db-cluster`.
**AWS CLI**
**So erzwingen Sie ein Failover eines Amazon-DocumentDB-Clusters auf ein Replikat**
Im folgenden Beispiel für `failover-db-cluster` wird für die primäre Instance im Amazon-DocumentDB-Cluster sample-cluster ein Failover auf ein Replikat ausgeführt.
```
aws docdb failover-db-cluster \
--db-cluster-identifier sample-cluster
```
Ausgabe:
```
{
"DBCluster": {
"AssociatedRoles": [],
"DBClusterIdentifier": "sample-cluster",
"EngineVersion": "3.6.0",
"DBSubnetGroup": "default",
"MasterUsername": "master-user",
"EarliestRestorableTime": "2019-03-15T20:30:47.020Z",
"Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"AvailabilityZones": [
"us-west-2a",
"us-west-2c",
"us-west-2b"
],
"LatestRestorableTime": "2019-03-18T21:35:23.548Z",
"PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
"PreferredBackupWindow": "00:00-00:30",
"Port": 27017,
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"StorageEncrypted": false,
"ClusterCreateTime": "2019-03-15T20:29:58.836Z",
"MultiAZ": true,
"Status": "available",
"DBClusterMembers": [
{
"DBClusterParameterGroupStatus": "in-sync",
"IsClusterWriter": false,
"DBInstanceIdentifier": "sample-cluster",
"PromotionTier": 1
},
{
"DBClusterParameterGroupStatus": "in-sync",
"IsClusterWriter": true,
"DBInstanceIdentifier": "sample-cluster2",
"PromotionTier": 2
}
],
"EnabledCloudwatchLogsExports": [
"audit"
],
"DBClusterParameterGroup": "default.docdb3.6",
"HostedZoneId": "ZNKXH85TT8WVW",
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"BackupRetentionPeriod": 3,
"DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE",
"ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"Engine": "docdb"
}
}
```
Weitere Informationen finden Sie unter [Amazon-DocumentDB-Failover](https://docs.aws.amazon.com/documentdb/latest/developerguide/failover.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [FailoverDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-db-cluster.html)in der *AWS CLI Befehlsreferenz*.
### `list-tags-for-resource`
Das folgende Codebeispiel zeigt die Verwendung`list-tags-for-resource`.
**AWS CLI**
**So listen Sie alle Tags einer Amazon-DocumentDB-Ressource auf**
Im folgenden Beispiel für `list-tags-for-resource` werden alle Tags des Amazon-DocumentDB-Clusters `sample-cluster` aufgelistet.
```
aws docdb list-tags-for-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster
```
Ausgabe:
```
{
"TagList": [
{
"Key": "A",
"Value": "ALPHA"
},
{
"Key": "B",
"Value": ""
},
{
"Key": "C",
"Value": "CHARLIE"
}
]
}
```
Weitere Informationen finden Sie unter [Auflisten von Tags für eine Amazon-DocumentDB-Ressource](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-list) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/list-tags-for-resource.html)in der *AWS CLI Befehlsreferenz*.
### `modify-db-cluster-parameter-group`
Das folgende Codebeispiel zeigt die Verwendung`modify-db-cluster-parameter-group`.
**AWS CLI**
**So ändern Sie eine Parametergruppe für einen Amazon-DocumentDB-Cluster**
Im folgenden Beispiel für `modify-db-cluster-parameter-group` wird die Parametergruppe `custom3-6-param-grp` für den Amazon-DocumentDB-Cluster geändert, indem die beiden Parameter `audit_logs` und `ttl_monitor` auf aktiviert festgelegt werden. Die Änderungen werden beim nächsten Neustart übernommen.
```
aws docdb modify-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--parameters ParameterName=audit_logs,ParameterValue=enabled,ApplyMethod=pending-reboot \
ParameterName=ttl_monitor,ParameterValue=enabled,ApplyMethod=pending-reboot
```
Ausgabe:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Weitere Informationen finden Sie unter [Ändern einer Cluster-Parametergruppe von Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-modify.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-parameter-group.html)in der *AWS CLI Befehlsreferenz*.
### `modify-db-cluster-snapshot-attribute`
Das folgende Codebeispiel zeigt die Verwendung`modify-db-cluster-snapshot-attribute`.
**AWS CLI**
**Beispiel 1: So fügen Sie einem Amazon-DocumentDB-Snapshot ein Attribut hinzu**
Im folgenden Beispiel für `modify-db-cluster-snapshot-attribute` werden dem Snapshot eines Amazon-DocumentDB-Clusters vier Attributwerte hinzugefügt.
```
aws docdb modify-db-cluster-snapshot-attribute \
--db-cluster-snapshot-identifier sample-cluster-snapshot \
--attribute-name restore \
--values-to-add 123456789011 123456789012 123456789013
```
Ausgabe:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789012",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
**Beispiel 2: So entfernen Sie Attribute von einem Amazon-DocumentDB-Snapshot**
Im folgenden Beispiel für `modify-db-cluster-snapshot-attribute` werden zwei Attributwerte von einem Snapshot eines Amazon-DocumentDB-Clusters entfernt.
```
aws docdb modify-db-cluster-snapshot-attribute \
--db-cluster-snapshot-identifier sample-cluster-snapshot \
--attribute-name restore \
--values-to-remove 123456789012
```
Ausgabe:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
Weitere Informationen finden Sie unter [Modify DBCluster SnapshotAttribute](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBClusterSnapshotAttribute.html) im *Amazon DocumentDB Developer Guide*.
+ Einzelheiten zur API finden Sie [ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-snapshot-attribute.html)in der *AWS CLI Befehlsreferenz.*
### `modify-db-cluster`
Das folgende Codebeispiel zeigt die Verwendung`modify-db-cluster`.
**AWS CLI**
**So ändern Sie einen Amazon-DocumentDB-Cluster**
Im folgenden Beispiel für `modify-db-cluster` wird der Amazon-DocumentDB-Cluster `sample-cluster` geändert, indem die Aufbewahrungsfrist für automatische Sicherungen auf 7 Tage festgelegt und die bevorzugten Fenster sowohl für Sicherungen als auch für Wartungen geändert werden. Diese Änderungen werden während des nächsten Wartungsfensters übernommen.
```
aws docdb modify-db-cluster \
--db-cluster-identifier sample-cluster \
--no-apply-immediately \
--backup-retention-period 7 \
--preferred-backup-window 18:00-18:30 \
--preferred-maintenance-window sun:20:00-sun:20:30
```
Ausgabe:
```
{
"DBCluster": {
"Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"DBClusterMembers": [
{
"DBClusterParameterGroupStatus": "in-sync",
"DBInstanceIdentifier": "sample-cluster",
"IsClusterWriter": true,
"PromotionTier": 1
},
{
"DBClusterParameterGroupStatus": "in-sync",
"DBInstanceIdentifier": "sample-cluster2",
"IsClusterWriter": false,
"PromotionTier": 2
}
],
"HostedZoneId": "ZNKXH85TT8WVW",
"StorageEncrypted": false,
"PreferredBackupWindow": "18:00-18:30",
"MultiAZ": true,
"EngineVersion": "3.6.0",
"MasterUsername": "master-user",
"ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"DBSubnetGroup": "default",
"LatestRestorableTime": "2019-03-18T22:08:13.408Z",
"EarliestRestorableTime": "2019-03-15T20:30:47.020Z",
"PreferredMaintenanceWindow": "sun:20:00-sun:20:30",
"AssociatedRoles": [],
"EnabledCloudwatchLogsExports": [
"audit"
],
"Engine": "docdb",
"DBClusterParameterGroup": "default.docdb3.6",
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"BackupRetentionPeriod": 7,
"DBClusterIdentifier": "sample-cluster",
"AvailabilityZones": [
"us-west-2a",
"us-west-2c",
"us-west-2b"
],
"Status": "available",
"DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE",
"ClusterCreateTime": "2019-03-15T20:29:58.836Z",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"Port": 27017
}
}
```
Weitere Informationen finden Sie unter [Ändern eines Amazon-DocumentDB-Clusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-modify.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster.html)in der *AWS CLI Befehlsreferenz*.
### `modify-db-instance`
Das folgende Codebeispiel zeigt die Verwendung`modify-db-instance`.
**AWS CLI**
**So ändern Sie eine Amazon-DocumentDB-Instance**
Im folgenden Beispiel für `modify-db-instance` wird die Amazon-DocumentDB-Instance `sample-cluster2` geändert, indem ihre Instance-Klasse auf `db.r4.4xlarge` und ihre Erhebungsstufe auf `5` festgelegt wird. Die Änderungen werden sofort übernommen, sind aber erst sichtbar, wenn der Instance-Status verfügbar ist.
```
aws docdb modify-db-instance \
--db-instance-identifier sample-cluster2 \
--apply-immediately \
--db-instance-class db.r4.4xlarge \
--promotion-tier 5
```
Ausgabe:
```
{
"DBInstance": {
"EngineVersion": "3.6.0",
"StorageEncrypted": false,
"DBInstanceClass": "db.r4.large",
"PreferredMaintenanceWindow": "mon:08:39-mon:09:09",
"AutoMinorVersionUpgrade": true,
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"PreferredBackupWindow": "18:00-18:30",
"EnabledCloudwatchLogsExports": [
"audit"
],
"AvailabilityZone": "us-west-2f",
"DBInstanceIdentifier": "sample-cluster2",
"InstanceCreateTime": "2019-03-15T20:36:06.338Z",
"Engine": "docdb",
"BackupRetentionPeriod": 7,
"DBSubnetGroup": {
"DBSubnetGroupName": "default",
"DBSubnetGroupDescription": "default",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetIdentifier": "subnet-4e26d263",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-afc329f4",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-53ab3636",
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-991cb8d0",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
},
"SubnetStatus": "Active"
}
],
"VpcId": "vpc-91280df6"
},
"PromotionTier": 2,
"Endpoint": {
"Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"HostedZoneId": "ZNKXH85TT8WVW",
"Port": 27017
},
"DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA",
"DBClusterIdentifier": "sample-cluster",
"DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"PendingModifiedValues": {
"DBInstanceClass": "db.r4.4xlarge"
},
"PubliclyAccessible": false,
"DBInstanceStatus": "available"
}
}
```
Weitere Informationen finden Sie unter [Ändern einer Amazon-DocumentDB-Instance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-modify.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [ModifyDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-instance.html)in der *AWS CLI Befehlsreferenz*.
### `modify-db-subnet-group`
Das folgende Codebeispiel zeigt die Verwendung`modify-db-subnet-group`.
**AWS CLI**
**So ändern Sie eine Amazon-DocumentDB-Subnetzgruppe**
Im folgenden Beispiel für `modify-db-subnet-group` wird die Subnetzgruppe `sample-subnet-group` geändert, indem die angegebenen Subnetze und eine neue Beschreibung hinzugefügt werden.
```
aws docdb modify-db-subnet-group \
--db-subnet-group-name sample-subnet-group \
--subnet-ids subnet-b3806e8f subnet-53ab3636 subnet-991cb8d0 \
--db-subnet-group-description "New subnet description"
```
Ausgabe:
```
{
"DBSubnetGroup": {
"DBSubnetGroupName": "sample-subnet-group",
"SubnetGroupStatus": "Complete",
"DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group",
"VpcId": "vpc-91280df6",
"DBSubnetGroupDescription": "New subnet description",
"Subnets": [
{
"SubnetIdentifier": "subnet-b3806e8f",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
}
},
{
"SubnetIdentifier": "subnet-53ab3636",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
}
},
{
"SubnetIdentifier": "subnet-991cb8d0",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
}
}
]
}
}
```
Weitere Informationen finden Sie unter [Ändern einer Amazon-DocumentDB-Subnetzgruppe](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-modify) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-subnet-group.html)in der *AWS CLI Befehlsreferenz*.
### `reboot-db-instance`
Das folgende Codebeispiel zeigt die Verwendung`reboot-db-instance`.
**AWS CLI**
**So starten Sie eine Amazon-DocumentDB-Instance neu**
Im folgenden Beispiel für `reboot-db-instance` wird die Amazon-DocumentDB-Instance `sample-cluster2` neu gestartet.
```
aws docdb reboot-db-instance \
--db-instance-identifier sample-cluster2
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben. Ausgabe:
```
{
"DBInstance": {
"PreferredBackupWindow": "18:00-18:30",
"DBInstanceIdentifier": "sample-cluster2",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
],
"DBSubnetGroup": {
"VpcId": "vpc-91280df6",
"Subnets": [
{
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
},
"SubnetIdentifier": "subnet-4e26d263"
},
{
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
},
"SubnetIdentifier": "subnet-afc329f4"
},
{
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
},
"SubnetIdentifier": "subnet-53ab3636"
},
{
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
},
"SubnetIdentifier": "subnet-991cb8d0"
}
],
"SubnetGroupStatus": "Complete",
"DBSubnetGroupName": "default",
"DBSubnetGroupDescription": "default"
},
"PendingModifiedValues": {},
"Endpoint": {
"Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"HostedZoneId": "ZNKXH85TT8WVW",
"Port": 27017
},
"EnabledCloudwatchLogsExports": [
"audit"
],
"StorageEncrypted": false,
"DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA",
"AutoMinorVersionUpgrade": true,
"Engine": "docdb",
"InstanceCreateTime": "2019-03-15T20:36:06.338Z",
"EngineVersion": "3.6.0",
"PromotionTier": 5,
"BackupRetentionPeriod": 7,
"DBClusterIdentifier": "sample-cluster",
"PreferredMaintenanceWindow": "mon:08:39-mon:09:09",
"PubliclyAccessible": false,
"DBInstanceClass": "db.r4.4xlarge",
"AvailabilityZone": "us-west-2d",
"DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"DBInstanceStatus": "rebooting"
}
}
```
Weitere Informationen finden Sie unter Amazon DocumentDB [Rebooting an Amazon DocumentDB ILnstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-reboot.html) *Developer* Guide.
+ *Einzelheiten zur API finden Sie in der Befehlsreferenz [RebootDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reboot-db-instance.html).AWS CLI *
### `remove-tags-from-resource`
Das folgende Codebeispiel zeigt die Verwendung`remove-tags-from-resource`.
**AWS CLI**
**So entfernen Sie Tags aus einer Amazon-DocumentDB-Ressource**
Im folgenden Beispiel für `remove-tags-from-resource` wird das Tag mit dem Schlüssel namens `B` aus dem Amazon-DocumentDB-Cluster `sample-cluster` entfernt.
```
aws docdb remove-tags-from-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
--tag-keys B
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Entfernen von Tags aus einem Amazon-Dokument DBResource im Amazon](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-remove) *DocumentDB-Entwicklerhandbuch*.
+ Einzelheiten zur API finden Sie [RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/remove-tags-from-resource.html)in der *AWS CLI Befehlsreferenz.*
### `reset-db-cluster-parameter-group`
Das folgende Codebeispiel zeigt die Verwendung`reset-db-cluster-parameter-group`.
**AWS CLI**
**So setzen Sie den angegebenen Parameterwert in einer Amazon-DocumentDB-Parametergruppe auf den Standardwert zurück**
Im folgenden Beispiel für `reset-db-cluster-parameter-group` wird der Parameter `ttl_monitor` in der Amazon-DocumentDB-Parametergruppe `custom3-6-param-grp` auf seinen Standardwert zurückgesetzt.
```
aws docdb reset-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--parameters ParameterName=ttl_monitor,ApplyMethod=immediate
```
Ausgabe:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Weitere Informationen finden Sie unter dem entsprechenden Titel im *Entwicklerhandbuch für Amazon DocumentDB*.
**So setzen Sie den angegebenen oder alle Parameterwerte in einer Amazon-DocumentDB-Parametergruppe auf die Standardwerte zurück**
Im folgenden Beispiel für `reset-db-cluster-parameter-group` werden alle Parameter in der Amazon-DocumentDB-Parametergruppe `custom3-6-param-grp` auf ihren Standardwert zurückgesetzt.
```
aws docdb reset-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--reset-all-parameters
```
Ausgabe:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Weitere Informationen finden Sie unter [Zurücksetzen einer Cluster-Parametergruppe von Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-reset.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reset-db-cluster-parameter-group.html)in der *AWS CLI Befehlsreferenz*.
### `restore-db-cluster-from-snapshot`
Das folgende Codebeispiel zeigt die Verwendung`restore-db-cluster-from-snapshot`.
**AWS CLI**
**So stellen Sie einen Amazon-DocumentDB-Cluster aus einem automatischen oder manuellen Snapshot wieder her**
Im folgenden Beispiel für `restore-db-cluster-from-snapshot` wird ein neuer Amazon-DocumentDB-Cluster mit dem Namen `sample-cluster-2019-03-16-00-01-restored` aus dem Snapshot `rds:sample-cluster-2019-03-16-00-01` erstellt.
```
aws docdb restore-db-cluster-from-snapshot \
--db-cluster-identifier sample-cluster-2019-03-16-00-01-restored \
--engine docdb \
--snapshot-identifier rds:sample-cluster-2019-03-16-00-01
```
Ausgabe:
```
{
"DBCluster": {
"ClusterCreateTime": "2019-03-19T18:45:01.857Z",
"HostedZoneId": "ZNKXH85TT8WVW",
"Engine": "docdb",
"DBClusterMembers": [],
"MultiAZ": false,
"AvailabilityZones": [
"us-west-2a",
"us-west-2c",
"us-west-2b"
],
"StorageEncrypted": false,
"ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"Port": 27017,
"PreferredBackupWindow": "00:00-00:30",
"DBSubnetGroup": "default",
"DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored",
"PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored",
"DBClusterParameterGroup": "default.docdb3.6",
"DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU",
"MasterUsername": "master-user",
"EngineVersion": "3.6.0",
"BackupRetentionPeriod": 3,
"AssociatedRoles": [],
"Status": "creating",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
]
}
}
```
Weitere Informationen finden Sie unter [Wiederherstellen aus einem Cluster-Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.restore-from-snapshot.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-from-snapshot.html)in der *AWS CLI Befehlsreferenz*.
### `restore-db-cluster-to-point-in-time`
Das folgende Codebeispiel zeigt die Verwendung`restore-db-cluster-to-point-in-time`.
**AWS CLI**
**So stellen Sie einen Amazon DocumentDB-Cluster point-in-time aus einem manuellen Snapshot wieder her**
Im folgenden Beispiel für `restore-db-cluster-to-point-in-time` wird der `sample-cluster-snapshot` verwendet, um einen neuen Amazon-DocumentDB-Cluster, `sample-cluster-pit`, zu erstellen, wobei der letzte wiederherstellbare Zeitpunkt verwendet wird.
```
aws docdb restore-db-cluster-to-point-in-time \
--db-cluster-identifier sample-cluster-pit \
--source-db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
--use-latest-restorable-time
```
Ausgabe:
```
{
"DBCluster": {
"StorageEncrypted": false,
"BackupRetentionPeriod": 3,
"MasterUsername": "master-user",
"HostedZoneId": "ZNKXH85TT8WVW",
"PreferredBackupWindow": "00:00-00:30",
"MultiAZ": false,
"DBClusterIdentifier": "sample-cluster-pit",
"DBSubnetGroup": "default",
"ClusterCreateTime": "2019-04-03T15:55:21.320Z",
"AssociatedRoles": [],
"DBClusterParameterGroup": "default.docdb3.6",
"DBClusterMembers": [],
"Status": "creating",
"AvailabilityZones": [
"us-west-2a",
"us-west-2d",
"us-west-2b"
],
"ReaderEndpoint": "sample-cluster-pit.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"Port": 27017,
"Engine": "docdb",
"EngineVersion": "3.6.0",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
"Endpoint": "sample-cluster-pit.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"DbClusterResourceId": "cluster-NLCABBXOSE2QPQ4GOLZIFWEPLM",
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-pit"
}
}
```
Weitere Informationen finden Sie unter [Wiederherstellen eines Snapshots auf einen bestimmten Zeitpunkt](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.point-in-time-recovery.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-to-point-in-time.html)in der *AWS CLI Befehlsreferenz.*
### `start-db-cluster`
Das folgende Codebeispiel zeigt die Verwendung`start-db-cluster`.
**AWS CLI**
**So starten Sie einen angehaltenen Amazon-DocumentDB-Cluster**
Im folgenden Beispiel für `start-db-cluster` wird der angegebene Amazon-DocumentDB-Cluster gestartet.
```
aws docdb start-db-cluster \
--db-cluster-identifier sample-cluster
```
Ausgabe:
```
{
"DBCluster": {
"ClusterCreateTime": "2019-03-19T18:45:01.857Z",
"HostedZoneId": "ZNKXH85TT8WVW",
"Engine": "docdb",
"DBClusterMembers": [],
"MultiAZ": false,
"AvailabilityZones": [
"us-east-1a",
"us-east-1c",
"us-east-1f"
],
"StorageEncrypted": false,
"ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
"Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
"Port": 27017,
"PreferredBackupWindow": "00:00-00:30",
"DBSubnetGroup": "default",
"DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored",
"PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored",
"DBClusterParameterGroup": "default.docdb3.6",
"DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU",
"MasterUsername": "master-user",
"EngineVersion": "3.6.0",
"BackupRetentionPeriod": 3,
"AssociatedRoles": [],
"Status": "creating",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
]
}
}
```
Weitere Informationen finden Sie unter [Anhalten und Starten eines Amazon-DocumentDB-Clusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/start-db-cluster.html)in der *AWS CLI Befehlsreferenz*.
### `stop-db-cluster`
Das folgende Codebeispiel zeigt die Verwendung`stop-db-cluster`.
**AWS CLI**
**So halten Sie einen laufenden Amazon-DocumentDB-Cluster an**
Im folgenden Beispiel für `stop-db-cluster` wird der angegebene Amazon-DocumentDB-Cluster angehalten.
```
aws docdb stop-db-cluster \
--db-cluster-identifier sample-cluster
```
Ausgabe:
```
{
"DBCluster": {
"ClusterCreateTime": "2019-03-19T18:45:01.857Z",
"HostedZoneId": "ZNKXH85TT8WVW",
"Engine": "docdb",
"DBClusterMembers": [],
"MultiAZ": false,
"AvailabilityZones": [
"us-east-1a",
"us-east-1c",
"us-east-1f"
],
"StorageEncrypted": false,
"ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
"Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
"Port": 27017,
"PreferredBackupWindow": "00:00-00:30",
"DBSubnetGroup": "default",
"DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored",
"PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored",
"DBClusterParameterGroup": "default.docdb3.6",
"DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU",
"MasterUsername": "master-user",
"EngineVersion": "3.6.0",
"BackupRetentionPeriod": 3,
"AssociatedRoles": [],
"Status": "creating",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
]
}
}
```
Weitere Informationen finden Sie unter [Anhalten und Starten eines Amazon-DocumentDB-Clusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) im *Entwicklerhandbuch für Amazon DocumentDB*.
+ Einzelheiten zur API finden Sie [StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/stop-db-cluster.html)in der *AWS CLI Befehlsreferenz*.