Esempi di utilizzo di Amazon DocumentDB AWS CLI - AWS Command Line Interface

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Esempi di utilizzo di Amazon DocumentDB AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando Amazon DocumentDB. AWS Command Line Interface

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Il seguente esempio di codice mostra come usareadd-tags-to-resource.

AWS CLI

Come aggiungere uno o più tag a una risorsa specificata

L’esempio add-tags-to-resource seguente aggiunge tre tag a sample-cluster. Un tag (CropB) ha un nome di chiave ma nessun valore.

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"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging delle risorse Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzareapply-pending-maintenance-action.

AWS CLI

Come fare in modo che le operazioni di manutenzione in sospeso vengano eseguite durante la finestra di manutenzione successiva

L’esempio apply-pending-maintenance-action seguente fa in modo che tutte le operazioni di aggiornamento del sistema vengano eseguite durante la successiva finestra di manutenzione pianificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Applicazione degli aggiornamenti di Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarecopy-db-cluster-parameter-group.

AWS CLI

Come duplicare un gruppo di parametri di un cluster di database esistente

L’esempio copy-db-cluster-parameter-group seguente crea una copia del gruppo di parametri custom-docdb3-6 denominata custom-docdb3-6-copy. Quando crea la copia, aggiunge tag al nuovo gruppo di parametri.

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"

Output:

{ "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" } }

Per ulteriori informazioni, consulta Copia di un gruppo di parametri del cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarecopy-db-cluster-snapshot.

AWS CLI

Come creare una copia di uno snapshot

L’esempio seguente dell’copy-db-cluster-snapshot copia sample-cluster-snapshot e assegna il nome sample-cluster-snapshot-copy. La copia contiene tutti i tag dell’originale più un nuovo tag con il nome della chiave 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"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Copia di una snapshot del cluster nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarecreate-db-cluster-parameter-group.

AWS CLI

Come creare un gruppo di parametri di un cluster Amazon DocumentDB

L’esempio create-db-cluster-parameter-group seguente crea il gruppo di parametri del cluster di database sample-parameter-group utilizzando la famiglia 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"

Output:

{ "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" } }

Per ulteriori informazioni, consulta Creazione di un gruppo di parametri del cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarecreate-db-cluster-snapshot.

AWS CLI

Come creare uno snapshot manuale di un cluster Amazon DocumentDB

L'create-db-cluster-snapshotesempio seguente crea uno snapshot del cluster Amazon DB denominato sample-cluster-snapshot.

aws docdb create-db-cluster-snapshot \ --db-cluster-identifier sample-cluster \ --db-cluster-snapshot-identifier sample-cluster-snapshot

Output:

{ "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" } }

Per ulteriori informazioni, consulta Creazione manuale di uno snapshot del cluster nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarecreate-db-cluster.

AWS CLI

Come creare un cluster Amazon DocumentDB

L’esempio create-db-cluster seguente crea un cluster Amazon DocumentDB denominato sample-cluster con la finestra di manutenzione preferita impostata sulla domenica tra le 20:30 e le 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

Output:

{ "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" } }

Per ulteriori informazioni, consulta Creazione di un cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarecreate-db-instance.

AWS CLI

Come creare un’istanza in un cluster Amazon DocumentDB

Il codice di esempio create-db-instance seguente crea l’istanza sample-cluster-instance-2 nel 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

Output:

{ "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" } }

Per ulteriori informazioni, consulta Aggiunta di un’istanza Amazon DocumentDB a un cluster nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarecreate-db-subnet-group.

AWS CLI

Come creare un gruppo di sottoreti di Amazon DocumentDB

L’esempio create-db-subnet-group seguente crea un gruppo di sottoreti di Amazon DocumentDB denominato 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"

Output:

{ "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" } } ] } }

Per ulteriori informazioni, consulta Creazione di un gruppo di sottoreti Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredelete-db-cluster-parameter-group.

AWS CLI

Come eliminare un gruppo di parametri di un cluster Amazon DocumentDB

L’esempio delete-db-cluster-parameter-group seguente elimina il gruppo di parametri sample-parameter-group di Amazon DocumentDB.

aws docdb delete-db-cluster-parameter-group \ --db-cluster-parameter-group-name sample-parameter-group

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Eliminazione di un gruppo di parametri del cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredelete-db-cluster-snapshot.

