使用的 Amazon DocumentDB 範例 AWS CLI

下列程式碼範例示範如何搭配 Amazon DocumentDB AWS Command Line Interface 使用來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會示範如何呼叫個別服務函數，但您可以在相關案例中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

動作

下列程式碼範例示範如何使用 add-tags-to-resource。

AWS CLI

將一或多個標籤新增至指定的資源

下列add-tags-to-resource範例會將三個標籤新增至 sample-cluster。一個標籤（CropB）具有金鑰名稱，但沒有值。


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"

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的標記 Amazon DocumentDB 資源。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 AddTagsToResource中的。 AWS CLI

下列程式碼範例示範如何使用 apply-pending-maintenance-action。

AWS CLI

若要讓待定的維護動作在下一個維護時段期間發生

下列apply-pending-maintenance-action範例會導致在下一個排定的維護時段執行所有系統更新動作。


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

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的套用 Amazon DocumentDB 更新。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 ApplyPendingMaintenanceAction中的。 AWS CLI

下列程式碼範例示範如何使用 copy-db-cluster-parameter-group。

AWS CLI

若要複製現有的資料庫叢集參數群組

下列copy-db-cluster-parameter-group範例會複製custom-docdb3-6名為的參數群組custom-docdb3-6-copy。複製時，它會將標籤新增至新的參數群組。


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"

輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的複製 Amazon DocumentDB 叢集參數群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 CopyDbClusterParameterGroup中的。 AWS CLI

下列程式碼範例示範如何使用 copy-db-cluster-snapshot。

AWS CLI

若要建立快照的副本

以下 copy-db-cluster-snapshot 範例會複製 sample-cluster-snapshot，並將複本命名為 sample-cluster-snapshot-copy。複本具有原始的所有標籤，以及具有金鑰名稱的新標籤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"

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的複製叢集快照。

如需API詳細資訊，請參閱命令參考 CopyDbClusterSnapshot中的。 AWS CLI

下列程式碼範例示範如何使用 create-db-cluster-parameter-group。

AWS CLI

建立 Amazon DocumentDB 叢集參數群組

下列create-db-cluster-parameter-group範例sample-parameter-group使用 docdb3.6 系列建立資料庫叢集參數群組。


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"

輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的建立 Amazon DocumentDB 叢集參數群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 CreateDbClusterParameterGroup中的。 AWS CLI

下列程式碼範例示範如何使用 create-db-cluster-snapshot。

AWS CLI

建立手動 Amazon DocumentDB 叢集快照

下列create-db-cluster-snapshot範例會建立名為的 Amazon 資料庫叢集快照 sample-cluster-snapshot。


aws docdb create-db-cluster-snapshot \
   --db-cluster-identifier sample-cluster \
   --db-cluster-snapshot-identifier sample-cluster-snapshot

輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的建立手動叢集快照。

如需API詳細資訊，請參閱命令參考 CreateDbClusterSnapshot中的。 AWS CLI

下列程式碼範例示範如何使用 create-db-cluster。

AWS CLI

建立 Amazon DocumentDB 叢集

下列create-db-cluster範例會在週日 20：30 至 11：00 之間建立名為的 Amazon DocumentDB 叢集，sample-cluster並以偏好的維護時段命名。


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

輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的建立 Amazon DocumentDB 叢集。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 CreateDbCluster中的。 AWS CLI

下列程式碼範例示範如何使用 create-db-instance。

AWS CLI

建立 Amazon DocumentDB 叢集執行個體

下列create-db-instance範例程式碼會在 Amazon DocumentDB 叢集 sample-cluster-instance-2 中建立執行個體sample-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

輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的將 Amazon DocumentDB 執行個體新增至叢集。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 CreateDbInstance中的。 AWS CLI

下列程式碼範例示範如何使用 create-db-subnet-group。

AWS CLI

建立 Amazon DocumentDB 子網路群組

下列create-db-subnet-group範例會建立名為的 Amazon DocumentDB 子網路群組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"

輸出：


{
    "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"
                }
            }
        ]
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的建立 Amazon DocumentDB 子網路群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 CreateDbSubnetGroup中的。 AWS CLI

下列程式碼範例示範如何使用 delete-db-cluster-parameter-group。

AWS CLI

若要刪除 Amazon DocumentDB 叢集參數群組

下列delete-db-cluster-parameter-group範例會刪除 Amazon DocumentDB 參數群組 sample-parameter-group。


