文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# 使用 Amazon DocumentDB 示例 AWS CLI
以下代码示例向您展示了如何在 Amazon DocumentDB 中 AWS Command Line Interface 使用来执行操作和实现常见场景。
*操作*是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。
每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。
**Topics**
+ [操作](#actions)
## 操作
### `add-tags-to-resource`
以下代码示例演示了如何使用 `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 资源](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/add-tags-to-resource.html)*中的。
### `apply-pending-maintenance-action`
以下代码示例演示了如何使用 `apply-pending-maintenance-action`。
**AWS CLI**
**在下一个维护时段内执行待处理的维护操作**
以下 `apply-pending-maintenance-action` 示例在下一个计划维护时段内执行所有 system-update 操作。
```
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 更新](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#db-instance-updates-apply)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html)*中的。
### `copy-db-cluster-parameter-group`
以下代码示例演示了如何使用 `copy-db-cluster-parameter-group`。
**AWS CLI**
**复制现有的数据库集群参数组**
以下 `copy-db-cluster-parameter-group` 示例复制名为 `custom-docdb3-6-copy` 的参数组 `custom-docdb3-6`。创建副本时，它会将标签添加到新的参数组中。
```
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 集群参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-copy.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-parameter-group.html)*中的。
### `copy-db-cluster-snapshot`
以下代码示例演示了如何使用 `copy-db-cluster-snapshot`。
**AWS CLI**
**复制快照**
以下 `copy-db-cluster-snapshot` 示例创建名为 `sample-cluster-snapshot-copy` 的 `sample-cluster-snapshot` 的副本。副本包含原始标签的所有标签以及带有键名 `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 开发人员指南》**中的[复制集群快照](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-copy.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-snapshot.html)*中的。
### `create-db-cluster-parameter-group`
以下代码示例演示了如何使用 `create-db-cluster-parameter-group`。
**AWS CLI**
**创建 Amazon DocumentDB 集群参数组**
以下 `create-db-cluster-parameter-group` 示例使用 `docdb3.6` 系列创建数据库集群参数组 `sample-parameter-group`。
```
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 集群参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-parameter-group.html)*中的。
### `create-db-cluster-snapshot`
以下代码示例演示了如何使用 `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 开发人员指南》**中的[创建手动集群快照](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-create.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-snapshot.html)*中的。
### `create-db-cluster`
以下代码示例演示了如何使用 `create-db-cluster`。
**AWS CLI**
**创建 Amazon DocumentDB 集群**
以下 `create-db-cluster` 示例创建一个名为 `sample-cluster` 的 Amazon DocumentDB 集群，其首选维护时段为星期日 20:30 到 11:00。
```
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 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-create.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster.html)*中的。
### `create-db-instance`
以下代码示例演示了如何使用 `create-db-instance`。
**AWS CLI**
**创建 Amazon DocumentDB 集群实例**
以下 `create-db-instance` 示例代码在 Amazon DocumentDB 集群 `sample-cluster` 中创建实例 `sample-cluster-instance-2`。
```
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 实例](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-instance.html)*中的。
### `create-db-subnet-group`
以下代码示例演示了如何使用 `create-db-subnet-group`。
**AWS CLI**
**创建 Amazon DocumentDB 子网组**
以下 `create-db-subnet-group` 示例创建一个名为 `sample-subnet-group` 的 Amazon DocumentDB 子网组。
```
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 子网组](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-create)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-subnet-group.html)*中的。
### `delete-db-cluster-parameter-group`
以下代码示例演示了如何使用 `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 集群参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-delete.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-parameter-group.html)*中的。
### `delete-db-cluster-snapshot`
以下代码示例演示了如何使用 `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 开发人员指南》**中的[删除集群快照](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-delete.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-snapshot.html)*中的。
### `delete-db-cluster`
以下代码示例演示了如何使用 `delete-db-cluster`。
**AWS CLI**
**删除 Amazon DocumentDB 集群**
以下 `delete-db-cluster` 示例删除 Amazon DocumentDB 集群。`sample-cluster`在删除集群之前，不会对其进行备份。请注意：删除前，您必须删除所有与集群关联的实例。
```
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 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-delete.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster.html)*中的。
### `delete-db-instance`
以下代码示例演示了如何使用 `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 实例](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-delete.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-instance.html)*中的。
### `delete-db-subnet-group`
以下代码示例演示了如何使用 `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 子网组](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-delete)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-subnet-group.html)*中的。
### `describe-db-cluster-parameter-groups`
以下代码示例演示了如何使用 `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 集群参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-describe.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameter-groups.html)*中的。
### `describe-db-cluster-parameters`
以下代码示例演示了如何使用 `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 集群参数](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameters-describe.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameters.html)*中的。
### `describe-db-cluster-snapshot-attributes`
以下代码示例演示了如何使用 `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"
}
}
```
有关更多信息，请参阅*亚马逊 DocumentDB 开发者*指南DBClusterSnapshotAttributes中的[描述](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshotAttributes.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshot-attributes.html)*中的。
### `describe-db-cluster-snapshots`
以下代码示例演示了如何使用 `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 开发者*指南中的[描述DBCluster快照](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshots.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshots.html)*中的。
### `describe-db-clusters`
以下代码示例演示了如何使用 `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 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-view-details.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-clusters.html)*中的。
### `describe-db-engine-versions`
以下代码示例演示了如何使用 `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 开发者*指南中的[描述DBEngine版本](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBEngineVersions.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDbEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-engine-versions.html)*中的。
### `describe-db-instances`
以下代码示例演示了如何使用 `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 实例](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-view-details.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-instances.html)*中的。
### `describe-db-subnet-groups`
以下代码示例演示了如何使用 `describe-db-subnet-groups`。
**AWS CLI**
**检索 Amazon DocumentDB 子网说明列表**
以下 `describe-db-subnet-groups` 示例描述名为 `default` 的 Amazon DocumentDB 子网的详细信息。
```
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 开发人员指南》**中的[描述子网组](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-groups-describe)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-subnet-groups.html)*中的。
### `describe-engine-default-cluster-parameters`
以下代码示例演示了如何使用 `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](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeEngineDefaultClusterParameters.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-engine-default-cluster-parameters.html)*中的。
### `describe-event-categories`
以下代码示例演示了如何使用 `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 开发人员指南》**中的[查看事件类别](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-event-categories)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-event-categories.html)*中的。
### `describe-events`
以下代码示例演示了如何使用 `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 事件](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-events)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-events.html)*中的。
### `describe-orderable-db-instance-options`
以下代码示例演示了如何使用 `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 实例](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeOrderableDbInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-orderable-db-instance-options.html)*中的。
### `describe-pending-maintenance-actions`
以下代码示例演示了如何使用 `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](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html)*中的。
### `failover-db-cluster`
以下代码示例演示了如何使用 `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 时效转移](https://docs.aws.amazon.com/documentdb/latest/developerguide/failover.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[FailoverDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-db-cluster.html)*中的。
### `list-tags-for-resource`
以下代码示例演示了如何使用 `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 资源上的标签](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-list)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/list-tags-for-resource.html)*中的。
### `modify-db-cluster-parameter-group`
以下代码示例演示了如何使用 `modify-db-cluster-parameter-group`。
**AWS CLI**
**修改 Amazon DocumentDB DB 集群参数组**
以下 `modify-db-cluster-parameter-group` 示例通过将两个参数 `audit_logs` 和 `ttl_monitor` 设置为启用来修改 Amazon DocumentDB 集群参数组 `custom3-6-param-grp`。更改将在下次重新启动时生效。
```
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 集群参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-modify.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-parameter-group.html)*中的。
### `modify-db-cluster-snapshot-attribute`
以下代码示例演示了如何使用 `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"
}
}
```
有关更多信息，请参阅*亚马逊 DocumentDB 开发者*指南DBClusterSnapshotAttribute中的[修改](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBClusterSnapshotAttribute.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-snapshot-attribute.html)*中的。
### `modify-db-cluster`
以下代码示例演示了如何使用 `modify-db-cluster`。
**AWS CLI**
**修改 Amazon DocumentDB 集群**
以下 `modify-db-cluster` 示例修改 Amazon DocumentDB 集群 `sample-cluster`，将自动备份的留存期限设为 7 天，并更改备份和维护的首选时段。所有更改将在下一个维护窗口应用。
```
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 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-modify.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster.html)*中的。
### `modify-db-instance`
以下代码示例演示了如何使用 `modify-db-instance`。
**AWS CLI**
**修改 Amazon DocumentDB 实例**
以下 `modify-db-instance` 示例修改 Amazon DocumentDB 实例 `sample-cluster2`，将其实例类更改为 `db.r4.4xlarge`，推广层更改为 `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 实例](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-modify.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-instance.html)*中的。
### `modify-db-subnet-group`
以下代码示例演示了如何使用 `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 子网组](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-modify)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-subnet-group.html)*中的。
### `reboot-db-instance`
以下代码示例演示了如何使用 `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"
}
}
```
有关更多信息，请参阅亚马逊 Document [DB 开发者指南中的重启亚马逊 ILnstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-reboot.html) Docum *entDB*。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[RebootDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reboot-db-instance.html)*中的。
### `remove-tags-from-resource`
以下代码示例演示了如何使用 `remove-tags-from-resource`。
**AWS CLI**
**从 Amazon DocumentDB 资源中移除标签**
以下 `remove-tags-from-resource` 示例从 Amazon DocumentDB 集群 `sample-cluster` 中移除键名为 `B` 的标签。
```
aws docdb remove-tags-from-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
--tag-keys B
```
此命令不生成任何输出。
有关更多信息，请参阅亚马逊 Documen [t *DB 开发者DBResource指南中的从亚马逊文档*中移除标签](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-remove)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/remove-tags-from-resource.html)*中的。
### `reset-db-cluster-parameter-group`
以下代码示例演示了如何使用 `reset-db-cluster-parameter-group`。
**AWS CLI**
**在 Amazon DocumentDB 参数组中将指定的参数值重置为默认值**
以下 `reset-db-cluster-parameter-group` 示例将 Amazon DocumentDB 参数组 `custom3-6-param-grp` 中的参数 `ttl_monitor` 重置为默认值。
```
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 集群参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-reset.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reset-db-cluster-parameter-group.html)*中的。
### `restore-db-cluster-from-snapshot`
以下代码示例演示了如何使用 `restore-db-cluster-from-snapshot`。
**AWS CLI**
**从自动或手动快照还原 Amazon DocumentDB 集群**
以下 `restore-db-cluster-from-snapshot` 示例从快照 `rds:sample-cluster-2019-03-16-00-01` 创建一个名为 `sample-cluster-2019-03-16-00-01-restored` 的新 Amazon DocumentDB 集群。
```
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 开发人员指南》**中的[从集群快照还原](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.restore-from-snapshot.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-from-snapshot.html)*中的。
### `restore-db-cluster-to-point-in-time`
以下代码示例演示了如何使用 `restore-db-cluster-to-point-in-time`。
**AWS CLI**
** point-in-time从手动快照将 Amazon DocumentDB 集群还原到**
以下 `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 开发人员指南》**中的[将快照还原到某个时间点](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.point-in-time-recovery.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-to-point-in-time.html)*中的。
### `start-db-cluster`
以下代码示例演示了如何使用 `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 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/start-db-cluster.html)*中的。
### `stop-db-cluster`
以下代码示例演示了如何使用 `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 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/stop-db-cluster.html)*中的。