Amazon DocumentDB DocumentDB-Beispiele mit AWS CLI - AWS SDK-Codebeispiele
Aktionen

Weitere AWS SDK-Beispiele sind im Repo AWS Doc SDK Examples GitHub 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 Szenarios anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zur Einrichtung und Ausführung des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt die Verwendungadd-tags-to-resource.

AWS CLI

Um einer bestimmten Ressource ein oder mehrere Tags hinzuzufügen

Im folgenden add-tags-to-resource Beispiel werden drei Tags hinzugefügtsample-cluster. 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 Tagging Amazon DocumentDB DocumentDB-Ressourcen im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungapply-pending-maintenance-action.

AWS CLI

Damit ausstehende Wartungsaktionen während des nächsten Wartungsfensters ausgeführt werden

Im folgenden apply-pending-maintenance-action Beispiel werden alle Systemaktualisierungsaktionen 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 DocumentDB-Updates im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungcopy-db-cluster-parameter-group.

AWS CLI

Um eine bestehende DB-Cluster-Parametergruppe zu duplizieren

Im folgenden copy-db-cluster-parameter-group Beispiel wird eine Kopie der Parametergruppe custom-docdb3-6 mit dem Namen erstelltcustom-docdb3-6-copy. 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 Amazon DocumentDB-Cluster-Parametergruppe im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungcopy-db-cluster-snapshot.

AWS CLI

Um eine Kopie eines Snapshots zu erstellen

Das folgende copy-db-cluster-snapshot-Beispiel erstellt eine Kopie von sample-cluster-snapshot mit dem Namen sample-cluster-snapshot-copy. Die Kopie enthält alle Tags des Originals sowie ein neues Tag mit dem SchlüsselnamenCopyNumber.

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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungcreate-db-cluster-parameter-group.

AWS CLI

So erstellen Sie eine Amazon DocumentDB-Cluster-Parametergruppe

Im folgenden create-db-cluster-parameter-group Beispiel wird die DB-Cluster-Parametergruppe sample-parameter-group mithilfe der docdb3.6 Familie 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 Creating an Amazon DocumentDB Cluster-Parametergruppe im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungcreate-db-cluster-snapshot.

AWS CLI

Um einen manuellen Amazon DocumentDB-Cluster-Snapshot zu erstellen

Das folgende create-db-cluster-snapshot Beispiel erstellt einen Amazon DB-Cluster-Snapshot mit dem Namen 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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungcreate-db-cluster.

AWS CLI

So erstellen Sie einen Amazon DocumentDB-Cluster

Das folgende create-db-cluster Beispiel erstellt einen Amazon DocumentDB-Cluster sample-cluster mit dem Namen des bevorzugten Wartungsfensters an Sonntagen zwischen 20:30 und 11:00 Uhr.

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 im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungcreate-db-instance.

AWS CLI

So erstellen Sie eine Amazon DocumentDB-Cluster-Instance

Der folgende create-db-instance Beispielcode erstellt die Instance sample-cluster-instance-2 im Amazon DocumentDB-Clustersample-cluster.

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 im Amazon DocumentDB Developer Guide.

  • Einzelheiten zur API finden Sie CreateDbInstancein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungcreate-db-subnet-group.

AWS CLI

So erstellen Sie eine Amazon DocumentDB-Subnetzgruppe

Im folgenden create-db-subnet-group Beispiel wird eine Amazon DocumentDB-Subnetzgruppe mit dem Namen erstellt. sample-subnet-group

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 Creating a Amazon DocumentDB Subnet Group im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdelete-db-cluster-parameter-group.

AWS CLI

Um eine Amazon DocumentDB-Cluster-Parametergruppe zu löschen

Im folgenden delete-db-cluster-parameter-group Beispiel wird die Amazon DocumentDB DocumentDB-Parametergruppe gelöscht. sample-parameter-group

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 Amazon DocumentDB-Cluster-Parametergruppe im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdelete-db-cluster-snapshot.

AWS CLI

Um einen Amazon DocumentDB-Cluster-Snapshot zu löschen