aws docdb delete-db-cluster-parameter-group \
    --db-cluster-parameter-group-name sample-parameter-group

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的刪除 Amazon DocumentDB 叢集參數群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DeleteDbClusterParameterGroup中的。 AWS CLI

下列程式碼範例示範如何使用 delete-db-cluster-snapshot。

AWS CLI

若要刪除 Amazon DocumentDB 叢集快照

下列delete-db-cluster-snapshot範例會刪除 Amazon DocumentDB 叢集快照 sample-cluster-snapshot。


aws docdb delete-db-cluster-snapshot \
    --db-cluster-snapshot-identifier sample-cluster-snapshot

輸出：


{
    "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
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的刪除叢集快照。

如需API詳細資訊，請參閱命令參考 DeleteDbClusterSnapshot中的。 AWS CLI

下列程式碼範例示範如何使用 delete-db-cluster。

AWS CLI

若要刪除 Amazon DocumentDB 叢集

下列delete-db-cluster範例會刪除 Amazon DocumentDB 叢集 sample-cluster。刪除叢集之前，不會進行任何備份。NOTE：您必須先刪除與叢集相關聯的所有執行個體，才能刪除叢集。


aws docdb delete-db-cluster \
    --db-cluster-identifier sample-cluster \
    --skip-final-snapshot

輸出：


{
    "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": []
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的刪除 Amazon DocumentDB 叢集。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DeleteDbCluster中的。 AWS CLI

下列程式碼範例示範如何使用 delete-db-instance。

AWS CLI

刪除 Amazon DocumentDB 執行個體

下列delete-db-instance範例會刪除 Amazon DocumentDB 執行個體 sample-cluster-instance-2。


aws docdb delete-db-instance \
    --db-instance-identifier sample-cluster-instance-2

輸出：


{
    "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
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的刪除 Amazon DocumentDB 執行個體。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DeleteDbInstance中的。 AWS CLI

下列程式碼範例示範如何使用 delete-db-subnet-group。

AWS CLI

若要刪除 Amazon DocumentDB 子網路群組

下列delete-db-subnet-group範例會刪除 Amazon DocumentDB 子網路群組 sample-subnet-group。


aws docdb delete-db-subnet-group \
    --db-subnet-group-name sample-subnet-group

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的刪除 Amazon DocumentDB 子網路群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DeleteDbSubnetGroup中的。 AWS CLI

下列程式碼範例示範如何使用 describe-db-cluster-parameter-groups。

AWS CLI

檢視一或多個 Amazon DocumentDB 叢集參數群組的詳細資訊

下列describe-db-cluster-parameter-groups範例顯示 Amazon DocumentDB 叢集參數群組的詳細資訊custom3-6-param-grp。


aws docdb describe-db-cluster-parameter-groups \
    --db-cluster-parameter-group-name custom3-6-param-grp

輸出：


{
    "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"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的檢視 Amazon DocumentDB 叢集參數群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DescribeDbClusterParameterGroups中的。 AWS CLI

下列程式碼範例示範如何使用 describe-db-cluster-parameters。

AWS CLI

檢視 Amazon DocumentDB 叢集參數群組的詳細參數清單。

下列describe-db-cluster-parameters範例列出 Amazon DocumentDB 參數群組 custom3-6-param-grp 的參數。


aws docdb describe-db-cluster-parameters \
     --db-cluster-parameter-group-name custom3-6-param-grp

輸出：


{
    "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"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的檢視 Amazon DocumentDB 叢集參數。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DescribeDbClusterParameters中的。 AWS CLI

下列程式碼範例示範如何使用 describe-db-cluster-snapshot-attributes。

AWS CLI

列出 Amazon DocumentDB 快照屬性名稱和值

下列describe-db-cluster-snapshot-attributes範例列出 Amazon DocumentDB 快照的屬性名稱和值sample-cluster-snapshot。


aws docdb describe-db-cluster-snapshot-attributes \
    --db-cluster-snapshot-identifier sample-cluster-snapshot

輸出：


{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": []
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的 DescribeDBClusterSnapshotAttributes。

如需API詳細資訊，請參閱命令參考 DescribeDbClusterSnapshotAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 describe-db-cluster-snapshots。

AWS CLI

描述 Amazon DocumentDB 快照

下列describe-db-cluster-snapshots範例顯示 Amazon DocumentDB 快照的詳細資訊sample-cluster-snapshot。


aws docdb describe-db-cluster-snapshots \
    --db-cluster-snapshot-identifier sample-cluster-snapshot

輸出：


{
    "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"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的 D escribeDBCluster快照。

如需API詳細資訊，請參閱命令參考 DescribeDbClusterSnapshots中的。 AWS CLI

下列程式碼範例示範如何使用 describe-db-clusters。

AWS CLI

取得一或多個 Amazon DocumentDB 叢集的詳細資訊。

下列describe-db-clusters範例顯示 Amazon DocumentDB 叢集的詳細資訊sample-cluster。省略 --db-cluster-identifier 參數，您最多可以取得 100 個叢集的資訊。


aws docdb describe-db-clusters
    --db-cluster-identifier sample-cluster

輸出：


{
    "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"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的描述 Amazon DocumentDB 叢集。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DescribeDbClusters中的。 AWS CLI

下列程式碼範例示範如何使用 describe-db-engine-versions。

AWS CLI

若要列出可用的 Amazon DocumentDB 引擎版本

下列describe-db-engine-versions範例列出所有可用的 Amazon DocumentDB 引擎版本。


aws docdb describe-db-engine-versions \
    --engine docdb

輸出：


{
    "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"
            ]
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的 D escribeDBEngine版本。

如需API詳細資訊，請參閱命令參考 DescribeDbEngineVersions中的。 AWS CLI

下列程式碼範例示範如何使用 describe-db-instances。

AWS CLI

尋找已佈建 Amazon DocumentDB 執行個體的相關資訊

下列describe-db-instances範例顯示 Amazon DocumentDB 執行個體的詳細資訊sample-cluster-instance。省略 --db-instance-identifier 參數，即可取得最多 100 個執行個體的資訊。


aws docdb describe-db-instances \
    --db-instance-identifier sample-cluster-instance

輸出：


{
    "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"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的描述 Amazon DocumentDB 執行個體。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DescribeDbInstances中的。 AWS CLI

下列程式碼範例示範如何使用 describe-db-subnet-groups。

AWS CLI

擷取 Amazon DocumentDB 子網路描述的清單

下列describe-db-subnet-groups範例說明名為的 Amazon DocumentDB 子網路詳細資訊default。


aws docdb describe-db-subnet-groups \
    --db-subnet-group-name default

輸出：


{
    "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"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的描述子網路群組。

如需API詳細資訊，請參閱命令參考 DescribeDbSubnetGroups中的。 AWS CLI

下列程式碼範例示範如何使用 describe-engine-default-cluster-parameters。

AWS CLI

描述 Amazon DocumentDB 的預設引擎和系統參數資訊

下列describe-engine-default-cluster-parameters範例顯示 Amazon DocumentDB 參數群組的預設引擎和系統參數資訊的詳細資訊docdb3.6。


aws docdb describe-engine-default-cluster-parameters \
    --db-parameter-group-family docdb3.6

輸出：


{
    "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
            }
        ]
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 DescribeEngineDefaultClusterParameters 中的。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DescribeEngineDefaultClusterParameters中的。 AWS CLI

下列程式碼範例示範如何使用 describe-event-categories。

AWS CLI

描述所有 Amazon DocumentDB 事件類別

下列describe-event-categories範例列出 Amazon DocumentDB 事件來源類型的所有類別db-instance。


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

輸出：


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

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的檢視事件類別。

如需API詳細資訊，請參閱命令參考 DescribeEventCategories中的。 AWS CLI

下列程式碼範例示範如何使用 describe-events。

AWS CLI

若要列出 Amazon DocumentDB 事件

下列describe-events範例列出過去 24 小時（1440 分鐘）的所有 Amazon DocumentDB 事件。


aws docdb describe-events \
    --duration 1440

此命令不會產生輸出。輸出：


{
    "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"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的檢視 Amazon DocumentDB 事件。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DescribeEvents中的。 AWS CLI

下列程式碼範例示範如何使用 describe-orderable-db-instance-options。

AWS CLI

若要尋找您可以訂購的 Amazon DocumentDB 執行個體選項

下列describe-orderable-db-instance-options範例列出 Amazon DocumentDB 區域的所有執行個體選項。


aws docdb describe-orderable-db-instance-options \
    --engine docdb \
    --region us-east-1

輸出：


{
    "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"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的將 Amazon DocumentDB 執行個體新增至叢集。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 DescribeOrderableDbInstanceOptions中的。 AWS CLI

下列程式碼範例示範如何使用 describe-pending-maintenance-actions。

AWS CLI

列出待定的 Amazon DocumentDB 維護動作

下列describe-pending-maintenance-actions範例會列出所有待處理的 Amazon DocumentDB 維護動作。


aws docdb describe-pending-maintenance-actions

輸出：


{
    "PendingMaintenanceActions": []
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的維護 Amazon DocumentDB。

如需API詳細資訊，請參閱命令參考 DescribePendingMaintenanceActions中的。 AWS CLI

下列程式碼範例示範如何使用 failover-db-cluster。

AWS CLI

強制 Amazon DocumentDB 叢集容錯移轉至複本

下列failover-db-cluster範例會導致 Amazon DocumentDB 叢集 sample-cluster 的主要執行個體容錯移轉至複本。


aws docdb failover-db-cluster \
    --db-cluster-identifier sample-cluster

輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的 Amazon DocumentDB 容錯移轉。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 FailoverDbCluster中的。 AWS CLI

下列程式碼範例示範如何使用 list-tags-for-resource。

AWS CLI

列出 Amazon DocumentDB 資源上的所有標籤

下列list-tags-for-resource範例會列出 Amazon DocumentDB 叢集上的所有標籤sample-cluster。


aws docdb list-tags-for-resource \
    --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster

輸出：


{
    "TagList": [
        {
            "Key": "A",
            "Value": "ALPHA"
        },
        {
            "Key": "B",
            "Value": ""
        },
        {
            "Key": "C",
            "Value": "CHARLIE"
        }
    ]
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的列出 Amazon DocumentDB 資源上的標籤。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 ListTagsForResource中的。 AWS CLI

下列程式碼範例示範如何使用 modify-db-cluster-parameter-group。

AWS CLI

若要修改 Amazon DocumentDB 資料庫叢集參數群組

下列modify-db-cluster-parameter-group範例custom3-6-param-grp透過將兩個參數 ttl_monitor audit_logs和設定為已啟用，來修改 Amazon DocumentDB 叢集參數群組。變更會在下次重新啟動時套用。


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

輸出：


{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的修改 Amazon DocumentDB 叢集參數群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 ModifyDbClusterParameterGroup中的。 AWS CLI

下列程式碼範例示範如何使用 modify-db-cluster-snapshot-attribute。

AWS CLI

範例 1：將屬性新增至 Amazon DocumentDB 快照

下列modify-db-cluster-snapshot-attribute範例會將四個屬性值新增至 Amazon DocumentDB 叢集快照。


aws docdb modify-db-cluster-snapshot-attribute \
    --db-cluster-snapshot-identifier sample-cluster-snapshot \
    --attribute-name restore \
    --values-to-add 123456789011 123456789012 123456789013

輸出：


{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789011",
                    "123456789012",
                    "123456789013"
                ]
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

範例 2：從 Amazon DocumentDB 快照中移除屬性

下列modify-db-cluster-snapshot-attribute範例會從 Amazon DocumentDB 叢集快照中移除兩個屬性值。


aws docdb modify-db-cluster-snapshot-attribute \
    --db-cluster-snapshot-identifier sample-cluster-snapshot \
    --attribute-name restore \
    --values-to-remove 123456789012

輸出：


{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789011",
                    "123456789013"
                ]
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的 ModifyDBClusterSnapshotAttribute。

如需API詳細資訊，請參閱命令參考 ModifyDbClusterSnapshotAttribute中的。 AWS CLI

下列程式碼範例示範如何使用 modify-db-cluster。

AWS CLI

若要修改 Amazon DocumentDB 叢集

下列modify-db-cluster範例sample-cluster透過將自動備份的保留期設為 7 天，並變更備份和維護的偏好時段，來修改 Amazon DocumentDB 叢集。所有變更都會在下一個維護時段套用。


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

輸出：


{
    "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
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的修改 Amazon DocumentDB 叢集。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 ModifyDbCluster中的。 AWS CLI

下列程式碼範例示範如何使用 modify-db-instance。

AWS CLI

若要修改 Amazon DocumentDB 執行個體

下列modify-db-instance範例sample-cluster2會將 Amazon DocumentDB 執行個體的執行個體類別變更為 db.r4.4xlarge，並將其提升層變更為，藉此修改 Amazon DocumentDB 執行個體5。變更會立即套用，但只能在執行個體狀態可用後才能看到。


aws docdb modify-db-instance \
    --db-instance-identifier sample-cluster2 \
    --apply-immediately \
    --db-instance-class db.r4.4xlarge \
    --promotion-tier 5

輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的修改 Amazon DocumentDB 執行個體。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 ModifyDbInstance中的。 AWS CLI

下列程式碼範例示範如何使用 modify-db-subnet-group。

AWS CLI

若要修改 Amazon DocumentDB 子網路群組

下列modify-db-subnet-group範例sample-subnet-group透過新增指定的子網路和新描述來修改子網路群組。


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"

輸出：


{
    "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"
                }
            }
        ]
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的修改 Amazon DocumentDB 子網路群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 ModifyDbSubnetGroup中的。 AWS CLI

下列程式碼範例示範如何使用 reboot-db-instance。

AWS CLI

若要重新啟動 Amazon DocumentDB 執行個體

下列reboot-db-instance範例會重新啟動 Amazon DocumentDB 執行個體 sample-cluster2。


aws docdb reboot-db-instance \
    --db-instance-identifier sample-cluster2

此命令不會產生輸出。輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的重新啟動 ILnstance Amazon DocumentDB。

如需API詳細資訊，請參閱命令參考 RebootDbInstance中的。 AWS CLI

下列程式碼範例示範如何使用 remove-tags-from-resource。

AWS CLI

從 Amazon DocumentDB 資源中移除標籤

下列remove-tags-from-resource範例會從 Amazon DocumentDB B 叢集中移除名為的金鑰標籤sample-cluster。


aws docdb remove-tags-from-resource \
    --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
    --tag-keys B

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的從 Amazon D 移除標籤ocumentDBResource。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 RemoveTagsFromResource中的。 AWS CLI

下列程式碼範例示範如何使用 reset-db-cluster-parameter-group。

AWS CLI

在 Amazon DocumentDB 參數群組中將指定的參數值重設為其預設值

下列reset-db-cluster-parameter-group範例會將 Amazon DocumentDB 參數群組ttl_monitor中的參數重設custom3-6-param-grp為其預設值。


aws docdb reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --parameters ParameterName=ttl_monitor,ApplyMethod=immediate

輸出：


{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的標題。

若要在 Amazon DocumentDB 參數群組中將指定或所有參數值重設為其預設值

下列reset-db-cluster-parameter-group範例會將 Amazon DocumentDB 參數群組中的所有參數重設custom3-6-param-grp為其預設值。


aws docdb reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --reset-all-parameters

輸出：


{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的重設 Amazon DocumentDB 叢集參數群組。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 ResetDbClusterParameterGroup中的。 AWS CLI

下列程式碼範例示範如何使用 restore-db-cluster-from-snapshot。

AWS CLI

從自動或手動快照還原 Amazon DocumentDB 叢集

下列restore-db-cluster-from-snapshot範例sample-cluster-2019-03-16-00-01-restored會從快照建立名為的新 Amazon DocumentDB 叢集rds:sample-cluster-2019-03-16-00-01。


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

輸出：


{
    "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"
            }
        ]
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的從叢集快照還原。

如需API詳細資訊，請參閱命令參考 RestoreDbClusterFromSnapshot中的。 AWS CLI

下列程式碼範例示範如何使用 restore-db-cluster-to-point-in-time。

AWS CLI

從手動快照將 Amazon DocumentDB point-in-time叢集還原至

下列restore-db-cluster-to-point-in-time範例使用 sample-cluster-snapshot，使用最新的可還原時間建立新的 Amazon DocumentDB 叢集 sample-cluster-pit。


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

輸出：


{
    "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"
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南 中的將快照還原至時間點。

如需API詳細資訊，請參閱命令參考 RestoreDbClusterToPointInTime中的。 AWS CLI

下列程式碼範例示範如何使用 start-db-cluster。

AWS CLI

若要啟動已停止的 Amazon DocumentDB 叢集

下列start-db-cluster範例會啟動指定的 Amazon DocumentDB 叢集。


aws docdb start-db-cluster \
    --db-cluster-identifier sample-cluster

輸出：


{
    "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"
            }
        ]
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的停止和啟動 Amazon DocumentDB 叢集。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 StartDbCluster中的。 AWS CLI

下列程式碼範例示範如何使用 stop-db-cluster。

AWS CLI

若要停止執行中的 Amazon DocumentDB 叢集

下列stop-db-cluster範例會停止指定的 Amazon DocumentDB 叢集。


aws docdb stop-db-cluster \
    --db-cluster-identifier sample-cluster

輸出：


{
    "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"
            }
        ]
    }
}

如需詳細資訊，請參閱 Amazon DocumentDB 開發人員指南中的停止和啟動 Amazon DocumentDB 叢集。 Amazon DocumentDB

如需API詳細資訊，請參閱命令參考 StopDbCluster中的。 AWS CLI

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

AWS DMS

DynamoDB

使用 的 Amazon DocumentDB 範例 AWS CLI

主題

動作

使用的 Amazon DocumentDB 範例 AWS CLI