Há mais exemplos de AWS SDK disponíveis no repositório [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Exemplos do Amazon DocumentDB usando AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon DocumentDB.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `add-tags-to-resource`
O código de exemplo a seguir mostra como usar `add-tags-to-resource`.
**AWS CLI**
**Para adicionar uma ou mais tags a um recurso especificado**
O exemplo `add-tags-to-resource` a seguir adiciona o ID a `sample-cluster`. Uma tag (`CropB`) tem um nome de chave, mas nenhum valor.
```
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"
```
Este comando não produz saída.
Para obter mais informações, consulte [Marcar recursos do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/add-tags-to-resource.html)em *Referência de AWS CLI Comandos*.
### `apply-pending-maintenance-action`
O código de exemplo a seguir mostra como usar `apply-pending-maintenance-action`.
**AWS CLI**
**Como fazer com que as ações de manutenção pendentes ocorram durante a próxima janela de manutenção**
O exemplo `apply-pending-maintenance-action` a seguir faz com que todas as ações de atualização do sistema sejam executadas durante a próxima janela de manutenção programada.
```
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
```
Este comando não produz saída.
Para obter mais informações, consulte [plicar atualizações ao Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#db-instance-updates-apply) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html)em *Referência de AWS CLI Comandos*.
### `copy-db-cluster-parameter-group`
O código de exemplo a seguir mostra como usar `copy-db-cluster-parameter-group`.
**AWS CLI**
**Como duplicar um grupo de parâmetro de cluster de banco de dados existente**
O exemplo `copy-db-cluster-parameter-group` a seguir faz uma cópia do grupo de parâmetro `custom-docdb3-6` chamado `custom-docdb3-6-copy`. Ao fazer a cópia, ele adiciona tags ao novo grupo de parâmetros.
```
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"
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Copiar um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-copy.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-parameter-group.html)em *Referência de AWS CLI Comandos*.
### `copy-db-cluster-snapshot`
O código de exemplo a seguir mostra como usar `copy-db-cluster-snapshot`.
**AWS CLI**
**Para criar cópia de um snapshot**
O exemplo da `copy-db-cluster-snapshot` a seguir faz uma cópia do `sample-cluster-snapshot` denominado `sample-cluster-snapshot-copy`. A cópia tem todas as tags do original, além de uma nova tag com o nome da chave `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"
```
Este comando não produz saída.
Para obter mais informações, consulte [Copiar um snapshot de cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-copy.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-snapshot.html)em *Referência de AWS CLI Comandos*.
### `create-db-cluster-parameter-group`
O código de exemplo a seguir mostra como usar `create-db-cluster-parameter-group`.
**AWS CLI**
**Para criar grupos de parâmetros de cluster do Amazon DocumentDB**
O exemplo `create-db-cluster-parameter-group` a seguir cria o grupo de parâmetros do cluster de banco de dados `sample-parameter-group` usando a família `docdb3.6`.
```
aws docdb create-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group \
--db-parameter-group-family docdb3.6 \
--description "Sample parameter group based on docdb3.6"
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Criar um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-parameter-group.html)em *Referência de AWS CLI Comandos*.
### `create-db-cluster-snapshot`
O código de exemplo a seguir mostra como usar `create-db-cluster-snapshot`.
**AWS CLI**
**Para criar um snapshot manual do cluster do Amazon DocumentDB**
O `create-db-cluster-snapshot` exemplo a seguir cria um snapshot de cluster de banco de dados da Amazon chamado sample-cluster-snapshot.
```
aws docdb create-db-cluster-snapshot \
--db-cluster-identifier sample-cluster \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Criar um snapshot de cluster manual](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-create.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-snapshot.html)em *Referência de AWS CLI Comandos*.
### `create-db-cluster`
O código de exemplo a seguir mostra como usar `create-db-cluster`.
**AWS CLI**
**Para criar um cluster do Amazon DocumentDB**
O exemplo `create-db-cluster` a seguir cria um cluster do Amazon DocumentDB chamado `sample-cluster` com a janela de manutenção preferencial aos domingos, entre 20h30 e 11h00.
```
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
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Criar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-create.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster.html)em *Referência de AWS CLI Comandos*.
### `create-db-instance`
O código de exemplo a seguir mostra como usar `create-db-instance`.
**AWS CLI**
**Para criar uma instância do cluster do Amazon DocumentDB**
O exemplo `create-db-instance` a seguir cria a instância `sample-cluster-instance-2` em um cluster do Amazon DocumentDB `sample-cluster`.
```
aws docdb create-db-instance \
--db-cluster-identifier sample-cluster \
--db-instance-class db.r4.xlarge \
--db-instance-identifier sample-cluster-instance-2 \
--engine docdb
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Adicionar uma instância do Amazon DocumentDB a um cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [CreateDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-instance.html)em *Referência de AWS CLI Comandos*.
### `create-db-subnet-group`
O código de exemplo a seguir mostra como usar `create-db-subnet-group`.
**AWS CLI**
**Para criar um grupo de sub-redes do Amazon DocumentDB**
O exemplo `create-db-subnet-group` a seguir cria um grupo de sub-redes do Amazon DocumentDB chamado `sample-subnet-group`.
```
aws docdb create-db-subnet-group \
--db-subnet-group-description "a sample subnet group" \
--db-subnet-group-name sample-subnet-group \
--subnet-ids "subnet-29ab1025" "subnet-991cb8d0" "subnet-53ab3636"
```
Saída:
```
{
"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"
}
}
]
}
}
```
Para obter mais informações, consulte [Criar um grupo de sub-rede do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-create) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-subnet-group.html)em *Referência de AWS CLI Comandos*.
### `delete-db-cluster-parameter-group`
O código de exemplo a seguir mostra como usar `delete-db-cluster-parameter-group`.
**AWS CLI**
**Para excluir grupos de parâmetros de cluster do Amazon DocumentDB**
O exemplo `delete-db-cluster-parameter-group` a seguir exclui o grupo de parâmetros `sample-parameter-group` do Amazon DocumentDB.
```
aws docdb delete-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group
```
Este comando não produz saída.
Para obter mais informações, consulte [Excluir um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-delete.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-parameter-group.html)em *Referência de AWS CLI Comandos*.
### `delete-db-cluster-snapshot`
O código de exemplo a seguir mostra como usar `delete-db-cluster-snapshot`.
**AWS CLI**
**Para excluir um snapshot de cluster do Amazon DocumentDB**
O exemplo `delete-db-cluster-snapshot` a seguir exclui o snapshot do cluster do Amazon DocumentDB `sample-cluster-snapshot`.
```
aws docdb delete-db-cluster-snapshot \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Saída:
```
{
"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
}
}
```
Para obter mais informações, consulte [Excluir um snapshot de cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-delete.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-snapshot.html)em *Referência de AWS CLI Comandos*.
### `delete-db-cluster`
O código de exemplo a seguir mostra como usar `delete-db-cluster`.
**AWS CLI**
**Para excluir um cluster do Amazon DocumentDB**
O exemplo `delete-db-cluster` a seguir exclui o cluster do Amazon DocumentDB `sample-cluster`. Nenhum backup do cluster é feito antes de excluí-lo. OBSERVAÇÃO: você deve excluir todas as instâncias associadas ao cluster para excluí-lo.
```
aws docdb delete-db-cluster \
--db-cluster-identifier sample-cluster \
--skip-final-snapshot
```
Saída:
```
{
"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": []
}
}
```
Para obter mais informações, consulte [Excluir um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-delete.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster.html)em *Referência de AWS CLI Comandos*.
### `delete-db-instance`
O código de exemplo a seguir mostra como usar `delete-db-instance`.
**AWS CLI**
**Para excluir uma instância do Amazon DocumentDB**
O exemplo `delete-db-instance` a seguir exclui a instância do Amazon DocumentDB `sample-cluster-instance-2`.
```
aws docdb delete-db-instance \
--db-instance-identifier sample-cluster-instance-2
```
Saída:
```
{
"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
}
}
```
Para obter mais informações, consulte [Excluir uma instância do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-delete.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DeleteDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-instance.html)em *Referência de AWS CLI Comandos*.
### `delete-db-subnet-group`
O código de exemplo a seguir mostra como usar `delete-db-subnet-group`.
**AWS CLI**
**Para excluir um grupo de sub-redes do Amazon DocumentDB**
O exemplo `delete-db-subnet-group` a seguir exclui o grupo de sub-redes `sample-subnet-group` do Amazon DocumentDB.
```
aws docdb delete-db-subnet-group \
--db-subnet-group-name sample-subnet-group
```
Este comando não produz saída.
Para obter mais informações, consulte [Excluir um grupo de sub-rede do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-delete) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-subnet-group.html)em *Referência de AWS CLI Comandos*.
### `describe-db-cluster-parameter-groups`
O código de exemplo a seguir mostra como usar `describe-db-cluster-parameter-groups`.
**AWS CLI**
**Como ver os detalhes de um ou mais grupos de parâmetros de cluster do Amazon DocumentDB**
O exemplo `describe-db-cluster-parameter-groups` a seguir exibe detalhes do grupo de parâmetros do cluster do Amazon DocumentDB `custom3-6-param-grp`.
```
aws docdb describe-db-cluster-parameter-groups \
--db-cluster-parameter-group-name custom3-6-param-grp
```
Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Visualizar grupos de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-describe.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameter-groups.html)em *Referência de AWS CLI Comandos*.
### `describe-db-cluster-parameters`
O código de exemplo a seguir mostra como usar `describe-db-cluster-parameters`.
**AWS CLI**
**Como visualizar a lista de parâmetros detalhada de um grupo de parâmetros do cluster do Amazon DocumentDB.**
O exemplo `describe-db-cluster-parameters` a seguir lista os parâmetros do grupo de parâmetros custom3-6-param-grp do Amazon DocumentDB.
```
aws docdb describe-db-cluster-parameters \
--db-cluster-parameter-group-name custom3-6-param-grp
```
Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Visualizar parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameters-describe.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameters.html)em *Referência de AWS CLI Comandos*.
### `describe-db-cluster-snapshot-attributes`
O código de exemplo a seguir mostra como usar `describe-db-cluster-snapshot-attributes`.
**AWS CLI**
**Para listar os nomes e valores de atributos de um snapshot do Amazon DocumentDB**
O exemplo `describe-db-cluster-snapshot-attributes` a seguir lista os nomes e valores dos atributos para o snapshot do Amazon DocumentDB `sample-cluster-snapshot`.
```
aws docdb describe-db-cluster-snapshot-attributes \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Saída:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": []
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
Para obter mais informações, consulte [Descrever DBCluster SnapshotAttributes](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshotAttributes.html) no Guia do *desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshot-attributes.html)em *Referência de AWS CLI Comandos*.
### `describe-db-cluster-snapshots`
O código de exemplo a seguir mostra como usar `describe-db-cluster-snapshots`.
**AWS CLI**
**Para descrever os snapshots do Amazon DocumentDB**
O exemplo `describe-db-cluster-snapshots` a seguir exibe detalhes do snapshot do Amazon DocumentDB `sample-cluster-snapshot`.
```
aws docdb describe-db-cluster-snapshots \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Descrever DBCluster snapshots](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshots.html) no Guia do desenvolvedor do *Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshots.html)em *Referência de AWS CLI Comandos*.
### `describe-db-clusters`
O código de exemplo a seguir mostra como usar `describe-db-clusters`.
**AWS CLI**
**Para obter informações detalhadas sobre um ou mais clusters do Amazon DocumentDB.**
O exemplo `describe-db-clusters` a seguir exibe detalhes do cluster do Amazon DocumentDB `sample-cluster`. Ao omitir o parâmetro `--db-cluster-identifier`, você pode obter informações de até 100 clusters.
```
aws docdb describe-db-clusters
--db-cluster-identifier sample-cluster
```
Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Descrever clusters do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-view-details.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-clusters.html)em *Referência de AWS CLI Comandos*.
### `describe-db-engine-versions`
O código de exemplo a seguir mostra como usar `describe-db-engine-versions`.
**AWS CLI**
**Para listar as versões disponíveis do mecanismo Amazon DocumentDB**
O exemplo `describe-db-engine-versions` a seguir lista todas as versões disponíveis do mecanismo do Amazon DocumentDB.
```
aws docdb describe-db-engine-versions \
--engine docdb
```
Saída:
```
{
"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"
]
}
]
}
```
Para obter mais informações, consulte [Descrever DBEngine as versões](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBEngineVersions.html) no Guia do *desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeDbEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-engine-versions.html)em *Referência de AWS CLI Comandos*.
### `describe-db-instances`
O código de exemplo a seguir mostra como usar `describe-db-instances`.
**AWS CLI**
**Como encontrar informações sobre instâncias do Amazon DocumentDB provisionadas**
O exemplo `describe-db-instances` a seguir exibe detalhes da instância do Amazon DocumentDB `sample-cluster-instance`. Ao omitir o parâmetro `--db-instance-identifier`, você obtém informações de até 100 instâncias.
```
aws docdb describe-db-instances \
--db-instance-identifier sample-cluster-instance
```
Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Descrever instâncias do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-view-details.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-instances.html)em *Referência de AWS CLI Comandos*.
### `describe-db-subnet-groups`
O código de exemplo a seguir mostra como usar `describe-db-subnet-groups`.
**AWS CLI**
**Para recuperar uma lista de descrições de sub-rede do Amazon DocumentDB**
O exemplo `describe-db-subnet-groups` a seguir descreve detalhes da sub-rede do Amazon DocumentDB chamada `default`.
```
aws docdb describe-db-subnet-groups \
--db-subnet-group-name default
```
Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Descrever grupos de sub-rede](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-groups-describe) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-subnet-groups.html)em *Referência de AWS CLI Comandos*.
### `describe-engine-default-cluster-parameters`
O código de exemplo a seguir mostra como usar `describe-engine-default-cluster-parameters`.
**AWS CLI**
**Para descrever as informações sobre o mecanismo padrão e parâmetros do sistema do Amazon DocumentDB**
O exemplo `describe-engine-default-cluster-parameters` a seguir exibe detalhes sobre as informações sobre o mecanismo padrão e parâmetros do sistema do grupo de parâmetros do Amazon DocumentDB `docdb3.6`.
```
aws docdb describe-engine-default-cluster-parameters \
--db-parameter-group-family docdb3.6
```
Saída:
```
{
"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
}
]
}
}
```
Para obter mais informações, consulte [DescribeEngineDefaultClusterParameters](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeEngineDefaultClusterParameters.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-engine-default-cluster-parameters.html)em *Referência de AWS CLI Comandos*.
### `describe-event-categories`
O código de exemplo a seguir mostra como usar `describe-event-categories`.
**AWS CLI**
**Para descrever todas as categorias de eventos do Amazon DocumentDB**
O exemplo `describe-event-categories` a seguir lista todas as categorias do tipo de fonte de eventos da Amazon DocumentDB `db-instance`.
```
aws docdb describe-event-categories \
--source-type db-cluster
```
Saída:
```
{
"EventCategoriesMapList": [
{
"SourceType": "db-cluster",
"EventCategories": [
"failover",
"maintenance",
"notification",
"failure"
]
}
]
}
```
Para obter mais informações, consulte [Visualizar categorias de eventos](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-event-categories) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-event-categories.html)em *Referência de AWS CLI Comandos*.
### `describe-events`
O código de exemplo a seguir mostra como usar `describe-events`.
**AWS CLI**
**Para listar eventos do Amazon DocumentDB**
O exemplo `describe-events` a seguir lista todos os eventos do Amazon DocumentDB das últimas 24 horas (1.440 minutos).
```
aws docdb describe-events \
--duration 1440
```
Este comando não produz saída. Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Visualizar eventos do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-events) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-events.html)em *Referência de AWS CLI Comandos*.
### `describe-orderable-db-instance-options`
O código de exemplo a seguir mostra como usar `describe-orderable-db-instance-options`.
**AWS CLI**
**Como encontrar as opções de instância do Amazon DocumentDB que você pode solicitar**
O exemplo `describe-orderable-db-instance-options` a seguir lista todas as opções de instância do Amazon DocumentDB para uma região.
```
aws docdb describe-orderable-db-instance-options \
--engine docdb \
--region us-east-1
```
Saída:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Adicionar uma instância do Amazon DocumentDB a um cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribeOrderableDbInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-orderable-db-instance-options.html)em *Referência de AWS CLI Comandos*.
### `describe-pending-maintenance-actions`
O código de exemplo a seguir mostra como usar `describe-pending-maintenance-actions`.
**AWS CLI**
**Para listar suas ações de manutenção pendentes do Amazon DocumentDB**
O exemplo `describe-pending-maintenance-actions` a seguir lista todas as suas ações pendentes de manutenção do Amazon DocumentDB.
```
aws docdb describe-pending-maintenance-actions
```
Saída:
```
{
"PendingMaintenanceActions": []
}
```
Para obter mais informações, consulte [Manutenção do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html)em *Referência de AWS CLI Comandos*.
### `failover-db-cluster`
O código de exemplo a seguir mostra como usar `failover-db-cluster`.
**AWS CLI**
**Como forçar o failover de um cluster do Amazon DocumentDB em uma réplica**
O exemplo `failover-db-cluster` a seguir faz com que a instância primária no cluster sample-cluster do Amazon DocumentDB realize o failover para uma réplica.
```
aws docdb failover-db-cluster \
--db-cluster-identifier sample-cluster
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Failover do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/failover.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [FailoverDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-db-cluster.html)em *Referência de AWS CLI Comandos*.
### `list-tags-for-resource`
O código de exemplo a seguir mostra como usar `list-tags-for-resource`.
**AWS CLI**
**Para listar todas as tags em um recurso do Amazon DocumentDB**
O exemplo `list-tags-for-resource` a seguir lista todas as tags do cluster do Amazon DocumentDB `sample-cluster`.
```
aws docdb list-tags-for-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster
```
Saída:
```
{
"TagList": [
{
"Key": "A",
"Value": "ALPHA"
},
{
"Key": "B",
"Value": ""
},
{
"Key": "C",
"Value": "CHARLIE"
}
]
}
```
Para obter mais informações, consulte [Listar tags em um recurso do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-list) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/list-tags-for-resource.html)em *Referência de AWS CLI Comandos*.
### `modify-db-cluster-parameter-group`
O código de exemplo a seguir mostra como usar `modify-db-cluster-parameter-group`.
**AWS CLI**
**Para modificar grupos de parâmetros de cluster do Amazon DocumentDB**
O exemplo `modify-db-cluster-parameter-group` a seguir modifica o grupo de parâmetros do cluster Amazon DocumentDB `custom3-6-param-grp` definindo os dois parâmetros `audit_logs` e `ttl_monitor` como habilitados. As alterações serão aplicadas na próxima reinicialização.
```
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
```
Saída:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Para obter mais informações, consulte [Modificar um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-modify.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-parameter-group.html)em *Referência de AWS CLI Comandos*.
### `modify-db-cluster-snapshot-attribute`
O código de exemplo a seguir mostra como usar `modify-db-cluster-snapshot-attribute`.
**AWS CLI**
**Exemplo 1: adicionar um atributo a um snapshot do Amazon DocumentDB**
O exemplo `modify-db-cluster-snapshot-attribute` a seguir adiciona quatro valores de atributos a um snapshot do cluster do 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
```
Saída:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789012",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
**Exemplo 2: remover atributos de um snapshot do Amazon DocumentDB**
O exemplo `modify-db-cluster-snapshot-attribute` a seguir remove dois valores de atributos de um snapshot do cluster do Amazon DocumentDB.
```
aws docdb modify-db-cluster-snapshot-attribute \
--db-cluster-snapshot-identifier sample-cluster-snapshot \
--attribute-name restore \
--values-to-remove 123456789012
```
Saída:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
Para obter mais informações, consulte [Modificar DBCluster SnapshotAttribute](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBClusterSnapshotAttribute.html) no Guia do *desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-snapshot-attribute.html)em *Referência de AWS CLI Comandos*.
### `modify-db-cluster`
O código de exemplo a seguir mostra como usar `modify-db-cluster`.
**AWS CLI**
**Para modificar um cluster do Amazon DocumentDB**
O exemplo `modify-db-cluster` a seguir modifica o cluster do Amazon DocumentDB `sample-cluster` fazendo com que o período de retenção dos backups automáticos seja de 7 dias e alterando as janelas preferenciais para backups e manutenção. Todas as alterações serão aplicadas durante a próxima janela de manutenção.
```
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
```
Saída:
```
{
"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
}
}
```
Para obter mais informações, consulte [Modificar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-modify.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster.html)em *Referência de AWS CLI Comandos*.
### `modify-db-instance`
O código de exemplo a seguir mostra como usar `modify-db-instance`.
**AWS CLI**
**Para modificar uma instância do Amazon DocumentDB**
O exemplo `modify-db-instance` a seguir modifica a instância `sample-cluster2` do Amazon DocumentDB alterando sua classe de instância para `db.r4.4xlarge` e seu nível de promoção para `5`. As alterações são aplicadas imediatamente, mas só podem ser vistas depois que o status da instância estiver disponível.
```
aws docdb modify-db-instance \
--db-instance-identifier sample-cluster2 \
--apply-immediately \
--db-instance-class db.r4.4xlarge \
--promotion-tier 5
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Modificar uma instância do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-modify.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [ModifyDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-instance.html)em *Referência de AWS CLI Comandos*.
### `modify-db-subnet-group`
O código de exemplo a seguir mostra como usar `modify-db-subnet-group`.
**AWS CLI**
**Para modificar um grupo de sub-redes do Amazon DocumentDB**
O exemplo `modify-db-subnet-group` a seguir modifica o grupo de sub-redes `sample-subnet-group` adicionando as sub-redes especificadas e uma nova descrição.
```
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"
```
Saída:
```
{
"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"
}
}
]
}
}
```
Para obter mais informações, consulte [Modificar um grupo de sub-rede do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-modify) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-subnet-group.html)em *Referência de AWS CLI Comandos*.
### `reboot-db-instance`
O código de exemplo a seguir mostra como usar `reboot-db-instance`.
**AWS CLI**
**Como reinicializar uma instância do Amazon DocumentDB**
O exemplo `reboot-db-instance` a seguir reinicializa a instância do Amazon DocumentDB `sample-cluster2`.
```
aws docdb reboot-db-instance \
--db-instance-identifier sample-cluster2
```
Este comando não produz saída. Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Reinicializando um Amazon ILnstance DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-reboot.html) no Guia do desenvolvedor do Amazon *DocumentDB*.
+ Para obter detalhes da API, consulte [RebootDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reboot-db-instance.html)em *Referência de AWS CLI Comandos*.
### `remove-tags-from-resource`
O código de exemplo a seguir mostra como usar `remove-tags-from-resource`.
**AWS CLI**
**Para remover as tags de metadados de um recurso do Amazon DocumentDB**
O exemplo `remove-tags-from-resource` a seguir remove a tag com a chave chamada `B` do cluster do Amazon DocumentDB `sample-cluster`.
```
aws docdb remove-tags-from-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
--tag-keys B
```
Este comando não produz saída.
Para obter mais informações, consulte [Removendo tags de um documento da Amazon DBResource](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-remove) no Guia do *desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/remove-tags-from-resource.html)em *Referência de AWS CLI Comandos*.
### `reset-db-cluster-parameter-group`
O código de exemplo a seguir mostra como usar `reset-db-cluster-parameter-group`.
**AWS CLI**
**Como redefinir o valor do parâmetro especificado para seus padrões em um grupo de parâmetros do Amazon DocumentDB**
O exemplo `reset-db-cluster-parameter-group` a seguir redefine o parâmetro `ttl_monitor` no grupo de parâmetro de do Amazon DocumentDB `custom3-6-param-grp` para seu valor padrão.
```
aws docdb reset-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--parameters ParameterName=ttl_monitor,ApplyMethod=immediate
```
Saída:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Para obter mais informações, consulte o título no *Guia do desenvolvedor do Amazon DocumentDB*.
**Como redefinir os valores especificados ou todos os parâmetros para seus padrões em um grupo de parâmetros do Amazon DocumentDB**
O exemplo `reset-db-cluster-parameter-group` a seguir redefine todos os parâmetros no grupo de parâmetro do Amazon DocumentDB `custom3-6-param-grp` para seu valor padrão.
```
aws docdb reset-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--reset-all-parameters
```
Saída:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Para obter mais informações, consulte [Redefinir um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-reset.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reset-db-cluster-parameter-group.html)em *Referência de AWS CLI Comandos*.
### `restore-db-cluster-from-snapshot`
O código de exemplo a seguir mostra como usar `restore-db-cluster-from-snapshot`.
**AWS CLI**
**Como restaurar um cluster do Amazon DocumentDB a partir de um snapshot automático ou manual**
O exemplo `restore-db-cluster-from-snapshot` a seguir cria um novo cluster do Amazon DocumentDB chamado `sample-cluster-2019-03-16-00-01-restored` a partir do snapshot`rds:sample-cluster-2019-03-16-00-01`.
```
aws docdb restore-db-cluster-from-snapshot \
--db-cluster-identifier sample-cluster-2019-03-16-00-01-restored \
--engine docdb \
--snapshot-identifier rds:sample-cluster-2019-03-16-00-01
```
Saída:
```
{
"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"
}
]
}
}
```
Para obter mais informações, consulte [Restaurar a partir de um snapshot de cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.restore-from-snapshot.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-from-snapshot.html)em *Referência de AWS CLI Comandos*.
### `restore-db-cluster-to-point-in-time`
O código de exemplo a seguir mostra como usar `restore-db-cluster-to-point-in-time`.
**AWS CLI**
**Para restaurar um cluster Amazon DocumentDB para um a point-in-time partir de um snapshot manual**
O exemplo `restore-db-cluster-to-point-in-time` a seguir usa o `sample-cluster-snapshot` para criar um novo cluster do Amazon DocumentDB, `sample-cluster-pit`, usando o tempo restaurável mais recente.
```
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
```
Saída:
```
{
"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"
}
}
```
Para obter mais informações, consulte [Restaurar um snapshot para um ponto no tempo](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.point-in-time-recovery.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-to-point-in-time.html)em *Referência de AWS CLI Comandos*.
### `start-db-cluster`
O código de exemplo a seguir mostra como usar `start-db-cluster`.
**AWS CLI**
**Para iniciar um cluster interrompido do Amazon DocumentDB**
O exemplo `start-db-cluster` a seguir inicia o cluster do Amazon DocumentDB especificado.
```
aws docdb start-db-cluster \
--db-cluster-identifier sample-cluster
```
Saída:
```
{
"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"
}
]
}
}
```
Para obter mais informações, consulte [Interromper e iniciar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/start-db-cluster.html)em *Referência de AWS CLI Comandos*.
### `stop-db-cluster`
O código de exemplo a seguir mostra como usar `stop-db-cluster`.
**AWS CLI**
**Como interromper um cluster em execução do Amazon DocumentDB**
O exemplo `stop-db-cluster` a seguir interrompe o cluster do Amazon DocumentDB especificado.
```
aws docdb stop-db-cluster \
--db-cluster-identifier sample-cluster
```
Saída:
```
{
"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"
}
]
}
}
```
Para obter mais informações, consulte [Interromper e iniciar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) no *Guia do desenvolvedor do Amazon DocumentDB*.
+ Para obter detalhes da API, consulte [StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/stop-db-cluster.html)em *Referência de AWS CLI Comandos*.