Im folgenden delete-db-cluster-snapshot Beispiel wird der Amazon DocumentDB-Cluster-Snapshot gelöscht. sample-cluster-snapshot

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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdelete-db-cluster.

AWS CLI

Um einen Amazon DocumentDB-Cluster zu löschen

Im folgenden delete-db-cluster Beispiel wird der Amazon DocumentDB-Cluster gelöscht. sample-cluster Vor dem Löschen des Clusters wird keine Sicherungskopie erstellt. HINWEIS: Sie müssen alle mit dem Cluster verknüpften Instanzen löschen, bevor Sie ihn löschen 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 im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdelete-db-instance.

AWS CLI

Um eine Amazon DocumentDB DocumentDB-Instance zu löschen

Im folgenden delete-db-instance Beispiel wird die Amazon DocumentDB DocumentDB-Instance gelöscht. sample-cluster-instance-2

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 DocumentDB-Instance im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdelete-db-subnet-group.

AWS CLI

Um eine Amazon DocumentDB-Subnetzgruppe zu löschen

Im folgenden delete-db-subnet-group Beispiel wird die Amazon DocumentDB-Subnetzgruppe gelöscht. sample-subnet-group

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 im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdescribe-db-cluster-parameter-groups.

AWS CLI

Um die Details einer oder mehrerer Amazon DocumentDB-Cluster-Parametergruppen anzuzeigen

Im folgenden describe-db-cluster-parameter-groups Beispiel werden Details für die Amazon DocumentDB-Cluster-Parametergruppe custom3-6-param-grp 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 Amazon DocumentDB Cluster-Parametergruppen anzeigen im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-db-cluster-parameters.

AWS CLI

Um die detaillierte Parameterliste für eine Amazon DocumentDB-Cluster-Parametergruppe anzuzeigen.

Das folgende describe-db-cluster-parameters Beispiel listet die Parameter für die Amazon DocumentDB DocumentDB-Parametergruppe custom3-6-param-grp auf.

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 Amazon DocumentDB-Cluster-Parameter anzeigen im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdescribe-db-cluster-snapshot-attributes.

AWS CLI

Um die Namen und Werte eines Amazon DocumentDB-Snapshot-Attributs aufzulisten

Das folgende describe-db-cluster-snapshot-attributes Beispiel listet die Attributnamen und -werte für den Amazon DocumentDB-Snapshot sample-cluster-snapshot auf.

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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-db-cluster-snapshots.

AWS CLI

Um Amazon DocumentDB-Snapshots zu beschreiben

Im folgenden describe-db-cluster-snapshots Beispiel 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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-db-clusters.

AWS CLI

Um detaillierte Informationen über einen oder mehrere Amazon DocumentDB-Cluster zu erhalten.

Im folgenden describe-db-clusters Beispiel werden Details für den Amazon DocumentDB-Cluster sample-cluster angezeigt. Wenn Sie den --db-cluster-identifier Parameter 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 Beschreibung von Amazon DocumentDB-Clustern im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdescribe-db-engine-versions.

AWS CLI

Um verfügbare Versionen der Amazon DocumentDB DocumentDB-Engine aufzulisten

Das folgende describe-db-engine-versions Beispiel listet alle verfügbaren Versionen der Amazon DocumentDB DocumentDB-Engine auf.

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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-db-instances.

AWS CLI

Um Informationen über bereitgestellte Amazon DocumentDB DocumentDB-Instances zu finden

Im folgenden describe-db-instances Beispiel werden Details zur Amazon DocumentDB DocumentDB-Instance sample-cluster-instance angezeigt. Wenn Sie den --db-instance-identifier Parameter weglassen, erhalten Sie Informationen zu bis zu 100 Instances.

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 Beschreibung von Amazon DocumentDB DocumentDB-Instances im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdescribe-db-subnet-groups.

AWS CLI

Um eine Liste mit Amazon DocumentDB-Subnetzbeschreibungen abzurufen

Das folgende describe-db-subnet-groups Beispiel beschreibt Details für das Amazon DocumentDB-Subnetz mit dem Namen. default

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 Beschreibung von Subnetzgruppen im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-engine-default-cluster-parameters.

