Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Exemples d'Amazon DocumentDB utilisant AWS CLI
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l' AWS Command Line Interface aide d'Amazon DocumentDB.
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.
**Topics**
+ [Actions](#actions)
## Actions
### `add-tags-to-resource`
L'exemple de code suivant montre comment utiliser`add-tags-to-resource`.
**AWS CLI**
**Pour ajouter une ou plusieurs balises à une ressource spécifiée**
L’exemple `add-tags-to-resource` suivant ajoute trois balises à `sample-cluster`. Une balise (`CropB`) possède un nom de clé mais aucune valeur.
```
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"
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Balisage des ressources Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/add-tags-to-resource.html)à la section *Référence des AWS CLI commandes*.
### `apply-pending-maintenance-action`
L'exemple de code suivant montre comment utiliser`apply-pending-maintenance-action`.
**AWS CLI**
**Pour que les actions de maintenance en attente aient lieu au cours de la fenêtre de maintenance suivante**
L’exemple `apply-pending-maintenance-action` suivant montre comment toutes les actions de mise à jour du système sont exécutées lors de la prochaine fenêtre de maintenance planifiée.
```
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
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Application des mises à jour Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#db-instance-updates-apply) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html)à la section *Référence des AWS CLI commandes*.
### `copy-db-cluster-parameter-group`
L'exemple de code suivant montre comment utiliser`copy-db-cluster-parameter-group`.
**AWS CLI**
**Pour dupliquer un groupe de paramètres de cluster DB existant**
L’exemple `copy-db-cluster-parameter-group` suivant fait une copie d’un groupe de paramètres `custom-docdb3-6` nommé `custom-docdb3-6-copy`. Lorsque vous faites la copie, il ajoute des balises au nouveau groupe de paramètres.
```
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"
```
Sortie :
```
{
"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"
}
}
```
Pour plus d’informations, consultez [Copie d’un groupe de paramètres de cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-copy.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-parameter-group.html)à la section *Référence des AWS CLI commandes*.
### `copy-db-cluster-snapshot`
L'exemple de code suivant montre comment utiliser`copy-db-cluster-snapshot`.
**AWS CLI**
**Pour faire une copie d’un instantané**
L’exemple `copy-db-cluster-snapshot` suivant fait une copie d’un `sample-cluster-snapshot` nommée `sample-cluster-snapshot-copy`. La copie contient toutes les balises de l’original, plus une nouvelle balise avec le nom de la clé `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"
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Copie d’un instantané de cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-copy.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-snapshot.html)à la section *Référence des AWS CLI commandes*.
### `create-db-cluster-parameter-group`
L'exemple de code suivant montre comment utiliser`create-db-cluster-parameter-group`.
**AWS CLI**
**Pour créer un groupe de paramètres de cluster Amazon DocumentDB**
L’exemple `create-db-cluster-parameter-group` suivant crée le groupe de paramètres de cluster DB `sample-parameter-group` à l’aide de la famille `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"
```
Sortie :
```
{
"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"
}
}
```
Pour plus d’informations, consultez [Création d’un groupe de paramètres de cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-parameter-group.html)à la section *Référence des AWS CLI commandes*.
### `create-db-cluster-snapshot`
L'exemple de code suivant montre comment utiliser`create-db-cluster-snapshot`.
**AWS CLI**
**Pour créer un instantané de cluster Amazon DocumentDB manuel**
L'`create-db-cluster-snapshot`exemple suivant crée un instantané de cluster Amazon DB nommé sample-cluster-snapshot.
```
aws docdb create-db-cluster-snapshot \
--db-cluster-identifier sample-cluster \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Sortie :
```
{
"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"
}
}
```
Pour plus d’informations, consultez [Création d’un instantané manuel d’un cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-create.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-snapshot.html)à la section *Référence des AWS CLI commandes*.
### `create-db-cluster`
L'exemple de code suivant montre comment utiliser`create-db-cluster`.
**AWS CLI**
**Pour créer un cluster Amazon DocumentDB**
L’exemple `create-db-cluster` suivant crée un cluster Amazon DocumentDB nommé `sample-cluster` avec la fenêtre de maintenance préférée le dimanche entre 20 h 30 et 11 h.
```
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
```
Sortie :
```
{
"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"
}
}
```
Pour plus d’informations, consultez [Création d’un cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-create.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster.html)à la section *Référence des AWS CLI commandes*.
### `create-db-instance`
L'exemple de code suivant montre comment utiliser`create-db-instance`.
**AWS CLI**
**Pour créer une instance de cluster Amazon DocumentDB**
L’exemple `create-db-instance` de code suivant crée l’instance `sample-cluster-instance-2` dans le cluster 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
```
Sortie :
```
{
"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"
}
}
```
Pour plus d’informations, consultez [Ajout d’une instance Amazon DocumentDB à un cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [CreateDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-instance.html)à la section *Référence des AWS CLI commandes*.
### `create-db-subnet-group`
L'exemple de code suivant montre comment utiliser`create-db-subnet-group`.
**AWS CLI**
**Pour créer un groupe de sous-réseaux Amazon DocumentDB**
L’exemple `create-db-subnet-group` suivant crée un groupe de sous-réseaux Amazon DocumentDB nommé `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"
```
Sortie :
```
{
"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"
}
}
]
}
}
```
Pour plus d’informations, consultez [Création d’un groupe de sous-réseaux Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-create) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-subnet-group.html)à la section *Référence des AWS CLI commandes*.
### `delete-db-cluster-parameter-group`
L'exemple de code suivant montre comment utiliser`delete-db-cluster-parameter-group`.
**AWS CLI**
**Pour supprimer un groupe de paramètres de cluster Amazon DocumentDB**
L’exemple `delete-db-cluster-parameter-group` suivant supprime le groupe de paramètres Amazon DocumentDB `sample-parameter-group`.
```
aws docdb delete-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Deleting an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-delete.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-parameter-group.html)à la section *Référence des AWS CLI commandes*.
### `delete-db-cluster-snapshot`
L'exemple de code suivant montre comment utiliser`delete-db-cluster-snapshot`.
**AWS CLI**
**Pour supprimer un instantané de cluster Amazon DocumentDB**
L’exemple `delete-db-cluster-snapshot` suivant supprime l’instantané `sample-cluster-snapshot` du cluster Amazon DocumentDB.
```
aws docdb delete-db-cluster-snapshot \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Sortie :
```
{
"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
}
}
```
Pour plus d’informations, consultez [Suppression d’un instantané de cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-delete.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-snapshot.html)à la section *Référence des AWS CLI commandes*.
### `delete-db-cluster`
L'exemple de code suivant montre comment utiliser`delete-db-cluster`.
**AWS CLI**
**Pour supprimer un cluster Amazon DocumentDB**
L’exemple `delete-db-cluster` suivant supprime le cluster Amazon DocumentDB `sample-cluster`. Aucune sauvegarde du cluster n’est effectuée avant sa suppression. REMARQUE : vous devez supprimer toutes les instances associées au cluster avant de pouvoir le supprimer.
```
aws docdb delete-db-cluster \
--db-cluster-identifier sample-cluster \
--skip-final-snapshot
```
Sortie :
```
{
"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": []
}
}
```
Pour plus d’informations, consultez [Suppression d’un cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-delete.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster.html)à la section *Référence des AWS CLI commandes*.
### `delete-db-instance`
L'exemple de code suivant montre comment utiliser`delete-db-instance`.
**AWS CLI**
**Pour supprimer une instance Amazon DocumentDB**
L’exemple `delete-db-instance` suivant supprime l’instance Amazon DocumentDB `sample-cluster-instance-2`.
```
aws docdb delete-db-instance \
--db-instance-identifier sample-cluster-instance-2
```
Sortie :
```
{
"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
}
}
```
Pour plus d’informations, consultez [Suppression d’une instance Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-delete.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DeleteDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-instance.html)à la section *Référence des AWS CLI commandes*.
### `delete-db-subnet-group`
L'exemple de code suivant montre comment utiliser`delete-db-subnet-group`.
**AWS CLI**
**Pour supprimer un groupe de sous-réseaux Amazon DocumentDB**
L’exemple `delete-db-subnet-group` suivant supprime le groupe de sous-réseaux Amazon DocumentDB `sample-subnet-group`.
```
aws docdb delete-db-subnet-group \
--db-subnet-group-name sample-subnet-group
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Suppression d’un groupe de sous-réseaux Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-delete) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-subnet-group.html)à la section *Référence des AWS CLI commandes*.
### `describe-db-cluster-parameter-groups`
L'exemple de code suivant montre comment utiliser`describe-db-cluster-parameter-groups`.
**AWS CLI**
**Pour afficher les détails d’un ou de plusieurs groupes de paramètres de cluster Amazon DocumentDB**
L’exemple `describe-db-cluster-parameter-groups` suivant affiche les détails du groupe de paramètres de cluster Amazon DocumentDB `custom3-6-param-grp`.
```
aws docdb describe-db-cluster-parameter-groups \
--db-cluster-parameter-group-name custom3-6-param-grp
```
Sortie :
```
{
"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"
}
]
}
```
Pour plus d’informations, consultez [Affichage des groupes de paramètres de cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-describe.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameter-groups.html)à la section *Référence des AWS CLI commandes*.
### `describe-db-cluster-parameters`
L'exemple de code suivant montre comment utiliser`describe-db-cluster-parameters`.
**AWS CLI**
**Pour afficher la liste détaillée des paramètres d’un groupe de paramètres de cluster Amazon DocumentDB**
L’exemple `describe-db-cluster-parameters` suivant répertorie les paramètres du groupe de paramètres Amazon DocumentDB custom3-6-param-grp.
```
aws docdb describe-db-cluster-parameters \
--db-cluster-parameter-group-name custom3-6-param-grp
```
Sortie :
```
{
"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"
}
]
}
```
Pour plus d’informations, consultez [Affichage des paramètres de cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameters-describe.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameters.html)à la section *Référence des AWS CLI commandes*.
### `describe-db-cluster-snapshot-attributes`
L'exemple de code suivant montre comment utiliser`describe-db-cluster-snapshot-attributes`.
**AWS CLI**
**Pour répertorier les noms et les valeurs d’attributs d’un instantané Amazon DocumentDB**
L’exemple `describe-db-cluster-snapshot-attributes` suivant répertorie les noms et les valeurs d’attributs pour l’instantané Amazon DocumentDB `sample-cluster-snapshot`.
```
aws docdb describe-db-cluster-snapshot-attributes \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Sortie :
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": []
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
Pour plus d'informations, consultez la section [Describe DBCluster SnapshotAttributes](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshotAttributes.html) dans le guide du *développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshot-attributes.html)à la section *Référence des AWS CLI commandes*.
### `describe-db-cluster-snapshots`
L'exemple de code suivant montre comment utiliser`describe-db-cluster-snapshots`.
**AWS CLI**
**Pour décrire les instantanés Amazon DocumentDB**
L’exemple `describe-db-cluster-snapshots` suivant affiche les détails de l’instantané Amazon DocumentDB `sample-cluster-snapshot`.
```
aws docdb describe-db-cluster-snapshots \
--db-cluster-snapshot-identifier sample-cluster-snapshot
```
Sortie :
```
{
"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"
}
]
}
```
Pour plus d'informations, consultez la section [Décrire les DBCluster instantanés](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshots.html) dans le manuel *Amazon DocumentDB* Developer Guide.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshots.html)à la section *Référence des AWS CLI commandes*.
### `describe-db-clusters`
L'exemple de code suivant montre comment utiliser`describe-db-clusters`.
**AWS CLI**
**Pour obtenir des informations détaillées sur un ou plusieurs clusters Amazon DocumentDB**
L’exemple `describe-db-clusters` suivant affiche les détails du cluster Amazon DocumentDB `sample-cluster`. En omettant le paramètre `--db-cluster-identifier`, vous pouvez obtenir des informations sur un maximum de 100 clusters.
```
aws docdb describe-db-clusters
--db-cluster-identifier sample-cluster
```
Sortie :
```
{
"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"
}
]
}
```
Pour plus d’informations, consultez [Description des clusters Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-view-details.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-clusters.html)à la section *Référence des AWS CLI commandes*.
### `describe-db-engine-versions`
L'exemple de code suivant montre comment utiliser`describe-db-engine-versions`.
**AWS CLI**
**Pour répertorier les versions du moteur Amazon DocumentDB disponibles**
L’exemple `describe-db-engine-versions` suivant répertorie toutes les versions disponibles du moteur Amazon DocumentDB.
```
aws docdb describe-db-engine-versions \
--engine docdb
```
Sortie :
```
{
"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"
]
}
]
}
```
Pour plus d'informations, consultez la section [Décrire DBEngine les versions](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBEngineVersions.html) dans le manuel *Amazon DocumentDB Developer Guide*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDbEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-engine-versions.html)à la section *Référence des AWS CLI commandes*.
### `describe-db-instances`
L'exemple de code suivant montre comment utiliser`describe-db-instances`.
**AWS CLI**
**Pour obtenir les informations sur les instances Amazon DocumentDB provisionnées**
L’exemple `describe-db-instances` suivant affiche les détails de l’instance Amazon DocumentDB `sample-cluster-instance`. En omettant le paramètre `--db-instance-identifier`, vous obtenez des informations sur un maximum de 100 instances.
```
aws docdb describe-db-instances \
--db-instance-identifier sample-cluster-instance
```
Sortie :
```
{
"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"
}
]
}
```
Pour plus d’informations, consultez [Description des instances Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-view-details.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-instances.html)à la section *Référence des AWS CLI commandes*.
### `describe-db-subnet-groups`
L'exemple de code suivant montre comment utiliser`describe-db-subnet-groups`.
**AWS CLI**
**Pour récupérer une liste des descriptions de sous-réseaux Amazon DocumentDB**
L’exemple `describe-db-subnet-groups` suivant décrit les détails du sous-réseau Amazon DocumentDB nommé `default`.
```
aws docdb describe-db-subnet-groups \
--db-subnet-group-name default
```
Sortie :
```
{
"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"
}
]
}
```
Pour plus d’informations, consultez [Description des groupes de sous-réseaux](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-groups-describe) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-subnet-groups.html)à la section *Référence des AWS CLI commandes*.
### `describe-engine-default-cluster-parameters`
L'exemple de code suivant montre comment utiliser`describe-engine-default-cluster-parameters`.
**AWS CLI**
**Pour décrire les informations sur les paramètres de moteur et système par défaut d’Amazon DocumentDB**
L’exemple `describe-engine-default-cluster-parameters` suivant affiche des informations sur les paramètres de moteur et système par défaut du groupe de paramètres Amazon DocumentDB `docdb3.6`.
```
aws docdb describe-engine-default-cluster-parameters \
--db-parameter-group-family docdb3.6
```
Sortie :
```
{
"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
}
]
}
}
```
Pour plus d'informations, consultez [DescribeEngineDefaultClusterParameters](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeEngineDefaultClusterParameters.html)le manuel *Amazon DocumentDB Developer Guide*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-engine-default-cluster-parameters.html)à la section *Référence des AWS CLI commandes*.
### `describe-event-categories`
L'exemple de code suivant montre comment utiliser`describe-event-categories`.
**AWS CLI**
**Pour décrire toutes les catégories d’événements Amazon DocumentDB**
L’exemple `describe-event-categories` suivant répertorie toutes les catégories du type de source d’événement Amazon DocumentDB `db-instance`.
```
aws docdb describe-event-categories \
--source-type db-cluster
```
Sortie :
```
{
"EventCategoriesMapList": [
{
"SourceType": "db-cluster",
"EventCategories": [
"failover",
"maintenance",
"notification",
"failure"
]
}
]
}
```
Pour plus d’informations, consultez [Affichage des catégories d’événement](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-event-categories) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-event-categories.html)à la section *Référence des AWS CLI commandes*.
### `describe-events`
L'exemple de code suivant montre comment utiliser`describe-events`.
**AWS CLI**
**Pour répertorier les événements Amazon DocumentDB**
L’exemple `describe-events` suivant répertorie tous les événements Amazon DocumentDB qui ont eu lieu au cours des dernières 24 heures (1 440 minutes).
```
aws docdb describe-events \
--duration 1440
```
Cette commande ne produit aucune sortie. Sortie :
```
{
"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"
}
]
}
```
Pour plus d’informations, consultez [Affichage des événements Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-events) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-events.html)à la section *Référence des AWS CLI commandes*.
### `describe-orderable-db-instance-options`
L'exemple de code suivant montre comment utiliser`describe-orderable-db-instance-options`.
**AWS CLI**
**Pour trouver les options d’instance Amazon DocumentDB que vous pouvez commander**
L’exemple `describe-orderable-db-instance-options` suivant répertorie toutes les options d’instance pour Amazon DocumentDB pour une région.
```
aws docdb describe-orderable-db-instance-options \
--engine docdb \
--region us-east-1
```
Sortie :
```
{
"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"
}
]
}
```
Pour plus d’informations, consultez [Ajout d’une instance Amazon DocumentDB à un cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeOrderableDbInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-orderable-db-instance-options.html)à la section *Référence des AWS CLI commandes*.
### `describe-pending-maintenance-actions`
L'exemple de code suivant montre comment utiliser`describe-pending-maintenance-actions`.
**AWS CLI**
**Pour répertorier vos actions de maintenance Amazon DocumentDB en attente**
L’exemple `describe-pending-maintenance-actions` suivant répertorie toutes vos actions de maintenance Amazon DocumentDB en attente.
```
aws docdb describe-pending-maintenance-actions
```
Sortie :
```
{
"PendingMaintenanceActions": []
}
```
Pour plus d’informations, consultez [Maintenance d’Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html)à la section *Référence des AWS CLI commandes*.
### `failover-db-cluster`
L'exemple de code suivant montre comment utiliser`failover-db-cluster`.
**AWS CLI**
**Pour forcer un cluster Amazon DocumentDB à basculer vers un réplica**
L’exemple `failover-db-cluster` suivant provoque le basculement de l’instance principale du cluster sample-cluster Amazon DocumentDB vers un réplica.
```
aws docdb failover-db-cluster \
--db-cluster-identifier sample-cluster
```
Sortie :
```
{
"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"
}
}
```
Pour plus d’informations, consultez [Basculement Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/failover.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [FailoverDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-db-cluster.html)à la section *Référence des AWS CLI commandes*.
### `list-tags-for-resource`
L'exemple de code suivant montre comment utiliser`list-tags-for-resource`.
**AWS CLI**
**Pour répertorier toutes les balises d’une ressource Amazon DocumentDB**
L’exemple `list-tags-for-resource` suivant répertorie toutes les balises du cluster Amazon DocumentDB `sample-cluster`.
```
aws docdb list-tags-for-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster
```
Sortie :
```
{
"TagList": [
{
"Key": "A",
"Value": "ALPHA"
},
{
"Key": "B",
"Value": ""
},
{
"Key": "C",
"Value": "CHARLIE"
}
]
}
```
Pour plus d’informations, consultez [Liste des balises sur une ressource Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-list) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/list-tags-for-resource.html)à la section *Référence des AWS CLI commandes*.
### `modify-db-cluster-parameter-group`
L'exemple de code suivant montre comment utiliser`modify-db-cluster-parameter-group`.
**AWS CLI**
**Pour modifier un groupe de paramètres du cluster de base de données Amazon DocumentDB**
L’exemple `modify-db-cluster-parameter-group` suivant modifie le groupe de paramètres `custom3-6-param-grp` du cluster Amazon DocumentDB en définissant les deux paramètres `audit_logs` et `ttl_monitor` sur Activé. Les modifications seront appliquées au prochain redémarrage.
```
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
```
Sortie :
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Pour plus d’informations, consultez [Modification d’un groupe de paramètres de cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-modify.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-parameter-group.html)à la section *Référence des AWS CLI commandes*.
### `modify-db-cluster-snapshot-attribute`
L'exemple de code suivant montre comment utiliser`modify-db-cluster-snapshot-attribute`.
**AWS CLI**
**Exemple 1 : pour ajouter un attribut à un instantané Amazon DocumentDB**
L’exemple `modify-db-cluster-snapshot-attribute` suivant ajoute quatre valeurs d’attribut à un instantané de cluster 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
```
Sortie :
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789012",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
**Exemple 2 : pour supprimer des attributs d’un instantané Amazon DocumentDB**
L’exemple `modify-db-cluster-snapshot-attribute` suivant supprime deux valeurs d’attribut d’un instantané de cluster Amazon DocumentDB.
```
aws docdb modify-db-cluster-snapshot-attribute \
--db-cluster-snapshot-identifier sample-cluster-snapshot \
--attribute-name restore \
--values-to-remove 123456789012
```
Sortie :
```
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
```
Pour plus d'informations, consultez [Modifier DBCluster SnapshotAttribute](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBClusterSnapshotAttribute.html) dans le manuel *Amazon DocumentDB Developer Guide*.
+ Pour plus de détails sur l'API, reportez-vous [ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-snapshot-attribute.html)à la section *Référence des AWS CLI commandes*.
### `modify-db-cluster`
L'exemple de code suivant montre comment utiliser`modify-db-cluster`.
**AWS CLI**
**Pour modifier un cluster Amazon DocumentDB**
L’exemple `modify-db-cluster` suivant modifie le cluster Amazon DocumentDB `sample-cluster` en fixant à 7 jours la période de rétention pour les sauvegardes automatiques et en modifiant les fenêtres préférées pour les sauvegardes et la maintenance. Toutes les modifications sont appliquées à la prochaine fenêtre de maintenance.
```
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
```
Sortie :
```
{
"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
}
}
```
Pour plus d’informations, consultez [Modification d’un cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-modify.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster.html)à la section *Référence des AWS CLI commandes*.
### `modify-db-instance`
L'exemple de code suivant montre comment utiliser`modify-db-instance`.
**AWS CLI**
**Pour modifier une instance Amazon DocumentDB**
L’exemple `modify-db-instance` suivant modifie l’instance Amazon DocumentDB `sample-cluster2` en remplaçant sa classe d’instance par `db.r4.4xlarge` et son niveau de promotion par `5`. Les modifications sont appliquées immédiatement mais ne sont visibles qu’une fois que le statut des instances est disponible.
```
aws docdb modify-db-instance \
--db-instance-identifier sample-cluster2 \
--apply-immediately \
--db-instance-class db.r4.4xlarge \
--promotion-tier 5
```
Sortie :
```
{
"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"
}
}
```
Pour plus d’informations, consultez [Modification d’une instance Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-modify.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [ModifyDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-instance.html)à la section *Référence des AWS CLI commandes*.
### `modify-db-subnet-group`
L'exemple de code suivant montre comment utiliser`modify-db-subnet-group`.
**AWS CLI**
**Pour modifier un groupe de sous-réseaux Amazon DocumentDB**
L’exemple `modify-db-subnet-group` suivant modifie le groupe de sous-réseaux `sample-subnet-group` en ajoutant les sous-réseaux spécifiés et une nouvelle description.
```
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"
```
Sortie :
```
{
"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"
}
}
]
}
}
```
Pour plus d’informations, consultez [Modification d’un groupe de sous-réseaux Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-modify) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-subnet-group.html)à la section *Référence des AWS CLI commandes*.
### `reboot-db-instance`
L'exemple de code suivant montre comment utiliser`reboot-db-instance`.
**AWS CLI**
**Pour redémarrer une instance Amazon DocumentDB**
L’exemple `reboot-db-instance` suivant redémarre l’instance Amazon DocumentDB `sample-cluster2`.
```
aws docdb reboot-db-instance \
--db-instance-identifier sample-cluster2
```
Cette commande ne produit aucune sortie. Sortie :
```
{
"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"
}
}
```
Pour plus d'informations, consultez la section [Redémarrage d'une base de données Amazon ILnstance DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-reboot.html) dans le manuel du développeur Amazon *DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [RebootDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reboot-db-instance.html)à la section *Référence des AWS CLI commandes*.
### `remove-tags-from-resource`
L'exemple de code suivant montre comment utiliser`remove-tags-from-resource`.
**AWS CLI**
**Pour supprimer des balises d’une ressource Amazon DocumentDB**
L’exemple `remove-tags-from-resource` suivant supprime la balise dont la clé est nommée `B` dans le cluster 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
```
Cette commande ne produit aucune sortie.
Pour plus d'informations, consultez [Supprimer des balises d'un document Amazon DBResource dans le manuel](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-remove) *Amazon DocumentDB Developer Guide*.
+ Pour plus de détails sur l'API, reportez-vous [RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/remove-tags-from-resource.html)à la section *Référence des AWS CLI commandes*.
### `reset-db-cluster-parameter-group`
L'exemple de code suivant montre comment utiliser`reset-db-cluster-parameter-group`.
**AWS CLI**
**Pour rétablir la valeur par défaut du paramètre spécifié dans un groupe de paramètres Amazon DocumentDB**
L’exemple `reset-db-cluster-parameter-group` suivant réinitialise le paramètre `ttl_monitor` dans le groupe de paramètres Amazon DocumentDB `custom3-6-param-grp` à sa valeur par défaut.
```
aws docdb reset-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--parameters ParameterName=ttl_monitor,ApplyMethod=immediate
```
Sortie :
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Pour plus d’informations, consultez la rubrique dans le *Guide du développeur Amazon DocumentDB*.
**Pour rétablir les valeurs par défaut spécifiées ou celles de tous les paramètres dans un groupe de paramètres Amazon DocumentDB**
L’exemple `reset-db-cluster-parameter-group` suivant réinitialise tous les paramètres du groupe de paramètres Amazon DocumentDB `custom3-6-param-grp` à leurs valeurs par défaut.
```
aws docdb reset-db-cluster-parameter-group \
--db-cluster-parameter-group-name custom3-6-param-grp \
--reset-all-parameters
```
Sortie :
```
{
"DBClusterParameterGroupName": "custom3-6-param-grp"
}
```
Pour plus d’informations, consultez [Réinitialisation d’un groupe de paramètres de cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-reset.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reset-db-cluster-parameter-group.html)à la section *Référence des AWS CLI commandes*.
### `restore-db-cluster-from-snapshot`
L'exemple de code suivant montre comment utiliser`restore-db-cluster-from-snapshot`.
**AWS CLI**
**Pour restaurer un cluster Amazon DocumentDB à partir d’un instantané automatique ou manuel**
L’exemple `restore-db-cluster-from-snapshot` suivant crée un nouveau cluster Amazon DocumentDB nommé `sample-cluster-2019-03-16-00-01-restored` à partir de l’instantané `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
```
Sortie :
```
{
"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"
}
]
}
}
```
Pour plus d’informations, consultez [Restauration d’un cluster à partir d’un instantané](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.restore-from-snapshot.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-from-snapshot.html)à la section *Référence des AWS CLI commandes*.
### `restore-db-cluster-to-point-in-time`
L'exemple de code suivant montre comment utiliser`restore-db-cluster-to-point-in-time`.
**AWS CLI**
**Pour restaurer un cluster Amazon DocumentDB à point-in-time partir d'un instantané manuel**
L’exemple `restore-db-cluster-to-point-in-time` suivant utilise `sample-cluster-snapshot` pour créer un nouveau cluster Amazon DocumentDB, `sample-cluster-pit`, en utilisant l’heure de restauration la plus récente.
```
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
```
Sortie :
```
{
"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"
}
}
```
Pour plus d’informations, consultez [Restauration d’un instantané à un instant dans le passé](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.point-in-time-recovery.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-to-point-in-time.html)à la section *Référence des AWS CLI commandes*.
### `start-db-cluster`
L'exemple de code suivant montre comment utiliser`start-db-cluster`.
**AWS CLI**
**Pour démarrer un cluster Amazon DocumentDB arrêté**
L’exemple `start-db-cluster` suivant affiche le cluster Amazon DocumentDB spécifié.
```
aws docdb start-db-cluster \
--db-cluster-identifier sample-cluster
```
Sortie :
```
{
"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"
}
]
}
}
```
Pour plus d’informations, consultez [Arrêt et démarrage d’un cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/start-db-cluster.html)à la section *Référence des AWS CLI commandes*.
### `stop-db-cluster`
L'exemple de code suivant montre comment utiliser`stop-db-cluster`.
**AWS CLI**
**Pour arrêter un cluster Amazon DocumentDB en cours d’exécution**
L’exemple `stop-db-cluster` suivant arrête le cluster Amazon DocumentDB spécifié.
```
aws docdb stop-db-cluster \
--db-cluster-identifier sample-cluster
```
Sortie :
```
{
"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"
}
]
}
}
```
Pour plus d’informations, consultez [Arrêt et démarrage d’un cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) dans le *Guide du développeur Amazon DocumentDB*.
+ Pour plus de détails sur l'API, reportez-vous [StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/stop-db-cluster.html)à la section *Référence des AWS CLI commandes*.