AWS CLI

Come eliminare uno snapshot di un cluster Amazon DocumentDB

L’esempio delete-db-cluster-snapshot seguente elimina lo snapshot sample-cluster-snapshot del cluster Amazon DocumentDB.

aws docdb delete-db-cluster-snapshot \ --db-cluster-snapshot-identifier sample-cluster-snapshot

Output:

{ "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 } }

Per ulteriori informazioni, consulta Eliminazione di una snapshot del cluster nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredelete-db-cluster.

AWS CLI

Come eliminare un cluster Amazon DocumentDB

L’esempio delete-db-cluster seguente elimina il cluster Amazon DocumentDB sample-cluster. Non viene eseguito alcun backup del cluster prima di eliminarlo. NOTA: è necessario scaricare tutte le istanze associate al cluster prima di poterlo eliminare.

aws docdb delete-db-cluster \ --db-cluster-identifier sample-cluster \ --skip-final-snapshot

Output:

{ "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": [] } }

Per ulteriori informazioni, consulta Eliminazione di un cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredelete-db-instance.

AWS CLI

Come eliminare un’istanza Amazon DocumentDB

L’esempio delete-db-instance seguente elimina l’istanza Amazon DocumentDB sample-cluster-instance-2.

aws docdb delete-db-instance \ --db-instance-identifier sample-cluster-instance-2

Output:

{ "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 } }

Per ulteriori informazioni, consulta Eliminazione di un’istanza Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredelete-db-subnet-group.

AWS CLI

Come eliminare un gruppo di sottoreti di Amazon DocumentDB

L’esempio delete-db-subnet-group seguente elimina il gruppo di sottoreti sample-subnet-group di Amazon DocumentDB.

aws docdb delete-db-subnet-group \ --db-subnet-group-name sample-subnet-group

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Eliminazione di un gruppo di sottoreti Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-db-cluster-parameter-groups.

AWS CLI

Come visualizzare i dettagli di uno o più gruppi di parametri del cluster Amazon DocumentDB

L’esempio describe-db-cluster-parameter-groups seguente visualizza i dettagli del gruppo di parametri custom3-6-param-grp del cluster Amazon DocumentDB.

aws docdb describe-db-cluster-parameter-groups \ --db-cluster-parameter-group-name custom3-6-param-grp

Output:

{ "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" } ] }

Per ulteriori informazioni, consulta Visualizzazione di un gruppo di parametri del cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-db-cluster-parameters.

AWS CLI

Come visualizzare l’elenco dettagliato dei parametri di un gruppo di parametri del cluster Amazon DocumentDB.

L’esempio describe-db-cluster-parameters seguente elenca i parametri per il gruppo di parametri custom3-6-param-grp di Amazon DocumentDB.

aws docdb describe-db-cluster-parameters \ --db-cluster-parameter-group-name custom3-6-param-grp

Output:

{ "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" } ] }

Per ulteriori informazioni, consulta Visualizzazione dei parametri del cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-db-cluster-snapshot-attributes.

AWS CLI

Come elencare i nomi e i valori degli attributi di uno snapshot di Amazon DocumentDB

L’esempio describe-db-cluster-snapshot-attributes seguente elenca i nomi e i valori degli attributi per lo snapshot sample-cluster-snapshot di Amazon DocumentDB.

aws docdb describe-db-cluster-snapshot-attributes \ --db-cluster-snapshot-identifier sample-cluster-snapshot

Output:

{ "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } }

Per ulteriori informazioni, consulta Descrivi DBCluster SnapshotAttributes nella Amazon DocumentDB Developer Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-db-cluster-snapshots.

AWS CLI

Come descrivere gli snapshot di Amazon DocumentDB

L’esempio describe-db-cluster-snapshots seguente visualizza i dettagli dello snapshot sample-cluster-snapshot di Amazon DocumentDB.

aws docdb describe-db-cluster-snapshots \ --db-cluster-snapshot-identifier sample-cluster-snapshot

Output:

{ "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" } ] }

Per ulteriori informazioni, consulta Descrivi le DBCluster istantanee nella Amazon DocumentDB Developer Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-db-clusters.

AWS CLI

Come ottenere informazioni dettagliate su uno o più cluster Amazon DocumentDB.