AWS CLI

Um die Standard-Engine- und Systemparameterinformationen für Amazon DocumentDB zu beschreiben

Im folgenden describe-engine-default-cluster-parameters Beispiel werden Details zur Standard-Engine und Systemparameterinformationen für die Amazon DocumentDB 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 DescribeEngineDefaultClusterParametersim Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-event-categories.

AWS CLI

Um alle Amazon DocumentDB DocumentDB-Ereigniskategorien zu beschreiben

Das folgende describe-event-categories Beispiel listet alle Kategorien für den Amazon DocumentDB DocumentDB-Ereignisquellentyp db-instance auf.

aws docdb describe-event-categories \
    --source-type db-cluster

Ausgabe:

{
    "EventCategoriesMapList": [
        {
            "SourceType": "db-cluster",
            "EventCategories": [
                "failover",
                "maintenance",
                "notification",
                "failure"
            ]
        }
    ]
}

Weitere Informationen finden Sie unter Event-Kategorien anzeigen im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-events.

AWS CLI

Um Amazon DocumentDB DocumentDB-Ereignisse aufzulisten

Das folgende describe-events Beispiel listet alle Amazon DocumentDB DocumentDB-Ereignisse der letzten 24 Stunden (1440 Minuten) auf.

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 Amazon DocumentDB DocumentDB-Ereignisse anzeigen im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

  • Einzelheiten zur API finden Sie DescribeEventsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdescribe-orderable-db-instance-options.

AWS CLI

Um die Amazon DocumentDB DocumentDB-Instance-Optionen zu finden, können Sie bestellen

Das folgende describe-orderable-db-instance-options Beispiel listet alle Instance-Optionen für Amazon DocumentDB für eine Region auf.

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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-pending-maintenance-actions.

AWS CLI

Um Ihre ausstehenden Amazon DocumentDB DocumentDB-Wartungsmaßnahmen aufzulisten

Das folgende describe-pending-maintenance-actions Beispiel listet all Ihre ausstehenden Amazon DocumentDB DocumentDB-Wartungsaktionen auf.

aws docdb describe-pending-maintenance-actions

Ausgabe:

{
    "PendingMaintenanceActions": []
}

Weitere Informationen finden Sie unter Wartung von Amazon DocumentDB im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungfailover-db-cluster.

AWS CLI

So erzwingen Sie ein Failover eines Amazon DocumentDB-Clusters auf ein Replikat

Im folgenden failover-db-cluster Beispiel wird für die primäre Instance im Amazon DocumentDB-Cluster-Beispielcluster 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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendunglist-tags-for-resource.

AWS CLI

Um alle Tags in einer Amazon DocumentDB DocumentDB-Ressource aufzulisten

Das folgende list-tags-for-resource Beispiel listet alle Tags im Amazon DocumentDB-Cluster sample-cluster auf.

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 in einer Amazon DocumentDB DocumentDB-Ressource im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungmodify-db-cluster-parameter-group.

AWS CLI

So ändern Sie eine Amazon DocumentDB-DB-Cluster-Parametergruppe

Im folgenden modify-db-cluster-parameter-group Beispiel wird die Amazon DocumentDB-Cluster-Parametergruppe geändert, custom3-6-param-grp indem die beiden Parameter audit_logs und ttl_monitor auf enabled gesetzt 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 Amazon DocumentDB-Cluster-Parametergruppe im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungmodify-db-cluster-snapshot-attribute.

AWS CLI

Beispiel 1: So fügen Sie einem Amazon DocumentDB-Snapshot ein Attribut hinzu

Das folgende modify-db-cluster-snapshot-attribute Beispiel fügt einem Amazon DocumentDB-Cluster-Snapshot vier Attributwerte hinzu.

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 aus einem Amazon DocumentDB-Snapshot

Im folgenden modify-db-cluster-snapshot-attribute Beispiel werden zwei Attributwerte aus einem Amazon DocumentDB-Cluster-Snapshot 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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungmodify-db-cluster.

AWS CLI

So ändern Sie einen Amazon DocumentDB-Cluster

