# AWS CLI를 사용한 Amazon DocumentDB 예시
다음 코드 예시에서는 Amazon DocumentDB에서 AWS Command Line Interface를 사용하여 작업을 수행하고 일반적인 시나리오를 구현하는 방법을 보여줍니다.
*작업*은 대규모 프로그램에서 발췌한 코드이며 컨텍스트에 맞춰 실행해야 합니다. 작업은 개별 서비스 함수를 직접적으로 호출하는 방법을 보여주며 관련 시나리오의 컨텍스트에 맞는 작업을 볼 수 있습니다.
각 예시에는 전체 소스 코드에 대한 링크가 포함되어 있으며, 여기에서 컨텍스트에 맞춰 코드를 설정하고 실행하는 방법에 대한 지침을 찾을 수 있습니다.
**Topics**
+ [작업](#actions)
## 작업
### `add-tags-to-resource`
다음 코드 예시에서는 `add-tags-to-resource` 코드를 사용하는 방법을 보여줍니다.
**AWS CLI**
**지정된 리소스에 하나 이상의 태그 추가**
다음 `add-tags-to-resource` 예시에서는 `sample-cluster`에 3개의 태그를 추가합니다. 키 이름은 있지만 값이 없는 태그(`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 개발자 안내서*의 [Tagging Amazon DocumentDB Resources](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 개발자 안내서*의 [Applying Amazon DocumentDB Updates](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**
**기존 DB 클러스터 파라미터 그룹을 복제하는 방법**
다음 `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 개발자 안내서*의 [Copying an Amazon DocumentDB Cluster Parameter Group](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 개발자 안내서*의 [Copying a Cluster Snapshot](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` 패밀리를 사용하여 DB 클러스터 파라미터 그룹 `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 개발자 안내서*의 [Creating an Amazon DocumentDB Cluster Parameter Group](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 DB 클러스터 스냅샷을 생성합니다.
```
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 개발자 안내서*의 [Creating a Manual Cluster Snapshot](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` 예시에서는 일요일 20:30\$111:00을 기본 유지 관리 시간으로 설정한 `sample-cluster`라는 이름의 Amazon DocumentDB 클러스터를 생성합니다.
```
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 개발자 안내서*의 [Creating an Amazon DocumentDB Cluster](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 개발자 안내서*의 [Adding an Amazon DocumentDB Instance to a Cluster](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 개발자 안내서*의 [Creating an Amazon DocumentDB Subnet Group](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 개발자 안내서*의 [Deleting an Amazon DocumentDB Cluster Parameter Group](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 개발자 안내서*의 [Deleting a Cluster Snapshot](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 개발자 안내서*의 [Deleting an Amazon DocumentDB Cluster](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 개발자 안내서*의 [Deleting an Amazon DocumentDB Instance](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 개발자 안내서*의 [Deleting an Amazon DocumentDB Subnet Group](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 개발자 안내서*의 [Viewing Amazon DocumentDB Cluster Parameter Groups](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 개발자 안내서*의 [Viewing Amazon DocumentDB Cluster Parameters](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 개발자 안내서*의 [Describing Amazon DocumentDB Clusters](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 개발자 안내서*의 [Describing Amazon DocumentDB Instances](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 개발자 안내서*의 [Describing Subnet Groups](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 개발자 안내서*의 [Viewing Event Categories](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시간(1,440분) 동안 발생한 모든 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 개발자 안내서*의 [Adding an Amazon DocumentDB Instance to a Cluster](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 개발자 안내서*의 [Maintaining 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 클러스터 샘플 클러스터의 기본 인스턴스가 복제본으로 장애 조치합니다.
```
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 Failover](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 개발자 안내서*의 [Listing Tags on an Amazon DocumentDB Resource](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 개발자 안내서*의 [Modifying an Amazon DocumentDB Cluster Parameter Group](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 클러스터 스냅샷에 4개의 속성 값을 추가합니다.
```
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 개발자 안내서*의 [Modifying an Amazon DocumentDB Cluster](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` 예시는 인스턴스 클래스를 `db.r4.4xlarge`로 변경하고 프로모션 계층을 `5`로 변경하여 Amazon DocumentDB 인스턴스 `sample-cluster2`를 수정합니다. 변경 사항은 즉시 적용되지만 인스턴스 상태를 사용할 수 있는 후에만 확인할 수 있습니다.
```
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 개발자 안내서*의 [Modifying an Amazon DocumentDB Instance](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 개발자 안내서*의 [Modifying an Amazon DocumentDB Subnet Group](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 개발자 안내서*의 [Rebooting an Amazon DocumentDB ILnstance](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 개발자 안내서*의 [Removing Tags from an Amazon DocumentDBResource](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 개발자 안내서*의 [Resetting an Amazon DocumentDB Cluster Parameter Group](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 개발자 안내서*의 [Restoring from a Cluster Snapshot](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 클러스터를 특정 시점으로 복원하는 방법**
다음 `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 개발자 안내서*의 [Restoring a Snapshot to a Point in Time](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 개발자 안내서*의 [Stopping and Starting an Amazon DocumentDB Cluster](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 개발자 안내서*의 [Stopping and Starting an Amazon DocumentDB Cluster](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) 섹션을 참조하세요.