L’esempio describe-db-clusters seguente visualizza i dettagli del cluster Amazon DocumentDB sample-cluster. Se si omette il parametro --db-cluster-identifier, è possibile ottenere informazioni su un massimo di 100 cluster.

aws docdb describe-db-clusters --db-cluster-identifier sample-cluster

Output:

{ "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" } ] }

Per ulteriori informazioni, consulta Descrizione dei cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-db-engine-versions.

AWS CLI

Come elencare le versioni disponibili del motore Amazon DocumentDB

L’esempio describe-db-engine-versions seguente elenca tutte le versioni disponibili del motore Amazon DocumentDB.

aws docdb describe-db-engine-versions \ --engine docdb

Output:

{ "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" ] } ] }

Per ulteriori informazioni, consulta Descrivi DBEngine le versioni nella Amazon DocumentDB Developer Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-db-instances.

AWS CLI

Come ottenere informazioni sulle istanze Amazon DocumentDB con provisioning

L’esempio describe-db-instances seguente visualizza informazioni dettagliate sull’istanza Amazon DocumentDB sample-cluster-instance. Se si omette il parametro --db-instance-identifier, vengono restituite informazioni su un massimo di 100 istanze.

aws docdb describe-db-instances \ --db-instance-identifier sample-cluster-instance

Output:

{ "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" } ] }

Per ulteriori informazioni, consulta Descrizione delle istanze Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-db-subnet-groups.

AWS CLI

Come recuperare un elenco di descrizioni delle sottoreti Amazon DocumentDB

L’esempio describe-db-subnet-groups seguente descrive i dettagli per la sottorete Amazon DocumentDB denominata default.

aws docdb describe-db-subnet-groups \ --db-subnet-group-name default

Output:

{ "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" } ] }

Per ulteriori informazioni, consulta Descrizione dei gruppi di sottoreti nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-engine-default-cluster-parameters.

AWS CLI

Come descrivere il motore predefinito e ottenere informazioni sui parametri di sistema per Amazon DocumentDB

L’esempio describe-engine-default-cluster-parameters seguente visualizza i dettagli del motore predefinito e informazioni sui parametri di sistema per il gruppo di parametri docdb3.6 di Amazon DocumentDB.

aws docdb describe-engine-default-cluster-parameters \ --db-parameter-group-family docdb3.6

Output:

{ "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 } ] } }

Per ulteriori informazioni, consulta DescribeEngineDefaultClusterParametersla Amazon DocumentDB Developer Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-event-categories.

AWS CLI

Come descrivere tutte le categorie di eventi di Amazon DocumentDB

L’esempio describe-event-categories seguente elenca tutte le categorie per il tipo di origine evento db-instance di Amazon DocumentDB.

aws docdb describe-event-categories \ --source-type db-cluster

Output:

{ "EventCategoriesMapList": [ { "SourceType": "db-cluster", "EventCategories": [ "failover", "maintenance", "notification", "failure" ] } ] }

Per ulteriori informazioni, consulta Visualizzazione delle categorie di eventi nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-events.

AWS CLI

Come elencare gli eventi di Amazon DocumentDB

L’esempio describe-events seguente elenca tutti gli eventi di Amazon DocumentDB delle ultime 24 ore (1440 minuti).

aws docdb describe-events \ --duration 1440

Questo comando non produce alcun output. Output:

{ "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" } ] }

Per ulteriori informazioni, consulta Visualizzazione degli eventi Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-orderable-db-instance-options.

AWS CLI

Come trovare le opzioni delle istanze Amazon DocumentDB che è possibile ordinare

L’esempio describe-orderable-db-instance-options seguente elenca tutte le opzioni delle istanze per Amazon DocumentDB per una Regione.

aws docdb describe-orderable-db-instance-options \ --engine docdb \ --region us-east-1

Output:

{ "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" } ] }

Per ulteriori informazioni, consulta Aggiunta di un’istanza Amazon DocumentDB a un cluster nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaredescribe-pending-maintenance-actions.

AWS CLI

Come elencare le operazioni di manutenzione di Amazon DocumentDB in sospeso

L’esempio describe-pending-maintenance-actions seguente elenca tutte le operazioni di manutenzione di Amazon DocumentDB in sospeso.

aws docdb describe-pending-maintenance-actions