Im folgenden modify-db-cluster Beispiel wird der Amazon DocumentDB-Cluster geändert, sample-cluster indem die Aufbewahrungsfrist für automatische Backups auf 7 Tage festgelegt und die bevorzugten Fenster für Backups und Wartung geändert werden. Alle Änderungen werden im nächsten Wartungsfenster ü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 im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungmodify-db-instance.

AWS CLI

So ändern Sie eine Amazon DocumentDB DocumentDB-Instance

Im folgenden modify-db-instance Beispiel wird die Amazon DocumentDB DocumentDB-Instance geändert, sample-cluster2 indem ihre Instance-Klasse auf db.r4.4xlarge und ihre Promotion-Stufe auf geändert wird. 5 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 DocumentDB-Instance im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungmodify-db-subnet-group.

AWS CLI

So ändern Sie eine Amazon DocumentDB-Subnetzgruppe

Im folgenden modify-db-subnet-group Beispiel wird die Subnetzgruppe geändert, sample-subnet-group 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 im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungreboot-db-instance.

AWS CLI

Um eine Amazon DocumentDB DocumentDB-Instance neu zu starten

Im folgenden reboot-db-instance Beispiel wird die Amazon DocumentDB DocumentDB-Instance neu gestartet. sample-cluster2

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 Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungremove-tags-from-resource.

AWS CLI

So entfernen Sie Tags aus einer Amazon DocumentDB DocumentDB-Ressource

Im folgenden remove-tags-from-resource Beispiel wird das Tag mit dem Namen des Schlüssels 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 DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungreset-db-cluster-parameter-group.

AWS CLI

Um den angegebenen Parameterwert in einer Amazon DocumentDB DocumentDB-Parametergruppe auf die Standardwerte zurückzusetzen

Im folgenden reset-db-cluster-parameter-group Beispiel wird der Parameter ttl_monitor in der Amazon DocumentDB 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 im Titel im Amazon DocumentDB Developer Guide.

Um bestimmte oder alle Parameterwerte in einer Amazon DocumentDB DocumentDB-Parametergruppe auf ihre Standardwerte zurückzusetzen

Im folgenden reset-db-cluster-parameter-group Beispiel werden alle Parameter in der Amazon DocumentDB 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 Amazon DocumentDB-Cluster-Parametergruppe im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungrestore-db-cluster-from-snapshot.

AWS CLI

So stellen Sie einen Amazon DocumentDB-Cluster aus einem automatischen oder manuellen Snapshot wieder her

Das folgende restore-db-cluster-from-snapshot Beispiel erstellt einen neuen Amazon DocumentDB-Cluster, der nach sample-cluster-2019-03-16-00-01-restored dem Snapshot rds:sample-cluster-2019-03-16-00-01 benannt wird.

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 im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungrestore-db-cluster-to-point-in-time.

AWS CLI

So stellen Sie einen Amazon DocumentDB-Cluster point-in-time aus einem manuellen Snapshot auf einem wieder her

Im folgenden restore-db-cluster-to-point-in-time Beispiel wird der verwendetsample-cluster-snapshot, um einen neuen Amazon DocumentDB-Cluster zu erstellensample-cluster-pit, 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 Restoring a Snapshot to a Point in Time im Amazon DocumentDB Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungstart-db-cluster.

AWS CLI

Um einen gestoppten Amazon DocumentDB-Cluster zu starten

Im folgenden start-db-cluster Beispiel 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 Stoppen und Starten eines Amazon DocumentDB-Clusters im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

  • Einzelheiten zur API finden Sie StartDbClusterin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungstop-db-cluster.

AWS CLI

Um einen laufenden Amazon DocumentDB-Cluster zu beenden

Das folgende stop-db-cluster Beispiel stoppt den angegebenen Amazon DocumentDB-Cluster.

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 Stoppen und Starten eines Amazon DocumentDB-Clusters im Amazon DocumentDB DocumentDB-Entwicklerhandbuch.

  • Einzelheiten zur API finden Sie StopDbClusterin der AWS CLI Befehlsreferenz.