Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de [ejemplos de AWS Doc SDK](https://github.com/awsdocs/aws-doc-sdk-examples).
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Ejemplos de Amazon DocumentDB que utilizan AWS CLI
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante Amazon DocumentDB. AWS Command Line Interface
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `add-tags-to-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `add-tags-to-resource`.
**AWS CLI**
**Adición de una o varias etiquetas a un recurso especificado**
En el siguiente ejemplo `add-tags-to-resource`, se agregan tres etiquetas a `sample-cluster`. Una etiqueta (`CropB`) tiene un nombre de clave pero no un 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 no genera ninguna salida.
Para obtener más información, consulte [Tagging Amazon DocumentDB Resources](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/add-tags-to-resource.html)la *Referencia de AWS CLI comandos*.
### `apply-pending-maintenance-action`
En el siguiente ejemplo de código, se muestra cómo utilizar `apply-pending-maintenance-action`.
**AWS CLI**
**Acciones de mantenimiento pendientes: cómo hacer que se lleven a cabo durante el siguiente período de mantenimiento**
El ejemplo `apply-pending-maintenance-action` siguiente hace que todas las acciones de actualización del sistema se realicen durante el siguiente período de mantenimiento programado.
```
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 no genera ninguna salida.
Para obtener más información, consulte [Applying Amazon DocumentDB Updates](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#db-instance-updates-apply) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html)la *Referencia de AWS CLI comandos*.
### `copy-db-cluster-parameter-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `copy-db-cluster-parameter-group`.
**AWS CLI**
**Duplicación de un grupo de parámetros de clúster de DB existente**
En el siguiente ejemplo de `copy-db-cluster-parameter-group`, se crea una copia de `custom-docdb3-6` llamada `custom-docdb3-6-copy`. Al realizar la copia, se añaden etiquetas al nuevo 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"
```
Salida:
```
{
"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 obtener más información, consulte [Copying an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-copy.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-parameter-group.html)la *Referencia de AWS CLI comandos*.
### `copy-db-cluster-snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `copy-db-cluster-snapshot`.
**AWS CLI**
**Creación de una copia de una instantánea**
En el siguiente ejemplo de la `copy-db-cluster-snapshot` se crea una copia de `sample-cluster-snapshot` llamada `sample-cluster-snapshot-copy`. La copia tiene todas las etiquetas del original más una etiqueta nueva con el `CopyNumber` del nombre de la clave.
```
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 no genera ninguna salida.
Para obtener más información sobre estas opciones, consulte [Copying a Cluster Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-copy.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-snapshot.html)la *Referencia de AWS CLI comandos*.
### `create-db-cluster-parameter-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-db-cluster-parameter-group`.
**AWS CLI**
**Creación de grupos de parámetros del clúster de Amazon DocumentDB**
En el siguiente ejemplo de `create-db-cluster-parameter-group`, se crea el grupo de parámetros del clúster de DB `sample-parameter-group` usando la familia `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"
```
Salida:
```
{
"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 obtener más información, consulte [Creating an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-parameter-group.html)la *Referencia de AWS CLI comandos*.
### `create-db-cluster-snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-db-cluster-snapshot`.
**AWS CLI**
**Creación manual de una instantánea del clúster de Amazon DocumentDB**
En el siguiente `create-db-cluster-snapshot` ejemplo, se crea una instantánea de un clúster de Amazon DB con el nombre sample-cluster-snapshot.
```
aws docdb create-db-cluster-snapshot \
--db-cluster-identifier sample-cluster \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Salida:
```
{
"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 obtener más información, consulte [Creating a Manual Cluster Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-create.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-snapshot.html)la *Referencia de AWS CLI comandos*.
### `create-db-cluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-db-cluster`.
**AWS CLI**
**Creación de un clúster de Amazon DocumentDB**
En el siguiente ejemplo de `create-db-cluster`, se crea un clúster de Amazon DocumentDB denominado `sample-cluster` con el intervalo de mantenimiento preferido los domingos entre las 20:30 y las 11:00.
```
aws docdb create-db-cluster \
--db-cluster-identifier sample-cluster \
--engine docdb \
--master-username master-user \
--master-user-password password \
--preferred-maintenance-window Sun:20:30-Sun:21:00
```
Salida:
```
{
"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 obtener más información, consulte [Creating an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-create.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster.html)la *Referencia de AWS CLI comandos*.
### `create-db-instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-db-instance`.
**AWS CLI**
**Creación de una instancia de un clúster de Amazon DocumentDB**
En el siguiente código de ejemplo de `create-db-instance`, se crean las instancias `sample-cluster-instance-2` de un clúster de 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
```
Salida:
```
{
"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 obtener más información, consulte [Adding an Amazon DocumentDB Instance to a Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [CreateDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-instance.html)la *Referencia de AWS CLI comandos*.
### `create-db-subnet-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-db-subnet-group`.
**AWS CLI**
**Creación de un grupo de subredes de Amazon DocumentDB**
En el siguiente ejemplo de `create-db-subnet-group`, se crea un grupo de subredes de Amazon DocumentDB denominado `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"
```
Salida:
```
{
"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 obtener más información, consulte [Creating an Amazon DocumentDB Subnet Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-create) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-subnet-group.html)la *Referencia de AWS CLI comandos*.
### `delete-db-cluster-parameter-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-db-cluster-parameter-group`.
**AWS CLI**
**Eliminación de grupos de parámetros del clúster de Amazon DocumentDB**
En el siguiente ejemplo de `delete-db-cluster-parameter-group`, se elimina un grupo de parámetros de Amazon DocumentDB `sample-parameter-group`.
```
aws docdb delete-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Deleting an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-delete.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-parameter-group.html)la *Referencia de AWS CLI comandos*.
### `delete-db-cluster-snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-db-cluster-snapshot`.
**AWS CLI**
**Eliminación de una instantánea de un clúster de Amazon DocumentDB**
En el siguiente ejemplo de `delete-db-cluster-snapshot`, se elimina la instantánea del clúster de Amazon DocumentDB `sample-cluster-snapshot`.
```
aws docdb delete-db-cluster-snapshot \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Salida:
```
{
"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 obtener más información, consulte [Deleting a Cluster Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-delete.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-snapshot.html)la *Referencia de AWS CLI comandos*.
### `delete-db-cluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-db-cluster`.
**AWS CLI**
**Eliminación de un clúster de Amazon DocumentDB**
En el siguiente ejemplo de `delete-db-cluster`, se elimina la instantánea del clúster de Amazon DocumentDB `sample-cluster`. No se realiza ninguna copia de seguridad del clúster antes de eliminarlo. NOTA: Debe eliminar todas las instancias asociadas al clúster antes de poder eliminarlo.
```
aws docdb delete-db-cluster \
--db-cluster-identifier sample-cluster \
--skip-final-snapshot
```
Salida:
```
{
"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 obtener más información, consulte [Deleting an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-delete.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster.html)la *Referencia de AWS CLI comandos*.
### `delete-db-instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-db-instance`.
**AWS CLI**
**Eliminación de una instancia de Amazon DocumentDB**
En el siguiente ejemplo de `delete-db-instance`, se elimina la instancia de Amazon DocumentDB `sample-cluster-instance-2`.
```
aws docdb delete-db-instance \
--db-instance-identifier sample-cluster-instance-2
```
Salida:
```
{
"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 obtener más información, consulte [Deleting an Amazon DocumentDB Instance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-delete.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DeleteDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-instance.html)la *Referencia de AWS CLI comandos*.
### `delete-db-subnet-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-db-subnet-group`.
**AWS CLI**
**Eliminación de un grupo de subredes de Amazon DocumentDB**
En el siguiente ejemplo de `delete-db-subnet-group`, se elimina un grupo de subredes de Amazon DocumentDB `sample-subnet-group`.
```
aws docdb delete-db-subnet-group \
--db-subnet-group-name sample-subnet-group
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Deleting an Amazon DocumentDB Subnet Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-delete) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-subnet-group.html)la *Referencia de AWS CLI comandos*.
### `describe-db-cluster-parameter-groups`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-db-cluster-parameter-groups`.
**AWS CLI**
**Visualización de detalles de uno o más grupos de parámetros del clúster de Amazon DocumentDB**
En el siguiente ejemplo de `describe-db-cluster-parameter-groups`, se muestran los detalles de un grupo de parámetros del clúster de Amazon DocumentDB `custom3-6-param-grp`.
```
aws docdb describe-db-cluster-parameter-groups \
--db-cluster-parameter-group-name custom3-6-param-grp
```
Salida:
```
{
"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 obtener más información, consulte [Viewing Amazon DocumentDB Cluster Parameter Groups](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-describe.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameter-groups.html)la *Referencia de AWS CLI comandos*.
### `describe-db-cluster-parameters`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-db-cluster-parameters`.
**AWS CLI**
**Visualización de la lista detallada de parámetros para un grupo de parámetros de clúster de Amazon DocumentDB.**
En el siguiente ejemplo de `describe-db-cluster-parameters`, se enumeran los parámetros del grupo de parámetros custom3-6-param-grp de Amazon DocumentDB.
```
aws docdb describe-db-cluster-parameters \
--db-cluster-parameter-group-name custom3-6-param-grp
```
Salida:
```
{
"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 obtener más información, consulte [Viewing Amazon DocumentDB Cluster Parameters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameters-describe.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameters.html)la *Referencia de AWS CLI comandos*.
### `describe-db-cluster-snapshot-attributes`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-db-cluster-snapshot-attributes`.
**AWS CLI**
**Para enumerar los nombres y los valores de los atributos de una instantánea de Amazon DocumentDB**
En el siguiente ejemplo de `describe-db-cluster-snapshot-attributes`, se enumeran los nombres y los valores de los atributos de la instantánea de Amazon DocumentDB `sample-cluster-snapshot`.
```
aws docdb describe-db-cluster-snapshot-attributes \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Salida:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": []
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
Para obtener más información, consulte [Describe DBCluster SnapshotAttributes](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshotAttributes.html) en la Guía para *desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshot-attributes.html)la *Referencia de AWS CLI comandos*.
### `describe-db-cluster-snapshots`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-db-cluster-snapshots`.
**AWS CLI**
**Descripción de las instantáneas de Amazon DocumentDB**
En el siguiente ejemplo de `describe-db-cluster-snapshots`, se muestran los detalles de la instantánea de Amazon DocumentDB `sample-cluster-snapshot`.
```
aws docdb describe-db-cluster-snapshots \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Salida:
```
{
"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 obtener más información, consulte [Describa las DBCluster instantáneas](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshots.html) en la Guía para desarrolladores de *Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte la Referencia [DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshots.html)de *AWS CLI comandos*.
### `describe-db-clusters`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-db-clusters`.
**AWS CLI**
**Obtención de información detallada sobre uno o más clústeres de Amazon DocumentDB.**
En el siguiente ejemplo de `describe-db-clusters`, se muestran los detalles del clúster de Amazon DocumentDB `sample-cluster`. Al omitir el parámetro `--db-cluster-identifier`, puede obtener información de hasta 100 clústeres.
```
aws docdb describe-db-clusters
--db-cluster-identifier sample-cluster
```
Salida:
```
{
"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 obtener más información, consulte [Describing Amazon DocumentDB Clusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-view-details.html) en la Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-clusters.html)la *Referencia de AWS CLI comandos*.
### `describe-db-engine-versions`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-db-engine-versions`.
**AWS CLI**
**Para enumerar las versiones disponibles del motor de Amazon DocumentDB**
En el siguiente ejemplo de `describe-db-engine-versions`, se enumeran todas las versiones disponibles del motor de Amazon DocumentDB.
```
aws docdb describe-db-engine-versions \
--engine docdb
```
Salida:
```
{
"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 obtener más información, consulte [Describir DBEngine las versiones](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBEngineVersions.html) en la Guía para *desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [DescribeDbEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-engine-versions.html)la *Referencia de AWS CLI comandos*.
### `describe-db-instances`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-db-instances`.
**AWS CLI**
**Búsqueda de información acerca de las instancias de Amazon DocumentDB aprovisionadas**
En el siguiente ejemplo de `describe-db-instances`, se muestran los detalles de la instancia de Amazon DocumentDB `sample-cluster-instance`. Al omitir el parámetro `--db-instance-identifier`, obtiene información de hasta 100 instancias.
```
aws docdb describe-db-instances \
--db-instance-identifier sample-cluster-instance
```
Salida:
```
{
"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 obtener más información, consulte [Describing Amazon DocumentDB Instances](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-view-details.html) en la Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [DescribeDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-instances.html)la *Referencia de AWS CLI comandos*.
### `describe-db-subnet-groups`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-db-subnet-groups`.
**AWS CLI**
**Recuperación de una lista de descripciones de subredes de Amazon DocumentDB**
En el siguiente ejemplo de `describe-db-subnet-groups`, se describen los detalles de la subred de Amazon DocumentDB denominada `default`.
```
aws docdb describe-db-subnet-groups \
--db-subnet-group-name default
```
Salida:
```
{
"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 obtener más información, consulte [Describing Subnet Groups](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-groups-describe) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-subnet-groups.html)la *Referencia de AWS CLI comandos*.
### `describe-engine-default-cluster-parameters`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-engine-default-cluster-parameters`.
**AWS CLI**
**Descripción de información sobre el motor y los parámetros del sistema predeterminados para Amazon DocumentDB**
El siguiente ejemplo de `describe-engine-default-cluster-parameters` muestra información sobre el motor y los parámetros del sistema predeterminados para el grupo de parámetros de Amazon DocumentDB `docdb3.6`.
```
aws docdb describe-engine-default-cluster-parameters \
--db-parameter-group-family docdb3.6
```
Salida:
```
{
"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 obtener más información, consulte [DescribeEngineDefaultClusterParameters](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeEngineDefaultClusterParameters.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-engine-default-cluster-parameters.html)la *Referencia de AWS CLI comandos*.
### `describe-event-categories`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-event-categories`.
**AWS CLI**
**Descripción de todas las categorías de eventos de Amazon DocumentDB**
En el siguiente ejemplo de `describe-event-categories`, se muestran todas las categorías para el tipo de origen de eventos de Amazon DocumentDB `db-instance`.
```
aws docdb describe-event-categories \
--source-type db-cluster
```
Salida:
```
{
"EventCategoriesMapList": [
{
"SourceType": "db-cluster",
"EventCategories": [
"failover",
"maintenance",
"notification",
"failure"
]
}
]
}
```
Para obtener más información, consulte [Viewing Event Categories](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-event-categories) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-event-categories.html)la *Referencia de AWS CLI comandos*.
### `describe-events`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-events`.
**AWS CLI**
**Para enumerar los eventos de Amazon DocumentDB**
En el siguiente ejemplo de `describe-events`, se muestran todos los eventos de Amazon DocumentDB de las últimas 24 horas (1440 minutos).
```
aws docdb describe-events \
--duration 1440
```
Este comando no genera ninguna salida. Salida:
```
{
"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 obtener más información, consulte [Viewing Amazon DocumentDB Events](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-events) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-events.html)la *Referencia de AWS CLI comandos*.
### `describe-orderable-db-instance-options`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-orderable-db-instance-options`.
**AWS CLI**
**Búsqueda de las opciones de instancia de Amazon DocumentDB que puede solicitar**
En el siguiente ejemplo de `describe-orderable-db-instance-options`, se enumeran todas las opciones de instancia de Amazon DocumentDB para una región.
```
aws docdb describe-orderable-db-instance-options \
--engine docdb \
--region us-east-1
```
Salida:
```
{
"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 obtener más información, consulte [Adding an Amazon DocumentDB Instance to a Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DescribeOrderableDbInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-orderable-db-instance-options.html)la *Referencia de AWS CLI comandos*.
### `describe-pending-maintenance-actions`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-pending-maintenance-actions`.
**AWS CLI**
**Para enumerar las acciones de mantenimiento pendientes de Amazon DocumentDB**
En el siguiente ejemplo de `describe-pending-maintenance-actions`, se enumeran todas las acciones de mantenimiento pendientes de Amazon DocumentDB.
```
aws docdb describe-pending-maintenance-actions
```
Salida:
```
{
"PendingMaintenanceActions": []
}
```
Para obtener más información, consulte las [Maintaining Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html)la *Referencia de AWS CLI comandos*.
### `failover-db-cluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `failover-db-cluster`.
**AWS CLI**
**Conmutación por error forzada a una réplica por parte de un clúster de Amazon DocumentDB**
En el siguiente ejemplo de `failover-db-cluster`, se obliga a la instancia principal del clúster sample-cluster de Amazon DocumentDB a realizar una conmutación por error a una réplica.
```
aws docdb failover-db-cluster \
--db-cluster-identifier sample-cluster
```
Salida:
```
{
"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 obtener más información, consulte las [Amazon DocumentDB Failover](https://docs.aws.amazon.com/documentdb/latest/developerguide/failover.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [FailoverDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-db-cluster.html)la *Referencia de AWS CLI comandos*.
### `list-tags-for-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.
**AWS CLI**
**Para enumerar todas las etiquetas en un recurso de Amazon DocumentDB**
En el siguiente ejemplo de `list-tags-for-resource`, se enumeran todas las etiquetas de un clúster `sample-cluster` de Amazon DocumentDB.
```
aws docdb list-tags-for-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster
```
Salida:
```
{
"TagList": [
{
"Key": "A",
"Value": "ALPHA"
},
{
"Key": "B",
"Value": ""
},
{
"Key": "C",
"Value": "CHARLIE"
}
]
}
```
Para obtener más información, consulte [Listing Tags on an Amazon DocumentDB Resource](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-list) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/list-tags-for-resource.html)la *Referencia de AWS CLI comandos*.
### `modify-db-cluster-parameter-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `modify-db-cluster-parameter-group`.
**AWS CLI**
**Modificación de un grupo de parámetros de clúster de Amazon DocumentDB**
En el siguiente ejemplo de `modify-db-cluster-parameter-group`, se modifica el grupo de parámetros del clúster `custom3-6-param-grp` de Amazon DocumentDB estableciendo los dos parámetros `audit_logs` y `ttl_monitor` como habilitados. Los cambios se aplican en el siguiente reinicio.
```
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
```
Salida:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Para obtener más información, consulte [Modifying an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-modify.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-parameter-group.html)la *Referencia de AWS CLI comandos*.
### `modify-db-cluster-snapshot-attribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `modify-db-cluster-snapshot-attribute`.
**AWS CLI**
**Ejemplo 1: añadir un atributo a una instantánea de Amazon DocumentDB**
En el siguiente ejemplo de `modify-db-cluster-snapshot-attribute`, se añaden cuatro valores de atributo a una instantánea de clúster de 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
```
Salida:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789012",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
**Ejemplo 2: eliminación de atributos de una instantánea de Amazon DocumentDB**
En el siguiente ejemplo de `modify-db-cluster-snapshot-attribute`, se eliminan dos valores de atributo de una instantánea de clúster de Amazon DocumentDB.
```
aws docdb modify-db-cluster-snapshot-attribute \
--db-cluster-snapshot-identifier sample-cluster-snapshot \
--attribute-name restore \
--values-to-remove 123456789012
```
Salida:
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
Para obtener más información, consulte [Modificar DBCluster SnapshotAttribute](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBClusterSnapshotAttribute.html) en la Guía para *desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-snapshot-attribute.html)la *Referencia de AWS CLI comandos*.
### `modify-db-cluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `modify-db-cluster`.
**AWS CLI**
**Modificación de un clúster de Amazon DocumentDB**
En el siguiente ejemplo de `modify-db-cluster`, se modifica el clúster `sample-cluster` de Amazon DocumentDB estableciendo en siete días el período de retención de las copias de seguridad automáticas y cambiando los plazos preferidos tanto para las copias de seguridad como para el mantenimiento. Todos estos cambios se aplican durante el siguiente plazo de mantenimiento.
```
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
```
Salida:
```
{
"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 obtener más información, consulte [Modifying an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-modify.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster.html)la *Referencia de AWS CLI comandos*.
### `modify-db-instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `modify-db-instance`.
**AWS CLI**
**Modificación de una instancia de Amazon DocumentDB**
En el siguiente ejemplo de `modify-db-instance`, se modifica la instancia de Amazon DocumentDB `sample-cluster2` cambiando su clase de instancia a `db.r4.4xlarge` y su nivel de promoción a `5`. Los cambios se aplican inmediatamente, pero solo se pueden ver una vez que la instancia se encuentre en estado disponible.
```
aws docdb modify-db-instance \
--db-instance-identifier sample-cluster2 \
--apply-immediately \
--db-instance-class db.r4.4xlarge \
--promotion-tier 5
```
Salida:
```
{
"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 obtener más información, consulte [Modifying an Amazon DocumentDB Instance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-modify.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [ModifyDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-instance.html)la *Referencia de AWS CLI comandos*.
### `modify-db-subnet-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `modify-db-subnet-group`.
**AWS CLI**
**Modificación de un grupo de subredes de Amazon DocumentDB**
En el siguiente ejemplo de `modify-db-subnet-group`, se modifica el grupo de subredes `sample-subnet-group` añadiendo las subredes especificadas y una nueva descripción.
```
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"
```
Salida:
```
{
"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 obtener más información, consulte [Modifying an Amazon DocumentDB Subnet Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-modify) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-subnet-group.html)la *Referencia de AWS CLI comandos*.
### `reboot-db-instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `reboot-db-instance`.
**AWS CLI**
**Reinicio de la instancia de Amazon DocumentDB**
En el siguiente ejemplo de `reboot-db-instance`, se reinicia la instancia de Amazon DocumentDB `sample-cluster2`.
```
aws docdb reboot-db-instance \
--db-instance-identifier sample-cluster2
```
Este comando no genera ninguna salida. Salida:
```
{
"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 obtener más información, consulte [Reiniciar una Amazon ILnstance DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-reboot.html) en la Guía para desarrolladores de Amazon *DocumentDB.*
+ *Para obtener más información sobre la API, consulte [RebootDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reboot-db-instance.html)la Referencia de comandos.AWS CLI *
### `remove-tags-from-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `remove-tags-from-resource`.
**AWS CLI**
**Eliminación de las etiquetas de metadatos de un recurso de Amazon DocumentDB**
En el siguiente ejemplo de `remove-tags-from-resource`, se elimina la etiqueta la clave denominada `B` del clúster de 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 no genera ninguna salida.
Para obtener más información, consulte [Eliminar etiquetas de un documento de Amazon DBResource](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-remove) en la Guía para *desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/remove-tags-from-resource.html)la *Referencia de AWS CLI comandos*.
### `reset-db-cluster-parameter-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `reset-db-cluster-parameter-group`.
**AWS CLI**
**Restablecimiento del valor del parámetro especificado a sus valores predeterminados en un grupo de parámetros de Amazon DocumentDB**
En el siguiente ejemplo de `reset-db-cluster-parameter-group`, se restablece el parámetro `ttl_monitor` en el grupo de parámetros `custom3-6-param-grp` de Amazon DocumentDB a su valor predeterminado.
```
aws docdb reset-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--parameters ParameterName=ttl_monitor,ApplyMethod=immediate
```
Salida:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Para obtener más información, consulte el título en la *Guía para desarrolladores de Amazon DocumentDB*.
**Restablecimiento de todos los valores de los parámetros o solo los especificados a sus valores predeterminados en un grupo de parámetros de Amazon DocumentDB**
En el siguiente ejemplo de `reset-db-cluster-parameter-group`, se restablecen todos los parámetros en el grupo de parámetros `custom3-6-param-grp` de Amazon DocumentDB a su valor predeterminado.
```
aws docdb reset-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--reset-all-parameters
```
Salida:
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Para obtener más información, consulte [Resetting an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-reset.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reset-db-cluster-parameter-group.html)la *Referencia de AWS CLI comandos*.
### `restore-db-cluster-from-snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `restore-db-cluster-from-snapshot`.
**AWS CLI**
**Restauración de un clúster de Amazon DocumentDB desde una instantánea manual o automática**
En el siguiente ejemplo de `restore-db-cluster-from-snapshot`, se crea un nuevo clúster de Amazon DocumentDB denominado `sample-cluster-2019-03-16-00-01-restored` a partir de la instantánea `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
```
Salida:
```
{
"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 obtener más información, consulte [Restoring from a Cluster Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.restore-from-snapshot.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-from-snapshot.html)la *Referencia de AWS CLI comandos*.
### `restore-db-cluster-to-point-in-time`
En el siguiente ejemplo de código, se muestra cómo utilizar `restore-db-cluster-to-point-in-time`.
**AWS CLI**
**Para restaurar un clúster de Amazon DocumentDB a point-in-time partir de una instantánea manual**
En el siguiente ejemplo de `restore-db-cluster-to-point-in-time`, se utiliza `sample-cluster-snapshot` para crear un nuevo clúster de Amazon DocumentDB`sample-cluster-pit` utilizando el punto de restauración más reciente.
```
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
```
Salida:
```
{
"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 obtener más información, consulte [Restoring a Snapshot to a Point in Time](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.point-in-time-recovery.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
+ Para obtener más información sobre la API, consulte [RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-to-point-in-time.html)la *Referencia de AWS CLI comandos*.
### `start-db-cluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `start-db-cluster`.
**AWS CLI**
**Inicio o detención de un clúster de Amazon DocumentDB**
En el siguiente ejemplo de `start-db-cluster`, se inicia el clúster de Amazon DocumentDB especificado.
```
aws docdb start-db-cluster \
--db-cluster-identifier sample-cluster
```
Salida:
```
{
"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 obtener más información, consulte [Stopping and Starting an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/start-db-cluster.html)la *Referencia de AWS CLI comandos*.
### `stop-db-cluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `stop-db-cluster`.
**AWS CLI**
**Detención de un clúster de Amazon DocumentDB que está ejecutándose**
En el siguiente ejemplo de `stop-db-cluster`, se detiene el clúster de Amazon DocumentDB especificado.
```
aws docdb stop-db-cluster \
--db-cluster-identifier sample-cluster
```
Salida:
```
{
"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 obtener más información, consulte [Stopping and Starting an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) en la *Guía para desarrolladores de Amazon DocumentDB.*
+ Para obtener más información sobre la API, consulte [StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/stop-db-cluster.html)la *Referencia de AWS CLI comandos*.