Output:

{ "PendingMaintenanceActions": [] }

Per ulteriori informazioni, consulta Gestione di Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarefailover-db-cluster.

AWS CLI

Come forzare il failover di un cluster Amazon DocumentDB su una replica

L’esempio failover-db-cluster seguente determina il failover dell’istanza primaria nel cluster Amazon DocumentDB sample-cluster su una replica.

aws docdb failover-db-cluster \ --db-cluster-identifier sample-cluster

Output:

{ "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" } }

Per ulteriori informazioni, consulta Failover di Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Come elencare tutti i tag su una risorsa Amazon DocumentDB

L’esempio list-tags-for-resource seguente elimina tutti i tag sul cluster Amazon DocumentDB sample-cluster.

aws docdb list-tags-for-resource \ --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster

Output:

{ "TagList": [ { "Key": "A", "Value": "ALPHA" }, { "Key": "B", "Value": "" }, { "Key": "C", "Value": "CHARLIE" } ] }

Per ulteriori informazioni, consulta Elenco dei tag in una risorsa Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaremodify-db-cluster-parameter-group.

AWS CLI

Come modificare un gruppo di parametri del cluster di database Amazon DocumentDB

L’esempio modify-db-cluster-parameter-group seguente modifica il gruppo di parametri custom3-6-param-grp del cluster Amazon DocumentDB impostando i due parametri audit_logs e ttl_monitor come abilitati. Le modifiche vengono applicate al riavvio successivo.

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

Output:

{ "DBClusterParameterGroupName": "custom3-6-param-grp" }

Per ulteriori informazioni, consulta Modifica di un gruppo di parametri del cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaremodify-db-cluster-snapshot-attribute.

AWS CLI

Esempio 1: come aggiungere un attributo a uno snapshot di Amazon DocumentDB

L’esempio modify-db-cluster-snapshot-attribute seguente aggiunge quattro valori di attributo a uno snapshot del 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

Output:

{ "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789011", "123456789012", "123456789013" ] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } }

Esempio 2: come rimuovere un attributo da uno snapshot di Amazon DocumentDB

L’esempio modify-db-cluster-snapshot-attribute seguente rimuove due valori di attributo da uno snapshot del cluster Amazon DocumentDB.

aws docdb modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifier sample-cluster-snapshot \ --attribute-name restore \ --values-to-remove 123456789012

Output:

{ "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789011", "123456789013" ] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } }

Per ulteriori informazioni, consulta Modify DBCluster SnapshotAttribute nella Amazon DocumentDB Developer Guide.

Il seguente esempio di codice mostra come utilizzaremodify-db-cluster.

AWS CLI

Come modificare un cluster Amazon DocumentDB

L’esempio modify-db-cluster seguente modifica il cluster Amazon DocumentDB sample-cluster impostando un periodo di conservazione per i backup automatici di 7 giorni e cambiando le finestre preferite per i backup e per la manutenzione. Tutte le modifiche vengono applicate nella finestra di manutenzione successiva.

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

Output:

{ "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 } }

Per ulteriori informazioni, consulta Modifica di un cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaremodify-db-instance.

AWS CLI

Come modificare un’istanza Amazon DocumentDB

L’esempio modify-db-instance seguente modifica l’istanza sample-cluster2 di Amazon DocumentDB cambiando la relativa classe di istanza in db.r4.4xlarge e il relativo livello di promozione in 5. Le modifiche vengono applicate immediatamente, ma sono visibili solo quando lo stato dell’istanza è disponibile.

aws docdb modify-db-instance \ --db-instance-identifier sample-cluster2 \ --apply-immediately \ --db-instance-class db.r4.4xlarge \ --promotion-tier 5

Output:

{ "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" } }

Per ulteriori informazioni, consulta Modifica di un’istanza Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzaremodify-db-subnet-group.

AWS CLI

Come modificare un gruppo di sottoreti di Amazon DocumentDB

L’esempio modify-db-subnet-group seguente modifica il gruppo di sottoreti sample-subnet-group aggiungendo le sottoreti specificate e una nuova descrizione.

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"

Output:

{ "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" } } ] } }

Per ulteriori informazioni, consulta Modifica di un gruppo di sottoreti Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarereboot-db-instance.

AWS CLI

