文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 的 Amazon DocumentDB 範例 AWS CLI
下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 Amazon DocumentDB 執行動作和實作常見案例。
*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。
每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。
**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` 範例會在下一個排定的維護時段，執行所有系統更新動作。
```
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`，並將複本命名為 `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 開發人員指南*》中的《[複製從叢集快照](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` 範例會建立名為 sample-cluster-snapshot 的 Amazon 資料庫叢集快照。
```
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"
}
}
```
如需詳細資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的 [DescribeDBClusterSnapshotAttributes](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 開發人員指南*》中的 [DescribeDBClusterSnapshots](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 開發人員指南》**中的 [DescribeDBEngineVersions](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 開發人員指南*》中的[描述引擎預設叢集參數](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 叢集參數群組**
下列 `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"
}
}
```
如需詳細資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的 [ModifyDBClusterSnapshotAttribute](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` 範例將自動備份的保留期設為 7 天，並變更備份和維護的偏好時段，藉此修改 Amazon DocumentDB 叢集 `sample-cluster`。所有變更會在下一次維護時段套用。
```
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"
}
}
```
如需詳細資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的[重新啟動 Amazon DocumentDB 執行個體](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-reboot.html)。
+ 如需 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
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的[從 Amazon DocumentDB 資源移除標籤](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**
**從手動快照將 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 開發人員指南*》中的[將快照還原至時間點](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)。