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-resourceseguente aggiunge tre tag asample-cluster. Un tag (CropB) ha un nome di chiave ma nessun valore.aws docdb add-tags-to-resource \ --resource-namearn: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.
-
Per i dettagli sull'API, consulta AddTagsToResource AWS CLI
Command Reference.
-
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-actionseguente 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-identifierarn:aws:rds:us-west-2:123456789012:cluster:sample-cluster\ --apply-actionsystem-update\ --opt-in-typenext-maintenanceQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Applicazione degli aggiornamenti di Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.
-
Per i dettagli sull'API, consulta ApplyPendingMaintenanceAction AWS CLI
Command Reference.
-
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-groupseguente crea una copia del gruppo di parametricustom-docdb3-6denominatacustom-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-identifiercustom-docdb3-6\ --target-db-cluster-parameter-group-identifiercustom-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.
-
Per i dettagli sull'API, consulta CopyDbClusterParameterGroup AWS CLI
Command Reference.
-
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-snapshotcopiasample-cluster-snapshote assegna il nomesample-cluster-snapshot-copy. La copia contiene tutti i tag dell’originale più un nuovo tag con il nome della chiaveCopyNumber.aws docdb copy-db-cluster-snapshot \ --source-db-cluster-snapshot-identifiersample-cluster-snapshot\ --target-db-cluster-snapshot-identifiersample-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.
-
Per i dettagli sull'API, consulta CopyDbClusterSnapshot AWS CLI
Command Reference.
-
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-groupseguente crea il gruppo di parametri del cluster di databasesample-parameter-grouputilizzando la famigliadocdb3.6.aws docdb create-db-cluster-parameter-group \ --db-cluster-parameter-group-namesample-parameter-group\ --db-parameter-group-familydocdb3.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.
-
Per i dettagli sull'API, consulta CreateDbClusterParameterGroup AWS CLI
Command Reference.
-
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-identifiersample-cluster\ --db-cluster-snapshot-identifiersample-cluster-snapshotOutput:
{ "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.
-
Per i dettagli sull'API, consulta CreateDbClusterSnapshot AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-db-cluster.
- AWS CLI
-
Come creare un cluster Amazon DocumentDB
L’esempio
create-db-clusterseguente crea un cluster Amazon DocumentDB denominatosample-clustercon la finestra di manutenzione preferita impostata sulla domenica tra le 20:30 e le 11:00.aws docdb create-db-cluster \ --db-cluster-identifiersample-cluster\ --enginedocdb\ --master-username master-user \ --master-user-passwordpassword \ --preferred-maintenance-windowSun:20:30-Sun:21:00Output:
{ "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.
-
Per i dettagli sull'API, consulta CreateDbCluster AWS CLI
Command Reference.
-
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-instanceseguente crea l’istanzasample-cluster-instance-2nel cluster Amazon DocumentDBsample-cluster.aws docdb create-db-instance \ --db-cluster-identifiersample-cluster\ --db-instance-classdb.r4.xlarge\ --db-instance-identifiersample-cluster-instance-2\ --enginedocdbOutput:
{ "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.
-
Per i dettagli sull'API, consulta CreateDbInstance AWS CLI
Command Reference.
-
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-groupseguente crea un gruppo di sottoreti di Amazon DocumentDB denominatosample-subnet-group.aws docdb create-db-subnet-group \ --db-subnet-group-description"a sample subnet group"\ --db-subnet-group-namesample-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.
-
Per i dettagli sull'API, consulta CreateDbSubnetGroup AWS CLI
Command Reference.
-
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-groupseguente elimina il gruppo di parametrisample-parameter-groupdi Amazon DocumentDB.aws docdb delete-db-cluster-parameter-group \ --db-cluster-parameter-group-namesample-parameter-groupQuesto 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.
-
Per i dettagli sull'API, consulta DeleteDbClusterParameterGroup AWS CLI
Command Reference.
-
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-snapshotseguente elimina lo snapshotsample-cluster-snapshotdel cluster Amazon DocumentDB.aws docdb delete-db-cluster-snapshot \ --db-cluster-snapshot-identifiersample-cluster-snapshotOutput:
{ "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.
-
Per i dettagli sull'API, consulta DeleteDbClusterSnapshot AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-db-cluster.
- AWS CLI
-
Come eliminare un cluster Amazon DocumentDB
L’esempio
delete-db-clusterseguente elimina il cluster Amazon DocumentDBsample-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-identifiersample-cluster\ --skip-final-snapshotOutput:
{ "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.
-
Per i dettagli sull'API, consulta DeleteDbCluster AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-db-instance.
- AWS CLI
-
Come eliminare un’istanza Amazon DocumentDB
L’esempio
delete-db-instanceseguente elimina l’istanza Amazon DocumentDBsample-cluster-instance-2.aws docdb delete-db-instance \ --db-instance-identifiersample-cluster-instance-2Output:
{ "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.
-
Per i dettagli sull'API, consulta DeleteDbInstance AWS CLI
Command Reference.
-
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-groupseguente elimina il gruppo di sottoretisample-subnet-groupdi Amazon DocumentDB.aws docdb delete-db-subnet-group \ --db-subnet-group-namesample-subnet-groupQuesto 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.
-
Per i dettagli sull'API, consulta DeleteDbSubnetGroup AWS CLI
Command Reference.
-
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-groupsseguente visualizza i dettagli del gruppo di parametricustom3-6-param-grpdel cluster Amazon DocumentDB.aws docdb describe-db-cluster-parameter-groups \ --db-cluster-parameter-group-namecustom3-6-param-grpOutput:
{ "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.
-
Per i dettagli sull'API, consulta DescribeDbClusterParameterGroups AWS CLI
Command Reference.
-
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-parametersseguente 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-namecustom3-6-param-grpOutput:
{ "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.
-
Per i dettagli sull'API, consulta DescribeDbClusterParameters AWS CLI
Command Reference.
-
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-attributesseguente elenca i nomi e i valori degli attributi per lo snapshotsample-cluster-snapshotdi Amazon DocumentDB.aws docdb describe-db-cluster-snapshot-attributes \ --db-cluster-snapshot-identifiersample-cluster-snapshotOutput:
{ "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } }Per ulteriori informazioni, consulta Descrivi DBCluster SnapshotAttributes nella Amazon DocumentDB Developer Guide.
-
Per i dettagli sull'API, consulta DescribeDbClusterSnapshotAttributes AWS CLI
Command Reference.
-
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-snapshotsseguente visualizza i dettagli dello snapshotsample-cluster-snapshotdi Amazon DocumentDB.aws docdb describe-db-cluster-snapshots \ --db-cluster-snapshot-identifiersample-cluster-snapshotOutput:
{ "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.
-
Per i dettagli sull'API, consulta AWS CLI Command DescribeDbClusterSnapshots
Reference.
-
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-clustersseguente visualizza i dettagli del cluster Amazon DocumentDBsample-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-identifiersample-clusterOutput:
{ "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.
-
Per i dettagli sull'API, consulta DescribeDbClusters AWS CLI
Command Reference.
-
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-versionsseguente elenca tutte le versioni disponibili del motore Amazon DocumentDB.awsdocdbdescribe-db-engine-versions \ --engine docdbOutput:
{ "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.
-
Per i dettagli sull'API, consulta DescribeDbEngineVersions AWS CLI
Command Reference.
-
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-instancesseguente visualizza informazioni dettagliate sull’istanza Amazon DocumentDBsample-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-identifiersample-cluster-instanceOutput:
{ "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.
-
Per i dettagli sull'API, consulta DescribeDbInstances AWS CLI
Command Reference.
-
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-groupsseguente descrive i dettagli per la sottorete Amazon DocumentDB denominatadefault.aws docdb describe-db-subnet-groups \ --db-subnet-group-namedefaultOutput:
{ "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.
-
Per i dettagli sull'API, consulta DescribeDbSubnetGroups AWS CLI
Command Reference.
-
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-parametersseguente visualizza i dettagli del motore predefinito e informazioni sui parametri di sistema per il gruppo di parametridocdb3.6di Amazon DocumentDB.aws docdb describe-engine-default-cluster-parameters \ --db-parameter-group-familydocdb3.6Output:
{ "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.
-
Per i dettagli sull'API, consulta DescribeEngineDefaultClusterParameters AWS CLI
Command Reference.
-
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-categoriesseguente elenca tutte le categorie per il tipo di origine eventodb-instancedi Amazon DocumentDB.aws docdb describe-event-categories \ --source-typedb-clusterOutput:
{ "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.
-
Per i dettagli sull'API, consulta DescribeEventCategories AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-events.
- AWS CLI
-
Come elencare gli eventi di Amazon DocumentDB
L’esempio
describe-eventsseguente elenca tutti gli eventi di Amazon DocumentDB delle ultime 24 ore (1440 minuti).aws docdb describe-events \ --duration1440Questo 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.
-
Per i dettagli sull'API, consulta DescribeEvents AWS CLI
Command Reference.
-
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-optionsseguente elenca tutte le opzioni delle istanze per Amazon DocumentDB per una Regione.awsdocdbdescribe-orderable-db-instance-options \ --engine docdb \ --regionus-east-1Output:
{ "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.
-
Per i dettagli sull'API, consulta DescribeOrderableDbInstanceOptions AWS CLI
Command Reference.
-
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-actionsseguente elenca tutte le operazioni di manutenzione di Amazon DocumentDB in sospeso.aws docdb describe-pending-maintenance-actionsOutput:
{ "PendingMaintenanceActions": [] }Per ulteriori informazioni, consulta Gestione di Amazon DocumentDB nella Guida per gli sviluppatori di Amazon DocumentDB.
-
Per i dettagli sull'API, consulta DescribePendingMaintenanceActions AWS CLI
Command Reference.
-
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-clusterseguente determina il failover dell’istanza primaria nel cluster Amazon DocumentDB sample-cluster su una replica.aws docdb failover-db-cluster \ --db-cluster-identifiersample-clusterOutput:
{ "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.
-
Per i dettagli sull'API, consulta FailoverDbCluster AWS CLI
Command Reference.
-
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-resourceseguente elimina tutti i tag sul cluster Amazon DocumentDBsample-cluster.aws docdb list-tags-for-resource \ --resource-namearn:aws:rds:us-west-2:123456789012:cluster:sample-clusterOutput:
{ "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.
-
Per i dettagli sull'API, consulta ListTagsForResource AWS CLI
Command Reference.
-
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-groupseguente modifica il gruppo di parametricustom3-6-param-grpdel cluster Amazon DocumentDB impostando i due parametriaudit_logsettl_monitorcome abilitati. Le modifiche vengono applicate al riavvio successivo.aws docdb modify-db-cluster-parameter-group \ --db-cluster-parameter-group-namecustom3-6-param-grp\ --parametersParameterName=audit_logs,ParameterValue=enabled,ApplyMethod=pending-reboot\ParameterName=ttl_monitor,ParameterValue=enabled,ApplyMethod=pending-rebootOutput:
{ "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.
-
Per i dettagli sull'API, consulta ModifyDbClusterParameterGroup AWS CLI
Command Reference.
-
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-attributeseguente aggiunge quattro valori di attributo a uno snapshot del cluster Amazon DocumentDB.aws docdb modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifiersample-cluster-snapshot\ --attribute-namerestore\ --values-to-add123456789011123456789012123456789013Output:
{ "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-attributeseguente rimuove due valori di attributo da uno snapshot del cluster Amazon DocumentDB.aws docdb modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifiersample-cluster-snapshot\ --attribute-namerestore\ --values-to-remove123456789012Output:
{ "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789011", "123456789013" ] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } }Per ulteriori informazioni, consulta Modify DBCluster SnapshotAttribute nella Amazon DocumentDB Developer Guide.
-
Per i dettagli sull'API, consulta ModifyDbClusterSnapshotAttribute AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaremodify-db-cluster.
- AWS CLI
-
Come modificare un cluster Amazon DocumentDB
L’esempio
modify-db-clusterseguente modifica il cluster Amazon DocumentDBsample-clusterimpostando 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-identifiersample-cluster\ --no-apply-immediately \ --backup-retention-period7\ --preferred-backup-window18:00-18:30\ --preferred-maintenance-windowsun:20:00-sun:20:30Output:
{ "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.
-
Per i dettagli sull'API, consulta ModifyDbCluster AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaremodify-db-instance.
- AWS CLI
-
Come modificare un’istanza Amazon DocumentDB
L’esempio
modify-db-instanceseguente modifica l’istanzasample-cluster2di Amazon DocumentDB cambiando la relativa classe di istanza indb.r4.4xlargee il relativo livello di promozione in5. Le modifiche vengono applicate immediatamente, ma sono visibili solo quando lo stato dell’istanza è disponibile.aws docdb modify-db-instance \ --db-instance-identifiersample-cluster2\ --apply-immediately \ --db-instance-classdb.r4.4xlarge\ --promotion-tier5Output:
{ "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.
-
Per i dettagli sull'API, consulta ModifyDbInstance AWS CLI
Command Reference.
-
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-groupseguente modifica il gruppo di sottoretisample-subnet-groupaggiungendo le sottoreti specificate e una nuova descrizione.aws docdb modify-db-subnet-group \ --db-subnet-group-namesample-subnet-group\ --subnet-idssubnet-b3806e8fsubnet-53ab3636subnet-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.
-
Per i dettagli sull'API, consulta ModifyDbSubnetGroup AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarereboot-db-instance.
- AWS CLI
-
Come riavviare un’istanza Amazon DocumentDB
L’esempio
reboot-db-instanceseguente riavvia l’istanza Amazon DocumentDBsample-cluster2.aws docdb reboot-db-instance \ --db-instance-identifiersample-cluster2Questo 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.
-
Per i dettagli sull'API, consulta RebootDbInstance
Command Reference.AWS CLI
-
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-resourceseguente rimuove il tag con la chiave denominataBdal cluster Amazon DocumentDBsample-cluster.aws docdb remove-tags-from-resource \ --resource-namearn:aws:rds:us-west-2:123456789012:cluster:sample-cluster\ --tag-keysBQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Removing tags from an Amazon Document DBResource nella Amazon DocumentDB Developer Guide.
-
Per i dettagli sull'API, consulta RemoveTagsFromResource AWS CLI
Command Reference.
-
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-groupseguente ripristina il valore predefinito del parametrottl_monitornel gruppo di parametricustom3-6-param-grpdi Amazon DocumentDB.aws docdb reset-db-cluster-parameter-group \ --db-cluster-parameter-group-namecustom3-6-param-grp\ --parametersParameterName=ttl_monitor,ApplyMethod=immediateOutput:
{ "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-groupseguente ripristina il valore predefinito di tutti i parametri nel gruppo di parametricustom3-6-param-grpdi Amazon DocumentDB.aws docdb reset-db-cluster-parameter-group \ --db-cluster-parameter-group-namecustom3-6-param-grp\ --reset-all-parametersOutput:
{ "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.
-
Per i dettagli sull'API, consulta ResetDbClusterParameterGroup AWS CLI
Command Reference.
-
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-snapshotseguente crea un nuovo cluster Amazon DocumentDB denominatosample-cluster-2019-03-16-00-01-restoreddallo snapshotrds:sample-cluster-2019-03-16-00-01.aws docdb restore-db-cluster-from-snapshot \ --db-cluster-identifiersample-cluster-2019-03-16-00-01-restored\ --enginedocdb\ --snapshot-identifierrds:sample-cluster-2019-03-16-00-01Output:
{ "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.
-
Per i dettagli sull'API, consulta RestoreDbClusterFromSnapshot AWS CLI
Command Reference.
-
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-timeseguente utilizzasample-cluster-snapshotper creare un nuovo cluster Amazon DocumentDBsample-cluster-pitutilizzando l’orario di ripristino più recente.aws docdb restore-db-cluster-to-point-in-time \ --db-cluster-identifiersample-cluster-pit\ --source-db-cluster-identifierarn:aws:rds:us-west-2:123456789012:cluster:sample-cluster\ --use-latest-restorable-timeOutput:
{ "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.
-
Per i dettagli sull'API, consulta AWS CLI Command RestoreDbClusterToPointInTime
Reference.
-
Il seguente esempio di codice mostra come utilizzarestart-db-cluster.
- AWS CLI
-
Come avviare un cluster Amazon DocumentDB arrestato
L’esempio
start-db-clusterseguente elimina il cluster Amazon DocumentDB specificato.aws docdb start-db-cluster \ --db-cluster-identifiersample-clusterOutput:
{ "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.
-
Per i dettagli sull'API, consulta StartDbCluster AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarestop-db-cluster.
- AWS CLI
-
Come arrestare un cluster Amazon DocumentDB in esecuzione
L’esempio
stop-db-clusterseguente arresta il cluster Amazon DocumentDB specificato.aws docdb stop-db-cluster \ --db-cluster-identifiersample-clusterOutput:
{ "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.
-
Per i dettagli sull'API, consulta StopDbCluster AWS CLI
Command Reference.
-