Come riavviare un’istanza Amazon DocumentDB

L’esempio reboot-db-instance seguente riavvia l’istanza Amazon DocumentDB sample-cluster2.

aws docdb reboot-db-instance \ --db-instance-identifier sample-cluster2

Questo comando non produce alcun output. Output:

{ "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" } }

Per ulteriori informazioni, consulta Rebooting an Amazon DocumentDB nella Amazon ILnstance DocumentDB Developer Guide.

Il seguente esempio di codice mostra come utilizzareremove-tags-from-resource.

AWS CLI

Come rimuovere tag da una risorsa Amazon DocumentDB

L’esempio remove-tags-from-resource seguente rimuove il tag con la chiave denominata B dal 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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Removing tags from an Amazon Document DBResource nella Amazon DocumentDB Developer Guide.

Il seguente esempio di codice mostra come utilizzarereset-db-cluster-parameter-group.

AWS CLI

Come ripristinare il valore predefinito del parametro specificato in un gruppo di parametri di Amazon DocumentDB

L’esempio reset-db-cluster-parameter-group seguente ripristina il valore predefinito del parametro ttl_monitor nel gruppo di parametri custom3-6-param-grp di Amazon DocumentDB.

aws docdb reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --parameters ParameterName=ttl_monitor,ApplyMethod=immediate

Output:

{ "DBClusterParameterGroupName": "custom3-6-param-grp" }

Per ulteriori informazioni, consulta la Guida per gli sviluppatori di Amazon DocumentDB.

Come ripristinare il valore predefinito del parametro specificato o di tutti i parametri in un gruppo di parametri di Amazon DocumentDB

L’esempio reset-db-cluster-parameter-group seguente ripristina il valore predefinito di tutti i parametri nel gruppo di parametri custom3-6-param-grp di Amazon DocumentDB.

aws docdb reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --reset-all-parameters

Output:

{ "DBClusterParameterGroupName": "custom3-6-param-grp" }

Per ulteriori informazioni, consulta Reimpostazione di un gruppo di parametri del cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarerestore-db-cluster-from-snapshot.

AWS CLI

Come ripristinare un cluster Amazon DocumentDB da uno snapshot automatico o manuale

L’esempio restore-db-cluster-from-snapshot seguente crea un nuovo cluster Amazon DocumentDB denominato sample-cluster-2019-03-16-00-01-restored dallo snapshot rds:sample-cluster-2019-03-16-00-01.

aws docdb restore-db-cluster-from-snapshot \ --db-cluster-identifier sample-cluster-2019-03-16-00-01-restored \ --engine docdb \ --snapshot-identifier rds:sample-cluster-2019-03-16-00-01

Output:

{ "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" } ] } }

Per ulteriori informazioni, consulta Ripristino da uno snapshot del cluster nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarerestore-db-cluster-to-point-in-time.

AWS CLI

Per ripristinare un cluster Amazon DocumentDB point-in-time da uno snapshot manuale

L’esempio restore-db-cluster-to-point-in-time seguente utilizza sample-cluster-snapshot per creare un nuovo cluster Amazon DocumentDBsample-cluster-pit utilizzando l’orario di ripristino più recente.

aws docdb restore-db-cluster-to-point-in-time \ --db-cluster-identifier sample-cluster-pit \ --source-db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ --use-latest-restorable-time

Output:

{ "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" } }

Per ulteriori informazioni, consulta Ripristino di uno snapshot a un point-in-time (PITR) nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarestart-db-cluster.

AWS CLI

Come avviare un cluster Amazon DocumentDB arrestato

L’esempio start-db-cluster seguente elimina il cluster Amazon DocumentDB specificato.

aws docdb start-db-cluster \ --db-cluster-identifier sample-cluster

Output:

{ "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" } ] } }

Per ulteriori informazioni, consulta Arresto e avvio di un cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.

Il seguente esempio di codice mostra come utilizzarestop-db-cluster.

AWS CLI

Come arrestare un cluster Amazon DocumentDB in esecuzione

L’esempio stop-db-cluster seguente arresta il cluster Amazon DocumentDB specificato.

aws docdb stop-db-cluster \ --db-cluster-identifier sample-cluster

Output:

{ "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" } ] } }

Per ulteriori informazioni, consulta Arresto e avvio di un cluster Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.