Beispiele für Amazon DocumentDB unter Verwendung der AWS CLI - AWS Command Line Interface
Aktionen

Beispiele für Amazon DocumentDB unter Verwendung der AWS CLI

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit Amazon DocumentDB nutzen.

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 Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie add-tags-to-resource verwendet wird.

AWS CLI

So fügen Sie der angegebenen Ressource ein oder mehrere Tags hinzu

Im folgenden add-tags-to-resource-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie apply-pending-maintenance-action verwendet wird.

AWS CLI

So sorgen Sie dafür, dass ausstehende Wartungsaktionen während des nächsten Wartungsfensters ausgeführt werden

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

Das folgende Codebeispiel zeigt, wie copy-db-cluster-parameter-group verwendet wird.

AWS CLI

So duplizieren Sie eine vorhandene DB-Cluster-Parametergruppe

Das folgende copy-db-cluster-parameter-group-Beispiel erstellt eine Kopie der Parametergruppe custom-docdb3-6 mit dem Namen custom-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 Cluster-Parametergruppe von Amazon DocumentDB im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie copy-db-cluster-snapshot verwendet wird.

AWS CLI

So erstellen Sie eine Kopie eines Snapshots

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

Das folgende Codebeispiel zeigt, wie create-db-cluster-parameter-group verwendet wird.

AWS CLI

So erstellen Sie eine Parametergruppe für einen Amazon-DocumentDB-Cluster

Im folgenden create-db-cluster-parameter-group-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie create-db-cluster-snapshot verwendet wird.

AWS CLI

So erstellen Sie einen manuellen Snapshot eines Amazon DocumentDB-Clusters

Im folgenden create-db-cluster-snapshot-Beispiel wird ein Snapshot eines Amazon-DB-Clusters mit dem Namen sample-cluster-snapshot erstellt.

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-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie create-db-cluster verwendet wird.

AWS CLI

So erstellen Sie einen Amazon-DocumentDB-Cluster

Im folgenden create-db-cluster-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

  • API-Details finden Sie unter CreateDbCluster in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-db-instance verwendet wird.

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

Das folgende Codebeispiel zeigt, wie create-db-subnet-group verwendet wird.

AWS CLI

So erstellen Sie eine Amazon-DocumentDB-Subnetzgruppe

Im folgenden create-db-subnet-group-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie delete-db-cluster-parameter-group verwendet wird.

AWS CLI

So löschen Sie eine Parametergruppe für einen Amazon-DocumentDB-Cluster

Im folgenden delete-db-cluster-parameter-group-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie delete-db-cluster-snapshot verwendet wird.

AWS CLI

So löschen Sie den Snapshot eines Amazon-DocumentDB-Clusters

Im folgenden delete-db-cluster-snapshot-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie delete-db-cluster verwendet wird.

AWS CLI

So löschen Sie einen Amazon-DocumentDB-Cluster

Im folgenden delete-db-cluster-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

  • API-Details finden Sie unter DeleteDbCluster in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-db-instance verwendet wird.

AWS CLI

So löschen Sie eine Amazon-DocumentDB-Instance

Im folgenden delete-db-instance-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie delete-db-subnet-group verwendet wird.

AWS CLI

So löschen Sie eine Amazon-DocumentDB-Subnetzgruppe

Im folgenden delete-db-subnet-group-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-db-cluster-parameter-groups verwendet wird.

AWS CLI

So sehen Sie die Details einer oder mehrerer Parametergruppen eines Amazon-DocumentDB-Clusters

Im folgenden describe-db-cluster-parameter-groups-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-db-cluster-parameters verwendet wird.

AWS CLI

So zeigen Sie die detaillierte Parameterliste für eine Parametergruppe eines Amazon-DocumentDB-Clusters an

Das folgende describe-db-cluster-parameters-Beispiel listet die Parameter für die Amazon-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 Anzeigen der Cluster-Parameter von Amazon DocumentDB im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-db-cluster-snapshot-attributes verwendet wird.

AWS CLI

So listen Sie die Attributnamen und -werte eines Amazon-DocumentDB-Snapshots auf

Im folgenden describe-db-cluster-snapshot-attributes-Beispiel 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 DescribeDBClusterSnapshotAttributes im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-db-cluster-snapshots verwendet wird.

AWS CLI

So beschreiben Sie Amazon-DocumentDB-Snapshots

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

Das folgende Codebeispiel zeigt, wie describe-db-clusters verwendet wird.

AWS CLI

So rufen Sie detaillierte Informationen über einen oder mehrere Amazon-DocumentDB-Cluster ab

Im folgenden describe-db-clusters-Beispiel 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 Describing Amazon DocumentDB Clusters im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-db-engine-versions verwendet wird.

AWS CLI

So listen Sie verfügbare Engine-Versionen von Amazon DocumentDB auf

Das folgende describe-db-engine-versions-Beispiel listet alle verfügbaren Engine-Versionen von Amazon DocumentDB 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 DescribeDBEngineVersions im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-db-instances verwendet wird.

AWS CLI

So suchen Sie Informationen über bereitgestellte Amazon-DocumentDB-Instances

Im folgenden describe-db-instances-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-db-subnet-groups verwendet wird.

AWS CLI

So rufen Sie eine Liste mit Amazon-DocumentDB-Subnetzbeschreibungen ab

Im folgenden describe-db-subnet-groups-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-engine-default-cluster-parameters verwendet wird.

AWS CLI

So beschreiben Sie die Standard-Engine- und Systemparameterinformationen für Amazon DocumentDB

Im folgenden describe-engine-default-cluster-parameters-Beispiel 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 unter DescribeEngineDefaultClusterParameters im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-event-categories verwendet wird.

AWS CLI

So beschreiben Sie alle Amazon-DocumentDB-Ereigniskategorien

Im folgenden describe-event-categories-Beispiel 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 im Entwicklerhandbuch zu Amazon DocumentDB.

Das folgende Codebeispiel zeigt, wie describe-events verwendet wird.

AWS CLI

So listen Sie Amazon-DocumentDB-Ereignisse auf

Im folgenden describe-events-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

  • API-Details finden Sie unter DescribeEvents in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-orderable-db-instance-options verwendet wird.

AWS CLI

So suchen Sie die Instance-Optionen für Amazon DocumentDB, die Sie bestellen können

Im folgenden describe-orderable-db-instance-options-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-pending-maintenance-actions verwendet wird.

AWS CLI

So listen Sie Ihre ausstehenden Amazon-DocumentDB-Wartungsaktionen auf

Im folgenden describe-pending-maintenance-actions-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie failover-db-cluster verwendet wird.

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

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So listen Sie alle Tags einer Amazon-DocumentDB-Ressource auf

Im folgenden list-tags-for-resource-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie modify-db-cluster-parameter-group verwendet wird.

AWS CLI

So ändern Sie eine Parametergruppe für einen Amazon-DocumentDB-Cluster

Im folgenden modify-db-cluster-parameter-group-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie modify-db-cluster-snapshot-attribute verwendet wird.

AWS CLI

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

Im folgenden modify-db-cluster-snapshot-attribute-Beispiel 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 modify-db-cluster-snapshot-attribute-Beispiel 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 ModifyDBClusterSnapshotAttribute im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie modify-db-cluster verwendet wird.

AWS CLI

So ändern Sie einen Amazon-DocumentDB-Cluster

Im folgenden modify-db-cluster-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

  • API-Details finden Sie unter ModifyDbCluster in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie modify-db-instance verwendet wird.

AWS CLI

So ändern Sie eine Amazon-DocumentDB-Instance

Im folgenden modify-db-instance-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie modify-db-subnet-group verwendet wird.

AWS CLI

So ändern Sie eine Amazon-DocumentDB-Subnetzgruppe

Im folgenden modify-db-subnet-group-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie reboot-db-instance verwendet wird.

AWS CLI

So starten Sie eine Amazon-DocumentDB-Instance neu

Im folgenden reboot-db-instance-Beispiel 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 Neustarten einer Amazon-DocumentDB-Instance im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie remove-tags-from-resource verwendet wird.

AWS CLI

So entfernen Sie Tags aus einer Amazon-DocumentDB-Ressource

Im folgenden remove-tags-from-resource-Beispiel 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 für eine Amazon-DocumentDB-Ressource im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie reset-db-cluster-parameter-group verwendet wird.

AWS CLI

So setzen Sie den angegebenen Parameterwert in einer Amazon-DocumentDB-Parametergruppe auf den Standardwert zurück

Im folgenden reset-db-cluster-parameter-group-Beispiel 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 Amazon-DocumentDB-Entwicklerhandbuch.

So setzen Sie den angegebenen oder alle Parameterwerte in einer Amazon-DocumentDB-Parametergruppe auf die Standardwerte zurück

Im folgenden reset-db-cluster-parameter-group-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie restore-db-cluster-from-snapshot verwendet wird.

AWS CLI

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

Im folgenden restore-db-cluster-from-snapshot-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie restore-db-cluster-to-point-in-time verwendet wird.

AWS CLI

So stellen Sie einen Amazon-DocumentDB-Cluster anhand eines manuellen Snapshots auf einen bestimmten Zeitpunkt wieder her

Im folgenden restore-db-cluster-to-point-in-time-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie start-db-cluster verwendet wird.

AWS CLI

So starten Sie einen angehaltenen Amazon-DocumentDB-Cluster

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

  • API-Details finden Sie unter StartDbCluster in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie stop-db-cluster verwendet wird.

AWS CLI

So halten Sie einen laufenden Amazon-DocumentDB-Cluster an

Im folgenden stop-db-cluster-Beispiel 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 im Amazon-DocumentDB-Entwicklerhandbuch.

  • API-Details finden Sie unter StopDbCluster in der AWS CLI-Befehlsreferenz.