Exemples d’utilisation de l’AWS CLI avec Amazon Redshift - AWS Command Line Interface

Exemples d’utilisation de l’AWS CLI avec Amazon Redshift

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Amazon Redshift.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser accept-reserved-node-exchange.

AWS CLI

Pour accepter l’échange de nœuds réservés

L’exemple accept-reserved-node-exchange suivant accepte l’échange d’un nœud réservé DC1 contre un nœud réservé DC2.

aws redshift accept-reserved-node-exchange / --reserved-node-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE / --target-reserved-node-offering-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE

Sortie :

{ "ExchangedReservedNode": { "ReservedNodeId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", "ReservedNodeOfferingId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", "NodeType": "dc2.large", "StartTime": "2019-12-06T21:17:26Z", "Duration": 31536000, "FixedPrice": 0.0, "UsagePrice": 0.0, "CurrencyCode": "USD", "NodeCount": 1, "State": "exchanging", "OfferingType": "All Upfront", "RecurringCharges": [ { "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" } ], "ReservedNodeOfferingType": "Regular" } }

Pour plus d’informations, consultez Mise à niveau des nœuds réservés avec l’AWS CLI dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser authorize-cluster-security-group-ingress.

AWS CLI

Autorisation de l’accès à un groupe de sécurité EC2 Cet exemple autorise l’accès à un groupe de sécurité Amazon EC2 nommé. Commande :

aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --ec2-security-group-name myec2securitygroup --ec2-security-group-owner-id 123445677890

Autorisation de l’accès à une plage d’adresses CIDR Cet exemple autorise l’accès à une plage d’adresses CIDR. Commande :

aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32

L’exemple de code suivant montre comment utiliser authorize-snapshot-access.

AWS CLI

Autorisation d’un compte AWS à restaurer un instantané Cet exemple autorise le compte AWS 444455556666 à restaurer l’instantané my-snapshot-id. JSON est le format de sortie par défaut. Commande :

aws redshift authorize-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666

Résultat :

{ "Snapshot": { "Status": "available", "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", "EstimatedSecondsToCompletion": 0, "AvailabilityZone": "us-east-1a", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "Encrypted": false, "OwnerAccount": "111122223333", "BackupProgressInMegabytes": 11.0, "ElapsedTimeInSeconds": 0, "DBName": "dev", "CurrentBackupRateInMegabytesPerSecond: 0.1534, "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "ActualIncrementalBackupSizeInMegabytes"; 11.0, "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "mycluster", "TotalBackupSizeInMegabytes": 20.0, "Port": 5439, "NumberOfNodes": 2, "SnapshotIdentifier": "my-snapshot-id" } }
  • Pour plus de détails sur l’API, consultez AuthorizeSnapshotAccess dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser batch-delete-cluster-snapshots.

AWS CLI

Pour supprimer un ensemble d’instantanés de cluster

L’exemple batch-delete-cluster-snapshots suivant supprime un ensemble d’instantanés de cluster manuels.

aws redshift batch-delete-cluster-snapshots \ --identifiers SnapshotIdentifier=mycluster-2019-11-06-14-12 SnapshotIdentifier=mycluster-2019-11-06-14-20

Sortie :

{ "Resources": [ "mycluster-2019-11-06-14-12", "mycluster-2019-11-06-14-20" ] }

Pour plus d’informations, consultez Instantanés Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser batch-modify-cluster-snapshots.

AWS CLI

Pour modifier un ensemble d’instantanés de cluster

L’exemple batch-modify-cluster-snapshots suivant modifie les paramètres d’un ensemble d’instantanés de cluster.

aws redshift batch-modify-cluster-snapshots \ --snapshot-identifier-list mycluster-2019-11-06-16-31 mycluster-2019-11-06-16-32 \ --manual-snapshot-retention-period 30

Sortie :

{ "Resources": [ "mycluster-2019-11-06-16-31", "mycluster-2019-11-06-16-32" ], "Errors": [], "ResponseMetadata": { "RequestId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", "HTTPStatusCode": 200, "HTTPHeaders": { "x-amzn-requestid": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE, "content-type": "text/xml", "content-length": "480", "date": "Sat, 07 Dec 2019 00:36:09 GMT", "connection": "keep-alive" }, "RetryAttempts": 0 } }

Pour plus d’informations, consultez Instantanés Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser cancel-resize.

AWS CLI

Pour annuler le redimensionnement d’un cluster

L’exemple cancel-resize suivant annule une opération de redimensionnement classique pour un cluster.

aws redshift cancel-resize \ --cluster-identifier mycluster

Sortie :

{ "TargetNodeType": "dc2.large", "TargetNumberOfNodes": 2, "TargetClusterType": "multi-node", "Status": "CANCELLING", "ResizeType": "ClassicResize", "TargetEncryptionType": "NONE" }

Pour plus d’informations, consultez Redimensionnement des clusters dans Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez CancelResize dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser copy-cluster-snapshot.

AWS CLI

Obtention d’une description de toutes les versions du cluster Cet exemple renvoie une description de toutes les versions du cluster. JSON est le format de sortie par défaut. Commande :

aws redshift copy-cluster-snapshot --source-snapshot-identifier cm:examplecluster-2013-01-22-19-27-58 --target-snapshot-identifier my-saved-snapshot-copy

Résultat :

{ "Snapshot": { "Status": "available", "SnapshotCreateTime": "2013-01-22T19:27:58.931Z", "AvailabilityZone": "us-east-1c", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "DBName": "dev", "ClusterCreateTime": "2013-01-22T19:23:59.368Z", "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "examplecluster", "Port": 5439, "NumberOfNodes": "2", "SnapshotIdentifier": "my-saved-snapshot-copy" }, "ResponseMetadata": { "RequestId": "3b279691-64e3-11e2-bec0-17624ad140dd" } }
  • Pour plus de détails sur l’API, consultez CopyClusterSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-cluster-parameter-group.

AWS CLI

Création d’un groupe de paramètres de cluster Cet exemple crée un nouveau groupe de paramètres de cluster. Commande :

aws redshift create-cluster-parameter-group --parameter-group-name myclusterparametergroup --parameter-group-family redshift-1.0 --description "My first cluster parameter group"

Résultat :

{ "ClusterParameterGroup": { "ParameterGroupFamily": "redshift-1.0", "Description": "My first cluster parameter group", "ParameterGroupName": "myclusterparametergroup" }, "ResponseMetadata": { "RequestId": "739448f0-64cc-11e2-8f7d-3b939af52818" } }

L’exemple de code suivant montre comment utiliser create-cluster-security-group.

AWS CLI

Création d’un groupe de sécurité de cluster Cet exemple crée un nouveau groupe de sécurité de cluster. JSON est le format de sortie par défaut. Commande :

aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group"

Résultat :

{ "create_cluster_security_group_response": { "create_cluster_security_group_result": { "cluster_security_group": { "description": "This is my cluster security group", "owner_id": "300454760768", "cluster_security_group_name": "mysecuritygroup", "ec2_security_groups": \[], "ip_ranges": \[] } }, "response_metadata": { "request_id": "5df486a0-343a-11e2-b0d8-d15d0ef48549" } } }

Vous pouvez également obtenir les mêmes informations au format texte à l’aide de l’option --output text. Commande :

Option --output text. Commande :

option. Commande :

aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" --output text

Résultat :

This is my cluster security group 300454760768 mysecuritygroup a0c0bfab-343a-11e2-95d2-c3dc9fe8ab57

L’exemple de code suivant montre comment utiliser create-cluster-snapshot.

AWS CLI

Création d’un instantané de cluster Cet exemple crée un nouvel instantané de cluster. JSON est le format de sortie par défaut. Commande :

aws redshift create-cluster-snapshot --cluster-identifier mycluster --snapshot-identifier my-snapshot-id

Résultat :

{ "Snapshot": { "Status": "creating", "SnapshotCreateTime": "2013-01-22T22:20:33.548Z", "AvailabilityZone": "us-east-1a", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "DBName": "dev", "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "mycluster", "Port": 5439, "NumberOfNodes": "2", "SnapshotIdentifier": "my-snapshot-id" }, "ResponseMetadata": { "RequestId": "f024d1a5-64e1-11e2-88c5-53eb05787dfb" } }
  • Pour plus de détails sur l’API, consultez CreateClusterSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-cluster-subnet-group.

AWS CLI

Création d’un groupe de sous-réseaux de cluster Cet exemple crée un nouveau groupe de sous-réseaux de cluster. Commande :

aws redshift create-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --description "My subnet group" --subnet-ids subnet-763fdd1c

Résultat :

{ "ClusterSubnetGroup": { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-763fdd1c", "SubnetAvailabilityZone": { "Name": "us-east-1a" } } ], "VpcId": "vpc-7e3fdd14", "SubnetGroupStatus": "Complete", "Description": "My subnet group", "ClusterSubnetGroupName": "mysubnetgroup" }, "ResponseMetadata": { "RequestId": "500b8ce2-698f-11e2-9790-fd67517fb6fd" } }
  • Pour plus de détails sur l’API, consultez CreateClusterSubnetGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-cluster.

AWS CLI

Création d’un cluster avec des paramètres minimaux Cet exemple crée un cluster avec un ensemble minimal de paramètres. JSON est le format de sortie par défaut. Commande :

aws redshift create-cluster --node-type dw.hs1.xlarge --number-of-nodes 2 --master-username adminuser --master-user-password TopSecret1 --cluster-identifier mycluster

Résultat :

{ "Cluster": { "NodeType": "dw.hs1.xlarge", "ClusterVersion": "1.0", "PubliclyAccessible": "true", "MasterUsername": "adminuser", "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": \[], "PreferredMaintenanceWindow": "sat:03:30-sat:04:00", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "creating", "ClusterIdentifier": "mycluster", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": { "MasterUserPassword": "\****" } }, "ResponseMetadata": { "RequestId": "7cf4bcfc-64dd-11e2-bea9-49e0ce183f07" } }
  • Pour plus de détails sur l’API, consultez CreateCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-event-subscription.

AWS CLI

Pour créer un abonnement aux notifications pour un événement

L’exemple create-event-subscription suivant crée un abonnement aux notifications d’événements.

aws redshift create-event-subscription \ --subscription-name mysubscription \ --sns-topic-arn arn:aws:sns:us-west-2:123456789012:MySNStopic \ --source-type cluster \ --source-ids mycluster

Sortie :

{ "EventSubscription": { "CustomerAwsId": "123456789012", "CustSubscriptionId": "mysubscription", "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:MySNStopic", "Status": "active", "SubscriptionCreationTime": "2019-12-09T20:05:19.365Z", "SourceType": "cluster", "SourceIdsList": [ "mycluster" ], "EventCategoriesList": [], "Severity": "INFO", "Enabled": true, "Tags": [] } }

Pour plus d’informations, consultez Abonnement à la notification d’événement Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez CreateEventSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-hsm-client-certificate.

AWS CLI

Pour créer un certificat de client HSM

L’exemple create-hsm-client-certificate suivant génère un certificat client HSM qu’un cluster peut utiliser pour se connecter à un HSM.

aws redshift create-hsm-client-certificate \ --hsm-client-certificate-identifier myhsmclientcert

Sortie :

{ "HsmClientCertificate": { "HsmClientCertificateIdentifier": "myhsmclientcert", "HsmClientCertificatePublicKey": "-----BEGIN CERTIFICATE----- MIICiEXAMPLECQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTEXAMPLEwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25EXAMPLEIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb2EXAMPLETEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBEXAMPLEMRAwDgYD EXAMPLETZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAEXAMPLEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKEXAMPLEAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk6EXAMPLE3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugEXAMPLEzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEEXAMPLEEAtCu4 nUhVVxYUEXAMPLEh8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rEXAMPLE=-----END CERTIFICATE-----\n", "Tags": [] } }

Pour plus d’informations, consultez Référence des autorisations d’API Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser create-hsm-configuration.

AWS CLI

Pour créer une configuration HSM

L’exemple create-hsm-configuration suivant crée la configuration HSM spécifiée qui contient les informations requises par un cluster pour stocker et utiliser des clés de chiffrement de base de données dans un module de sécurité matériel (HSM).

aws redshift create-hsm-configuration / --hsm-configuration-identifier myhsmconnection --description "My HSM connection" --hsm-ip-address 192.0.2.09 --hsm-partition-name myhsmpartition / --hsm-partition-password A1b2c3d4 / --hsm-server-public-certificate myhsmclientcert

Sortie :

{ "HsmConfiguration": { "HsmConfigurationIdentifier": "myhsmconnection", "Description": "My HSM connection", "HsmIpAddress": "192.0.2.09", "HsmPartitionName": "myhsmpartition", "Tags": [] } }
  • Pour plus de détails sur l’API, consultez CreateHsmConfiguration dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-snapshot-copy-grant.

AWS CLI

Pour créer une autorisation de copie d’instantanés

L’exemple create-snapshot-copy-grant suivant crée une autorisation de copie d’instantanés et le chiffrement des instantanés copiés dans une région AWS de destination.

aws redshift create-snapshot-copy-grant \ --snapshot-copy-grant-name mysnapshotcopygrantname

Sortie :

{ "SnapshotCopyGrant": { "SnapshotCopyGrantName": "mysnapshotcopygrantname", "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY", "Tags": [] } }

Pour plus d’informations, consultez Chiffrement de base de données Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez CreateSnapshotCopyGrant dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-snapshot-schedule.

AWS CLI

Pour créer une planification d’instantané

L’exemple create-snapshot-schedule suivant crée une planification d’instantané avec la description spécifiée et une fréquence égale à toutes les 12 heures.

aws redshift create-snapshot-schedule \ --schedule-definitions "rate(12 hours)" \ --schedule-identifier mysnapshotschedule \ --schedule-description "My schedule description"

Sortie :

{ "ScheduleDefinitions": [ "rate(12 hours)" ], "ScheduleIdentifier": "mysnapshotschedule", "ScheduleDescription": "My schedule description", "Tags": [] }

Pour plus d’informations, consultez Planifications d’un instantané automatique dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez CreateSnapshotSchedule dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-tags.

AWS CLI

Pour créer des balises pour un cluster

L’exemple create-tags suivant ajoute la paire clé/valeur de balise spécifiée au cluster spécifié.

aws redshift create-tags \ --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ --tags "Key"="mytags","Value"="tag1"

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Balisage des ressources dans Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez CreateTags dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-cluster-parameter-group.

AWS CLI

Suppression d’un groupe de paramètres de cluster Cet exemple supprime un groupe de paramètres de cluster. Commande :

aws redshift delete-cluster-parameter-group --parameter-group-name myclusterparametergroup

L’exemple de code suivant montre comment utiliser delete-cluster-security-group.

AWS CLI

Suppression d’un groupe de sécurité de cluster Cet exemple supprime un groupe de sécurité de cluster. Commande :

aws redshift delete-cluster-security-group --cluster-security-group-name mysecuritygroup

L’exemple de code suivant montre comment utiliser delete-cluster-snapshot.

AWS CLI

Suppression d’un instantané de cluster Cet exemple supprime un instantané de cluster. Commande :

aws redshift delete-cluster-snapshot --snapshot-identifier my-snapshot-id
  • Pour plus de détails sur l’API, consultez DeleteClusterSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-cluster-subnet-group.

AWS CLI

Suppression d’un groupe de sous-réseaux de cluster Cet exemple supprime un groupe de sous-réseaux de cluster. Commande :

aws redshift delete-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup

Résultat :

{ "ResponseMetadata": { "RequestId": "253fbffd-6993-11e2-bc3a-47431073908a" } }
  • Pour plus de détails sur l’API, consultez DeleteClusterSubnetGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-cluster.

AWS CLI

Suppression d’un cluster sans instantané de cluster final Cet exemple supprime un cluster, forçant ainsi la suppression des données afin qu’aucun instantané de cluster final ne soit créé. Commande :

aws redshift delete-cluster --cluster-identifier mycluster --skip-final-cluster-snapshot

Suppression d’un cluster, autorisant ainsi un instantané de cluster final Cet exemple supprime un cluster, mais spécifie un instantané de cluster final. Commande :

aws redshift delete-cluster --cluster-identifier mycluster --final-cluster-snapshot-identifier myfinalsnapshot
  • Pour plus de détails sur l’API, consultez DeleteCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-event-subscription.

AWS CLI

Pour supprimer un abonnement à un événement

L’exemple delete-event-subscription suivant supprime l’abonnement aux notifications d’événements spécifié.

aws redshift delete-event-subscription \ --subscription-name mysubscription

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Abonnement à la notification d’événement Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DeleteEventSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-hsm-client-certificate.

AWS CLI

Pour supprimer un certificat de client HSM

L’exemple delete-hsm-client-certificate suivant supprime un certificat de client HSM.

aws redshift delete-hsm-client-certificate \ --hsm-client-certificate-identifier myhsmclientcert

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Référence des autorisations d’API Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser delete-hsm-configuration.

AWS CLI

Pour supprimer une configuration HSM

L’exemple delete-hsm-configuration suivant supprime la configuration HSM spécifiée du compte AWS actuel.

aws redshift delete-hsm-configuration / --hsm-configuration-identifier myhsmconnection

Cette commande ne génère pas de sortie.

  • Pour plus de détails sur l’API, consultez DeleteHsmConfiguration dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-scheduled-action.

AWS CLI

Pour supprimer une action planifiée

L’exemple delete-scheduled-action suivant supprime une action planifiée spécifique.

aws redshift delete-scheduled-action \ --scheduled-action-name myscheduledaction

Cette commande ne génère pas de sortie.

  • Pour plus de détails sur l’API, consultez DeleteScheduledAction dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-snapshot-copy-grant.

AWS CLI

Pour supprimer une autorisation de copie d’instantanés

L’exemple delete-snapshot-copy-grant suivant supprime l’autorisation de copie d’instantanés spécifiée.

aws redshift delete-snapshot-copy-grant \ --snapshot-copy-grant-name mysnapshotcopygrantname

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Chiffrement de base de données Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DeleteSnapshotCopyGrant dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-snapshot-schedule.

AWS CLI

Pour supprimer une planification d’instantané

L’exemple delete-snapshot-schedule suivant supprime la planification d’instantané spécifiée. Vous devez dissocier les clusters avant de supprimer la planification.

aws redshift delete-snapshot-schedule \ --schedule-identifier mysnapshotschedule

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Planifications d’un instantané automatique dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DeleteSnapshotSchedule dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-tags.

AWS CLI

Pour supprimer les balises d’un cluster

L’exemple delete-tags suivant supprime les balises portant les noms de clé spécifiés du cluster spécifié.

aws redshift delete-tags \ --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ --tag-keys "clustertagkey" "clustertagvalue"

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Balisage des ressources dans Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DeleteTags dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-account-attributes.

AWS CLI

Pour décrire les attributs d’un compte AWS

L’exemple describe-account-attributes suivant affiche les attributs associés au compte AWS appelant.

aws redshift describe-account-attributes

Sortie :

{ "AccountAttributes": [ { "AttributeName": "max-defer-maintenance-duration", "AttributeValues": [ { "AttributeValue": "45" } ] } ] }

L’exemple de code suivant montre comment utiliser describe-cluster-db-revisions.

AWS CLI

Pour décrire les révisions de base de données pour un cluster

L’exemple describe-cluster-db-revisions suivant affiche les détails d’un tableau d’objets ClusterDbRevision pour le cluster spécifié.

aws redshift describe-cluster-db-revisions \ --cluster-identifier mycluster

Sortie :

{ "ClusterDbRevisions": [ { "ClusterIdentifier": "mycluster", "CurrentDatabaseRevision": "11420", "DatabaseRevisionReleaseDate": "2019-11-22T16:43:49.597Z", "RevisionTargets": [] } ] }

L’exemple de code suivant montre comment utiliser describe-cluster-parameter-groups.

AWS CLI

Obtention d’une description de tous les groupes de paramètres de cluster Cet exemple renvoie une description de tous les groupes de paramètres de cluster pour le compte, avec des en-têtes de colonne. JSON est le format de sortie par défaut. Commande :

aws redshift describe-cluster-parameter-groups

Résultat :

{ "ParameterGroups": [ { "ParameterGroupFamily": "redshift-1.0", "Description": "My first cluster parameter group", "ParameterGroupName": "myclusterparametergroup" } ], "ResponseMetadata": { "RequestId": "8ceb8f6f-64cc-11e2-bea9-49e0ce183f07" } }

Vous pouvez également obtenir les mêmes informations au format texte à l’aide de l’option --output text. Commande :

Option --output text. Commande :

option. Commande :

aws redshift describe-cluster-parameter-groups --output text

Résultat :

redshift-1.0 My first cluster parameter group myclusterparametergroup RESPONSEMETADATA 9e665a36-64cc-11e2-8f7d-3b939af52818

L’exemple de code suivant montre comment utiliser describe-cluster-parameters.

AWS CLI

Extraction des paramètres d’un groupe de paramètres de cluster spécifié Cet exemple extrait les paramètres du groupe de paramètres nommé. JSON est le format de sortie par défaut. Commande :

aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup

Résultat :

{ "Parameters": [ { "Description": "Sets the display format for date and time values.", "DataType": "string", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "ISO, MDY", "ParameterName": "datestyle" }, { "Description": "Sets the number of digits displayed for floating-point values", "DataType": "integer", "IsModifiable": true, "AllowedValues": "-15-2", "Source": "engine-default", "ParameterValue": "0", "ParameterName": "extra_float_digits" }, (...remaining output omitted...) ] }

Vous pouvez également obtenir les mêmes informations au format texte à l’aide de l’option --output text. Commande :

Option --output text. Commande :

option. Commande :

aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup --output text

Résultat :

RESPONSEMETADATA cdac40aa-64cc-11e2-9e70-918437dd236d Sets the display format for date and time values. string True engine-default ISO, MDY datestyle Sets the number of digits displayed for floating-point values integer True -15-2 engine-default 0 extra_float_digits This parameter applies a user-defined label to a group of queries that are run during the same session.. string True engine-default default query_group require ssl for all databaseconnections boolean True true,false engine-default false require_ssl Sets the schema search order for names that are not schema-qualified. string True engine-default $user, public search_path Aborts any statement that takes over the specified number of milliseconds. integer True engine-default 0 statement_timeout wlm json configuration string True engine-default \[{"query_concurrency":5}] wlm_json_configuration

L’exemple de code suivant montre comment utiliser describe-cluster-security-groups.

AWS CLI

Obtention d’une description de tous les groupes de sécurité de cluster Cet exemple renvoie une description de tous les groupes de sécurité de cluster pour le compte. JSON est le format de sortie par défaut. Commande :

aws redshift describe-cluster-security-groups

Résultat :

{ "ClusterSecurityGroups": [ { "OwnerId": "100447751468", "Description": "default", "ClusterSecurityGroupName": "default", "EC2SecurityGroups": \[], "IPRanges": [ { "Status": "authorized", "CIDRIP": "0.0.0.0/0" } ] }, { "OwnerId": "100447751468", "Description": "This is my cluster security group", "ClusterSecurityGroupName": "mysecuritygroup", "EC2SecurityGroups": \[], "IPRanges": \[] }, (...remaining output omitted...) ] }

L’exemple de code suivant montre comment utiliser describe-cluster-snapshots.

AWS CLI

Obtention d’une description de tous les instantanés du cluster Cet exemple renvoie une description de tous les instantanés du cluster pour le compte. JSON est le format de sortie par défaut. Commande :

aws redshift describe-cluster-snapshots

Résultat :

{ "Snapshots": [ { "Status": "available", "SnapshotCreateTime": "2013-07-17T22:02:22.852Z", "EstimatedSecondsToCompletion": -1, "AvailabilityZone": "us-east-1a", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "Encrypted": false, "OwnerAccount": "111122223333", "BackupProgressInMegabytes": 20.0, "ElapsedTimeInSeconds": 0, "DBName": "dev", "CurrentBackupRateInMegabytesPerSecond: 0.0, "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "ActualIncrementalBackupSizeInMegabytes"; 20.0 "SnapshotType": "automated", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "mycluster", "Port": 5439, "TotalBackupSizeInMegabytes": 20.0, "NumberOfNodes": "2", "SnapshotIdentifier": "cm:mycluster-2013-01-22-22-04-18" }, { "EstimatedSecondsToCompletion": 0, "OwnerAccount": "111122223333", "CurrentBackupRateInMegabytesPerSecond: 0.1534, "ActualIncrementalBackupSizeInMegabytes"; 11.0, "NumberOfNodes": "2", "Status": "available", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "AccountsWithRestoreAccess": [ { "AccountID": "444455556666" } ], "TotalBackupSizeInMegabytes": 20.0, "DBName": "dev", "BackupProgressInMegabytes": 11.0, "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "ElapsedTimeInSeconds": 0, "ClusterIdentifier": "mycluster", "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", "AvailabilityZone": "us-east-1a", "NodeType": "dw.hs1.xlarge", "Encrypted": false, "SnapshotType": "manual", "Port": 5439, "SnapshotIdentifier": "my-snapshot-id" } ] } (...remaining output omitted...)
  • Pour plus de détails sur l’API, consultez DescribeClusterSnapshots dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-cluster-subnet-groups.

AWS CLI

Obtention d’une description de tous les groupes de sous-réseaux de cluster Cet exemple renvoie une description de tous les groupes de sous-réseaux de cluster. JSON est le format de sortie par défaut. Commande :

aws redshift describe-cluster-subnet-groups

Résultat :

{ "ClusterSubnetGroups": [ { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-763fdd1c", "SubnetAvailabilityZone": { "Name": "us-east-1a" } } ], "VpcId": "vpc-7e3fdd14", "SubnetGroupStatus": "Complete", "Description": "My subnet group", "ClusterSubnetGroupName": "mysubnetgroup" } ], "ResponseMetadata": { "RequestId": "37fa8c89-6990-11e2-8f75-ab4018764c77" } }

L’exemple de code suivant montre comment utiliser describe-cluster-tracks.

AWS CLI

Pour décrire les suivis de cluster

L’exemple describe-cluster-tracks suivant affiche les détails des suivis de maintenance disponibles.

aws redshift describe-cluster-tracks \ --maintenance-track-name current

Sortie :

{ "MaintenanceTracks": [ { "MaintenanceTrackName": "current", "DatabaseVersion": "1.0.11420", "UpdateTargets": [ { "MaintenanceTrackName": "preview_features", "DatabaseVersion": "1.0.11746", "SupportedOperations": [ { "OperationName": "restore-from-cluster-snapshot" } ] }, { "MaintenanceTrackName": "trailing", "DatabaseVersion": "1.0.11116", "SupportedOperations": [ { "OperationName": "restore-from-cluster-snapshot" }, { "OperationName": "modify-cluster" } ] } ] } ] }

Pour plus d’informations, consultez Sélection du suivi de maintenance des clusters dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DescribeClusterTracks dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-cluster-versions.

AWS CLI

Obtention d’une description de toutes les versions du cluster Cet exemple renvoie une description de toutes les versions du cluster. JSON est le format de sortie par défaut. Commande :

aws redshift describe-cluster-versions

Résultat :

{ "ClusterVersions": [ { "ClusterVersion": "1.0", "Description": "Initial release", "ClusterParameterGroupFamily": "redshift-1.0" } ], "ResponseMetadata": { "RequestId": "16a53de3-64cc-11e2-bec0-17624ad140dd" } }
  • Pour plus de détails sur l’API, consultez DescribeClusterVersions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-clusters.

AWS CLI

Obtention d’une description de tous les clusters Cet exemple renvoie une description de tous les cluster pour le compte. JSON est le format de sortie par défaut. Commande :

aws redshift describe-clusters

Résultat :

{ "Clusters": [ { "NodeType": "dw.hs1.xlarge", "Endpoint": { "Port": 5439, "Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com" }, "ClusterVersion": "1.0", "PubliclyAccessible": "true", "MasterUsername": "adminuser", "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": \[], "AvailabilityZone": "us-east-1a", "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "PreferredMaintenanceWindow": "sat:03:30-sat:04:00", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "available", "ClusterIdentifier": "mycluster", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} } ], "ResponseMetadata": { "RequestId": "65b71cac-64df-11e2-8f5b-e90bd6c77476" } }

Vous pouvez également obtenir les mêmes informations au format texte à l’aide de l’option --output text. Commande :

Option --output text. Commande :

option. Commande :

aws redshift describe-clusters --output text

Résultat :

dw.hs1.xlarge 1.0 true adminuser True us-east-1a 2013-01-22T21:59:29.559Z sat:03:30-sat:04:00 1 available mycluster dev 2 ENDPOINT 5439 mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com in-sync default.redshift-1.0 active default PENDINGMODIFIEDVALUES RESPONSEMETADATA 934281a8-64df-11e2-b07c-f7fbdd006c67
  • Pour plus de détails sur l’API, consultez DescribeClusters dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-default-cluster-parameters.

AWS CLI

Obtention d’une description des paramètres de cluster par défaut Cet exemple renvoie une description des paramètres de cluster par défaut pour la famille redshift-1.0. JSON est le format de sortie par défaut. Commande :

aws redshift describe-default-cluster-parameters --parameter-group-family redshift-1.0

Résultat :

{ "DefaultClusterParameters": { "ParameterGroupFamily": "redshift-1.0", "Parameters": [ { "Description": "Sets the display format for date and time values.", "DataType": "string", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "ISO, MDY", "ParameterName": "datestyle" }, { "Description": "Sets the number of digits displayed for floating-point values", "DataType": "integer", "IsModifiable": true, "AllowedValues": "-15-2", "Source": "engine-default", "ParameterValue": "0", "ParameterName": "extra_float_digits" }, (...remaining output omitted...) ] } }

Pour afficher la liste des familles de groupes de paramètres valides, utilisez la commande describe-cluster-parameter-groups.

Commande describe-cluster-parameter-groups.

commande.

L’exemple de code suivant montre comment utiliser describe-event-categories.

AWS CLI

Pour décrire les catégories d’événement d’un cluster

L’exemple describe-event-categories suivant affiche les détails sur les catégories d’événement d’un cluster.

aws redshift describe-event-categories \ --source-type cluster

Sortie :

{ "EventCategoriesMapList": [ { "SourceType": "cluster", "Events": [ { "EventId": "REDSHIFT-EVENT-2000", "EventCategories": [ "management" ], "EventDescription": "Cluster <cluster name> created at <time in UTC>.", "Severity": "INFO" }, { "EventId": "REDSHIFT-EVENT-2001", "EventCategories": [ "management" ], "EventDescription": "Cluster <cluster name> deleted at <time in UTC>.", "Severity": "INFO" }, { "EventId": "REDSHIFT-EVENT-3625", "EventCategories": [ "monitoring" ], "EventDescription": "The cluster <cluster name> can't be resumed with its previous elastic network interface <ENI id>. We will allocate a new elastic network interface and associate it with the cluster node.", "Severity": "INFO" } ] } ] }
  • Pour plus de détails sur l’API, consultez DescribeEventCategories dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-event-subscriptions.

AWS CLI

Pour décrire les abonnements aux événements

L’exemple describe-event-subscriptions suivant affiche les abonnements aux notifications d’événement pour l’abonnement spécifié.

aws redshift describe-event-subscriptions \ --subscription-name mysubscription

Sortie :

{ "EventSubscriptionsList": [ { "CustomerAwsId": "123456789012", "CustSubscriptionId": "mysubscription", "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:MySNStopic", "Status": "active", "SubscriptionCreationTime": "2019-12-09T21:50:21.332Z", "SourceIdsList": [], "EventCategoriesList": [ "management" ], "Severity": "ERROR", "Enabled": true, "Tags": [] } ] }

Pour plus d’informations, consultez Abonnement à la notification d’événement Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser describe-events.

AWS CLI

Description de tous les événements Cet exemple renvoie tous les événements. JSON est le format de sortie par défaut. Commande :

aws redshift describe-events

Résultat :

{ "Events": [ { "Date": "2013-01-22T19:17:03.640Z", "SourceIdentifier": "myclusterparametergroup", "Message": "Cluster parameter group myclusterparametergroup has been created.", "SourceType": "cluster-parameter-group" } ], "ResponseMetadata": { "RequestId": "9f056111-64c9-11e2-9390-ff04f2c1e638" } }

Vous pouvez également obtenir les mêmes informations au format texte à l’aide de l’option --output text. Commande :

Option --output text. Commande :

option. Commande :

aws redshift describe-events --output text

Résultat :

2013-01-22T19:17:03.640Z myclusterparametergroup Cluster parameter group myclusterparametergroup has been created. cluster-parameter-group RESPONSEMETADATA 8e5fe765-64c9-11e2-bce3-e56f52c50e17
  • Pour plus de détails sur l’API, consultez DescribeEvents dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-hsm-client-certificates.

AWS CLI

Pour décrire les certificats client HSM

L’exemple describe-hsm-client-certificates suivant affiche les détails du certificat client HSM spécifié.

aws redshift describe-hsm-client-certificates \ --hsm-client-certificate-identifier myhsmclientcert

Sortie :

{ "HsmClientCertificates": [ { "HsmClientCertificateIdentifier": "myhsmclientcert", "HsmClientCertificatePublicKey": "-----BEGIN CERTIFICATE-----\ EXAMPLECAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAEXAMPLERAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zEXAMPLEwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhEXAMPLEDI1MjA0EXAMPLEN EXAMPLE0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGEXAMPLEQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsEXAMPLEdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIEXAMPLEMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY67EXAMPLEE EXAMPLEZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9EXAMPLE6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDEXAMPLEBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rEXAMPLE=-----END CERTIFICATE-----\n", "Tags": [] } ] }

Pour plus d’informations, consultez Référence des autorisations d’API Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser describe-hsm-configurations.

AWS CLI

Pour décrire les configurations HSM

L’exemple describe-hsm-configurations suivant affiche les détails des configurations HSM disponibles pour le compte AWS appelant.

aws redshift describe-hsm-configurations / --hsm-configuration-identifier myhsmconnection

Sortie :

{ "HsmConfigurations": [ { "HsmConfigurationIdentifier": "myhsmconnection", "Description": "My HSM connection", "HsmIpAddress": "192.0.2.09", "HsmPartitionName": "myhsmpartition", "Tags": [] } ] }

L’exemple de code suivant montre comment utiliser describe-logging-status.

AWS CLI

Pour décrire le statut de journalisation d’un cluster

L’exemple describe-logging-status suivant indique si des informations, telles que des requêtes et des tentatives de connexion, sont journalisées pour un cluster.

aws redshift describe-logging-status \ --cluster-identifier mycluster

Sortie :

{ "LoggingEnabled": false }

Pour plus d’informations, consultez Journalisation des audits de base de données dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DescribeLoggingStatus dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-node-configuration-options.

AWS CLI

Pour décrire les options de configuration de nœud

L’exemple describe-node-configuration-options suivant affiche les propriétés des configurations de nœud possibles, telles que le type de nœud, le nombre de nœuds et l’utilisation du disque pour l’instantané de cluster spécifié.

aws redshift describe-node-configuration-options \ --action-type restore-cluster \ --snapshot-identifier rs:mycluster-2019-12-09-16-42-43

Sortie :

{ "NodeConfigurationOptionList": [ { "NodeType": "dc2.large", "NumberOfNodes": 2, "EstimatedDiskUtilizationPercent": 19.61 }, { "NodeType": "dc2.large", "NumberOfNodes": 4, "EstimatedDiskUtilizationPercent": 9.96 }, { "NodeType": "ds2.xlarge", "NumberOfNodes": 2, "EstimatedDiskUtilizationPercent": 1.53 }, { "NodeType": "ds2.xlarge", "NumberOfNodes": 4, "EstimatedDiskUtilizationPercent": 0.78 } ] }

Pour plus d’informations, consultez Achat de nœuds réservés pour Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser describe-orderable-cluster-options.

AWS CLI

Description de toutes les options de cluster pouvant être commandées Cet exemple renvoie des descriptions de toutes les options de cluster pouvant être commandées. JSON est le format de sortie par défaut. Commande :

aws redshift describe-orderable-cluster-options

Résultat :

{ "OrderableClusterOptions": [ { "NodeType": "dw.hs1.8xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" } ], "ClusterVersion": "1.0", "ClusterType": "multi-node" }, { "NodeType": "dw.hs1.xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" } ], "ClusterVersion": "1.0", "ClusterType": "multi-node" }, { "NodeType": "dw.hs1.xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" } ], "ClusterVersion": "1.0", "ClusterType": "single-node" } ], "ResponseMetadata": { "RequestId": "f6000035-64cb-11e2-9135-ff82df53a51a" } }

Vous pouvez également obtenir les mêmes informations au format texte à l’aide de l’option --output text. Commande :

Option --output text. Commande :

option. Commande :

aws redshift describe-orderable-cluster-options --output text

Résultat :

dw.hs1.8xlarge 1.0 multi-node us-east-1a us-east-1b us-east-1c dw.hs1.xlarge 1.0 multi-node us-east-1a us-east-1b us-east-1c dw.hs1.xlarge 1.0 single-node us-east-1a us-east-1b us-east-1c RESPONSEMETADATA e648696b-64cb-11e2-bec0-17624ad140dd

L’exemple de code suivant montre comment utiliser describe-reserved-node-offerings.

AWS CLI

Description des offres de nœuds réservés Cet exemple montre toutes les offres de nœuds réservés disponibles à l’achat. Commande :

aws redshift describe-reserved-node-offerings

Résultat :

{ "ReservedNodeOfferings": [ { "OfferingType": "Heavy Utilization", "FixedPrice": "", "NodeType": "dw.hs1.xlarge", "UsagePrice": "", "RecurringCharges": [ { "RecurringChargeAmount": "", "RecurringChargeFrequency": "Hourly" } ], "Duration": 31536000, "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c" }, { "OfferingType": "Heavy Utilization", "FixedPrice": "", "NodeType": "dw.hs1.8xlarge", "UsagePrice": "", "RecurringCharges": [ { "RecurringChargeAmount": "", "RecurringChargeFrequency": "Hourly" } ], "Duration": 31536000, "ReservedNodeOfferingId": "e5a2ff3b-352d-4a9c-ad7d-373c4cab5dd2" }, ...remaining output omitted... ], "ResponseMetadata": { "RequestId": "8b1a1a43-75ff-11e2-9666-e142fe91ddd1" } }

Si vous souhaitez acheter une offre de nœud réservé, vous pouvez appeler purchase-reserved-node-offering en utilisant un ReservedNodeOfferingId valide.

purchase-reserved-node-offering avec un ReservedNodeOfferingId valide.

avec un ReservedNodeOfferingId valide.

ReservedNodeOfferingId.

.

L’exemple de code suivant montre comment utiliser describe-reserved-nodes.

AWS CLI

Description des nœuds réservés Cet exemple montre une offre de nœud réservé qui a été achetée. Commande :

aws redshift describe-reserved-nodes

Résultat :

{ "ResponseMetadata": { "RequestId": "bc29ce2e-7600-11e2-9949-4b361e7420b7" }, "ReservedNodes": [ { "OfferingType": "Heavy Utilization", "FixedPrice": "", "NodeType": "dw.hs1.xlarge", "ReservedNodeId": "1ba8e2e3-bc01-4d65-b35d-a4a3e931547e", "UsagePrice": "", "RecurringCharges": [ { "RecurringChargeAmount": "", "RecurringChargeFrequency": "Hourly" } ], "NodeCount": 1, "State": "payment-pending", "StartTime": "2013-02-13T17:08:39.051Z", "Duration": 31536000, "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c" } ] }
  • Pour plus de détails sur l’API, consultez DescribeReservedNodes dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-resize.

AWS CLI

Description du redimensionnement Cet exemple décrit le dernier redimensionnement d’un cluster. La demande portait sur 3 nœuds de type dw.hs1.8xlarge. Commande :

aws redshift describe-resize --cluster-identifier mycluster

Résultat :

{ "Status": "NONE", "TargetClusterType": "multi-node", "TargetNodeType": "dw.hs1.8xlarge", "ResponseMetadata": { "RequestId": "9f52b0b4-7733-11e2-aa9b-318b2909bd27" }, "TargetNumberOfNodes": "3" }
  • Pour plus de détails sur l’API, consultez DescribeResize dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-scheduled-actions.

AWS CLI

Pour décrire des actions planifiées

L’exemple describe-scheduled-actions suivant affiche les détails de toutes les actions actuellement planifiées.

aws redshift describe-scheduled-actions

Sortie :

{ "ScheduledActions": [ { "ScheduledActionName": "resizecluster", "TargetAction": { "ResizeCluster": { "ClusterIdentifier": "mycluster", "NumberOfNodes": 4, "Classic": false } }, "Schedule": "at(2019-12-10T00:07:00)", "IamRole": "arn:aws:iam::123456789012:role/myRedshiftRole", "State": "ACTIVE", "NextInvocations": [ "2019-12-10T00:07:00Z" ] } ] }
  • Pour plus de détails sur l’API, consultez DescribeScheduledActions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-snapshot-copy-grants.

AWS CLI

Pour décrire les autorisations de copie d’instantanés

L’exemple describe-snapshot-copy-grants suivant affiche les détails de l’autorisation de copie d’instantanés de cluster spécifiée.

aws redshift describe-snapshot-copy-grants \ --snapshot-copy-grant-name mysnapshotcopygrantname

Sortie :

{ "SnapshotCopyGrants": [ { "SnapshotCopyGrantName": "mysnapshotcopygrantname", "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY", "Tags": [] } ] }

Pour plus d’informations, consultez Chiffrement de base de données Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser describe-snapshot-schedules.

AWS CLI

Pour décrire les planifications d’instantané

L’exemple describe-snapshot-schedules suivant affiche les détails de la planification d’instantané de cluster spécifiée.

aws redshift describe-snapshot-schedules \ --cluster-identifier mycluster \ --schedule-identifier mysnapshotschedule

Sortie :

{ "SnapshotSchedules": [ { "ScheduleDefinitions": [ "rate(12 hours)" ], "ScheduleIdentifier": "mysnapshotschedule", "ScheduleDescription": "My schedule description", "Tags": [], "AssociatedClusterCount": 1, "AssociatedClusters": [ { "ClusterIdentifier": "mycluster", "ScheduleAssociationState": "ACTIVE" } ] } ] }

Pour plus d’informations, consultez Planifications d’un instantané automatique dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser describe-storage.

AWS CLI

Pour décrire le stockage

L’exemple describe-storage suivant affiche des détails sur le stockage de sauvegarde et les tailles de stockage provisoires du compte.

aws redshift describe-storage

Sortie :

{ "TotalBackupSizeInMegaBytes": 193149.0, "TotalProvisionedStorageInMegaBytes": 655360.0 }

Pour plus d’informations, consultez Gestion du stockage des instantanés dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DescribeStorage dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-table-restore-status.

AWS CLI

Pour décrire le statut des demandes de restauration de table à partir d’un instantané de cluster

L’exemple describe-table-restore-status suivant affiche les détails des demandes de restauration de table effectuées pour le cluster spécifié.

aws redshift describe-table-restore-status / --cluster-identifier mycluster

Sortie :

{ "TableRestoreStatusDetails": [ { "TableRestoreRequestId": "z1116630-0e80-46f4-ba86-bd9670411ebd", "Status": "IN_PROGRESS", "RequestTime": "2019-12-27T18:22:12.257Z", "ClusterIdentifier": "mycluster", "SnapshotIdentifier": "mysnapshotid", "SourceDatabaseName": "dev", "SourceSchemaName": "public", "SourceTableName": "mytable", "TargetDatabaseName": "dev", "TargetSchemaName": "public", "NewTableName": "mytable-clone" } ] }

Pour plus d’informations, consultez Restauration d’une table à partir d’un instantané dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser describe-tags.

AWS CLI

Pour décrire les balises

L’exemple describe-tags suivant affiche les ressources que le cluster spécifié a associées aux noms et valeurs de balises spécifiés.

aws redshift describe-tags \ --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ --tag-keys clustertagkey \ --tag-values clustertagvalue

Sortie :

{ "TaggedResources": [ { "Tag": { "Key": "clustertagkey", "Value": "clustertagvalue" }, "ResourceName": "arn:aws:redshift:us-west-2:123456789012:cluster:mycluster", "ResourceType": "cluster" } ] }

Pour plus d’informations, consultez Balisage des ressources dans Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DescribeTags dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser disable-snapshot-copy.

AWS CLI

Pour désactiver la copie d’instantanés pour un cluster

L’exemple disable-snapshot-copy suivant désactive la copie automatique d’un instantané pour le cluster spécifié.

aws redshift disable-snapshot-copy \ --cluster-identifier mycluster

Sortie :

{ "Cluster": { "ClusterIdentifier": "mycluster", "NodeType": "dc2.large", "ClusterStatus": "available", "ClusterAvailabilityStatus": "Available", "MasterUsername": "adminuser", "DBName": "dev", "Endpoint": { "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", "Port": 5439 }, "ClusterCreateTime": "2019-12-05T18:44:36.991Z", "AutomatedSnapshotRetentionPeriod": 3, "ManualSnapshotRetentionPeriod": -1, "ClusterSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sh-i9b431cd", "Status": "active" } ], "ClusterParameterGroups": [ { "ParameterGroupName": "default.redshift-1.0", "ParameterApplyStatus": "in-sync" } ], "ClusterSubnetGroupName": "default", "VpcId": "vpc-b1fel7t9", "AvailabilityZone": "us-west-2f", "PreferredMaintenanceWindow": "sat:16:00-sat:16:30", "PendingModifiedValues": { "NodeType": "dc2.large", "NumberOfNodes": 2, "ClusterType": "multi-node" }, "ClusterVersion": "1.0", "AllowVersionUpgrade": true, "NumberOfNodes": 4, "PubliclyAccessible": false, "Encrypted": false, "Tags": [ { "Key": "mytags", "Value": "tag1" } ], "EnhancedVpcRouting": false, "IamRoles": [ { "IamRoleArn": "arn:aws:iam::123456789012:role/myRedshiftRole", "ApplyStatus": "in-sync" } ], "MaintenanceTrackName": "current", "DeferredMaintenanceWindows": [], "ExpectedNextSnapshotScheduleTime": "2019-12-10T04:42:43.390Z", "ExpectedNextSnapshotScheduleTimeStatus": "OnTrack", "NextMaintenanceWindowStartTime": "2019-12-14T16:00:00Z" } }

Pour plus d’informations, consultez Copie d’instantanés sur une autre région AWS dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez DisableSnapshotCopy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser enable-snapshot-copy.

AWS CLI

Pour activer la copie d’instantanés pour un cluster

L’exemple enable-snapshot-copy suivant active la copie automatique d’un instantané pour le cluster spécifié.

aws redshift enable-snapshot-copy \ --cluster-identifier mycluster \ --destination-region us-west-1

Sortie :

{ "Cluster": { "ClusterIdentifier": "mycluster", "NodeType": "dc2.large", "ClusterStatus": "available", "ClusterAvailabilityStatus": "Available", "MasterUsername": "adminuser", "DBName": "dev", "Endpoint": { "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", "Port": 5439 }, "ClusterCreateTime": "2019-12-05T18:44:36.991Z", "AutomatedSnapshotRetentionPeriod": 3, "ManualSnapshotRetentionPeriod": -1, "ClusterSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sh-f4c731cd", "Status": "active" } ], "ClusterParameterGroups": [ { "ParameterGroupName": "default.redshift-1.0", "ParameterApplyStatus": "in-sync" } ], "ClusterSubnetGroupName": "default", "VpcId": "vpc-b1ael7t9", "AvailabilityZone": "us-west-2f", "PreferredMaintenanceWindow": "sat:16:00-sat:16:30", "PendingModifiedValues": { "NodeType": "dc2.large", "NumberOfNodes": 2, "ClusterType": "multi-node" }, "ClusterVersion": "1.0", "AllowVersionUpgrade": true, "NumberOfNodes": 4, "PubliclyAccessible": false, "Encrypted": false, "ClusterSnapshotCopyStatus": { "DestinationRegion": "us-west-1", "RetentionPeriod": 7, "ManualSnapshotRetentionPeriod": -1 }, "Tags": [ { "Key": "mytags", "Value": "tag1" } ], "EnhancedVpcRouting": false, "IamRoles": [ { "IamRoleArn": "arn:aws:iam::123456789012:role/myRedshiftRole", "ApplyStatus": "in-sync" } ], "MaintenanceTrackName": "current", "DeferredMaintenanceWindows": [], "ExpectedNextSnapshotScheduleTime": "2019-12-10T04:42:43.390Z", "ExpectedNextSnapshotScheduleTimeStatus": "OnTrack", "NextMaintenanceWindowStartTime": "2019-12-14T16:00:00Z" } }

Pour plus d’informations, consultez Copie d’instantanés sur une autre région AWS dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez EnableSnapshotCopy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-cluster-credentials.

AWS CLI

Pour obtenir les informations d’identification du cluster pour un compte AWS

L’exemple get-cluster-credentials suivant récupère les informations d’identification temporaires qui permettent d’accéder à une base de données Amazon Redshift.

aws redshift get-cluster-credentials \ --db-user adminuser --db-name dev \ --cluster-identifier mycluster

Sortie :

{ "DbUser": "IAM:adminuser", "DbPassword": "AMAFUyyuros/QjxPTtgzcsuQsqzIasdzJEN04aCtWDzXx1O9d6UmpkBtvEeqFly/EXAMPLE==", "Expiration": "2019-12-10T17:25:05.770Z" }

Pour plus d’informations, consultez Générer les informations d’identification de la base de données IAM à l’aide de la CLI ou de l’API d’Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez GetClusterCredentials dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-reserved-node-exchange-offerings.

AWS CLI

Pour obtenir des offres d’échange de nœuds réservés

L’exemple get-reserved-node-exchange-offerings suivant récupère un tableau DC2 ReservedNodeOfferings correspondant au nœud réservé DC1 spécifié.

aws redshift get-reserved-node-exchange-offerings \ --reserved-node-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE

Sortie :

{ "ReservedNodeOfferings": [ { "ReservedNodeOfferingId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", "NodeType": "dc2.large", "Duration": 31536000, "FixedPrice": 0.0, "UsagePrice": 0.0, "CurrencyCode": "USD", "OfferingType": "All Upfront", "RecurringCharges": [ { "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" } ], "ReservedNodeOfferingType": "Regular" } ] }

Pour plus d’informations, consultez Mise à niveau des nœuds réservés avec l’AWS CLI dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser modify-cluster-iam-roles.

AWS CLI

Pour modifier le rôle IAM d’un cluster

L’exemple modify-cluster-iam-roles suivant supprime le rôle AWS IAM spécifié du cluster spécifié.

aws redshift modify-cluster-iam-roles \ --cluster-identifier mycluster \ --remove-iam-roles arn:aws:iam::123456789012:role/myRedshiftRole

Sortie :

{ "Cluster": { "ClusterIdentifier": "mycluster", "NodeType": "dc2.large", "ClusterStatus": "available", "ClusterAvailabilityStatus": "Available", "MasterUsername": "adminuser", "DBName": "dev", "Endpoint": { "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", "Port": 5439 }, "ClusterCreateTime": "2019-12-05T18:44:36.991Z", "AutomatedSnapshotRetentionPeriod": 3, "ManualSnapshotRetentionPeriod": -1, "ClusterSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sh-f9b731sd", "Status": "active" } ], "ClusterParameterGroups": [ { "ParameterGroupName": "default.redshift-1.0", "ParameterApplyStatus": "in-sync" } ], "ClusterSubnetGroupName": "default", "VpcId": "vpc-b2fal7t9", "AvailabilityZone": "us-west-2f", "PreferredMaintenanceWindow": "sat:16:00-sat:16:30", "PendingModifiedValues": { "NodeType": "dc2.large", "NumberOfNodes": 2, "ClusterType": "multi-node" }, "ClusterVersion": "1.0", "AllowVersionUpgrade": true, "NumberOfNodes": 4, "PubliclyAccessible": false, "Encrypted": false, "ClusterSnapshotCopyStatus": { "DestinationRegion": "us-west-1", "RetentionPeriod": 7, "ManualSnapshotRetentionPeriod": -1 }, "Tags": [ { "Key": "mytags", "Value": "tag1" } ], "EnhancedVpcRouting": false, "IamRoles": [], "MaintenanceTrackName": "current", "DeferredMaintenanceWindows": [], "ExpectedNextSnapshotScheduleTime": "2019-12-11T04:42:55.631Z", "ExpectedNextSnapshotScheduleTimeStatus": "OnTrack", "NextMaintenanceWindowStartTime": "2019-12-14T16:00:00Z" } }

Pour plus d’informations, consultez Utilisation des politiques basées sur l’identité (politiques IAM) pour Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez ModifyClusterIamRoles dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-cluster-maintenance.

AWS CLI

Pour modifier la maintenance du cluster

L’exemple modify-cluster-maintenance suivant reporte de 30 jours la maintenance du cluster spécifié.

aws redshift modify-cluster-maintenance \ --cluster-identifier mycluster \ --defer-maintenance \ --defer-maintenance-duration 30

Sortie :

{ "Cluster": { "ClusterIdentifier": "mycluster", "NodeType": "dc2.large", "ClusterStatus": "available", "ClusterAvailabilityStatus": "Available", "MasterUsername": "adminuser", "DBName": "dev", "Endpoint": { "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", "Port": 5439 }, "ClusterCreateTime": "2019-12-05T18:44:36.991Z", "AutomatedSnapshotRetentionPeriod": 3, "ManualSnapshotRetentionPeriod": -1, "ClusterSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sh-a1a123ab", "Status": "active" } ], "ClusterParameterGroups": [ { "ParameterGroupName": "default.redshift-1.0", "ParameterApplyStatus": "in-sync" } ], "ClusterSubnetGroupName": "default", "VpcId": "vpc-b1ael7t9", "AvailabilityZone": "us-west-2f", "PreferredMaintenanceWindow": "sat:16:00-sat:16:30", "PendingModifiedValues": { "NodeType": "dc2.large", "NumberOfNodes": 2, "ClusterType": "multi-node" }, "ClusterVersion": "1.0", "AllowVersionUpgrade": true, "NumberOfNodes": 4, "PubliclyAccessible": false, "Encrypted": false, "ClusterSnapshotCopyStatus": { "DestinationRegion": "us-west-1", "RetentionPeriod": 7, "ManualSnapshotRetentionPeriod": -1 }, "Tags": [ { "Key": "mytags", "Value": "tag1" } ], "EnhancedVpcRouting": false, "IamRoles": [], "MaintenanceTrackName": "current", "DeferredMaintenanceWindows": [ { "DeferMaintenanceIdentifier": "dfm-mUdVIfFcT1B4SGhw6fyF", "DeferMaintenanceStartTime": "2019-12-10T18:18:39.354Z", "DeferMaintenanceEndTime": "2020-01-09T18:18:39.354Z" } ], "ExpectedNextSnapshotScheduleTime": "2019-12-11T04:42:55.631Z", "ExpectedNextSnapshotScheduleTimeStatus": "OnTrack", "NextMaintenanceWindowStartTime": "2020-01-11T16:00:00Z" } }

Pour plus d’informations, consultez Maintenance des clusters dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez ModifyClusterMaintenance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-cluster-parameter-group.

AWS CLI

Pour modifier les paramètres d’un groupe de paramètres

L’exemple modify-cluster-parameter-group suivant modifie le paramètre wlm_json_configuration pour la gestion de la charge de travail. Il accepte les paramètres d’un fichier contenant le contenu JSON indiqué ci-dessous.

aws redshift modify-cluster-parameter-group \ --parameter-group-name myclusterparametergroup \ --parameters file://modify_pg.json

Contenu de modify_pg.json :

[ { "ParameterName": "wlm_json_configuration", "ParameterValue": "[{\"user_group\":\"example_user_group1\",\"query_group\": \"example_query_group1\", \"query_concurrency\":7},{\"query_concurrency\":5}]" } ]

Sortie :

{ "ParameterGroupStatus": "Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.", "ParameterGroupName": "myclusterparametergroup", "ResponseMetadata": { "RequestId": "09974cc0-64cd-11e2-bea9-49e0ce183f07" } }

L’exemple de code suivant montre comment utiliser modify-cluster-snapshot-schedule.

AWS CLI

Pour modifier une planification des instantanés du cluster

L’exemple modify-cluster-snapshot-schedule suivant supprime la planification des instantanés spécifiée du cluster spécifié.

aws redshift modify-cluster-snapshot-schedule \ --cluster-identifier mycluster \ --schedule-identifier mysnapshotschedule \ --disassociate-schedule

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Planifications d’un instantané automatique dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser modify-cluster-snapshot.

AWS CLI

Pour modifier un instantané de cluster

L’exemple modify-cluster-snapshot suivant définit le paramètre de période de rétention manuelle pour l’instantané de cluster spécifié sur une valeur de 10 jours.

aws redshift modify-cluster-snapshot \ --snapshot-identifier mycluster-2019-11-06-16-32 \ --manual-snapshot-retention-period 10

Sortie :

{ "Snapshot": { "SnapshotIdentifier": "mycluster-2019-11-06-16-32", "ClusterIdentifier": "mycluster", "SnapshotCreateTime": "2019-12-07T00:34:05.633Z", "Status": "available", "Port": 5439, "AvailabilityZone": "us-west-2f", "ClusterCreateTime": "2019-12-05T18:44:36.991Z", "MasterUsername": "adminuser", "ClusterVersion": "1.0", "SnapshotType": "manual", "NodeType": "dc2.large", "NumberOfNodes": 2, "DBName": "dev", "VpcId": "vpc-b1cel7t9", "Encrypted": false, "EncryptedWithHSM": false, "OwnerAccount": "123456789012", "TotalBackupSizeInMegaBytes": 64384.0, "ActualIncrementalBackupSizeInMegaBytes": 24.0, "BackupProgressInMegaBytes": 24.0, "CurrentBackupRateInMegaBytesPerSecond": 13.0011, "EstimatedSecondsToCompletion": 0, "ElapsedTimeInSeconds": 1, "Tags": [ { "Key": "mytagkey", "Value": "mytagvalue" } ], "EnhancedVpcRouting": false, "MaintenanceTrackName": "current", "ManualSnapshotRetentionPeriod": 10, "ManualSnapshotRemainingDays": 6, "SnapshotRetentionStartTime": "2019-12-07T00:34:07.479Z" } }

Pour plus d’informations, consultez Instantanés Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez ModifyClusterSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-cluster-subnet-group.

AWS CLI

Modification des sous-réseaux d’un groupe de sous-réseaux de cluster Cet exemple montre comment modifier la liste des sous-réseaux d’un groupe de sous-réseaux de cache. JSON est le format de sortie par défaut. Commande :

aws redshift modify-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --subnet-ids subnet-763fdd1 subnet-ac830e9

Résultat :

{ "ClusterSubnetGroup": { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-763fdd1c", "SubnetAvailabilityZone": { "Name": "us-east-1a" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-ac830e9", "SubnetAvailabilityZone": { "Name": "us-east-1b" } } ], "VpcId": "vpc-7e3fdd14", "SubnetGroupStatus": "Complete", "Description": "My subnet group", "ClusterSubnetGroupName": "mysubnetgroup" }, "ResponseMetadata": { "RequestId": "8da93e89-8372-f936-93a8-873918938197a" } }
  • Pour plus de détails sur l’API, consultez ModifyClusterSubnetGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-cluster.

AWS CLI

Association d’un groupe de sécurité à un cluster Cet exemple montre comment associer un groupe de sécurité de cluster au cluster spécifié. Commande :

aws redshift modify-cluster --cluster-identifier mycluster --cluster-security-groups mysecuritygroup

Modification de la fenêtre de maintenance d’un cluster Cet exemple montre comment modifier la fenêtre de maintenance hebdomadaire préférée pour un cluster afin qu’elle soit la fenêtre minimale de quatre heures commençant le dimanche à 23 h 15 et se terminant le lundi à 3 h 15. Commande :

aws redshift modify-cluster --cluster-identifier mycluster --preferred-maintenance-window Sun:23:15-Mon:03:15

Modification du mot de passe principal du cluster Cet exemple montre comment modifier le mot de passe principal d’un cluster. Commande :

aws redshift modify-cluster --cluster-identifier mycluster --master-user-password A1b2c3d4
  • Pour plus de détails sur l’API, consultez AWS CLIModifyCluster dans la Référence des commandes de l’.

L’exemple de code suivant montre comment utiliser modify-event-subscription.

AWS CLI

Pour modifier un abonnement aux événements

L’exemple modify-event-subscription suivant désactive l’abonnement aux notifications d’événements spécifié.

aws redshift modify-event-subscription \ --subscription-name mysubscription \ --no-enabled

Sortie :

{ "EventSubscription": { "CustomerAwsId": "123456789012", "CustSubscriptionId": "mysubscription", "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:MySNStopic", "Status": "active", "SubscriptionCreationTime": "2019-12-09T21:50:21.332Z", "SourceIdsList": [], "EventCategoriesList": [ "management" ], "Severity": "ERROR", "Enabled": false, "Tags": [] } }

Pour plus d’informations, consultez Abonnement à la notification d’événement Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez ModifyEventSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-scheduled-action.

AWS CLI

Pour modifier une action planifiée

L’exemple modify-scheduled-action suivant ajoute une description à l’action planifiée existante spécifiée.

aws redshift modify-scheduled-action \ --scheduled-action-name myscheduledaction \ --scheduled-action-description "My scheduled action"

Sortie :

{ "ScheduledActionName": "myscheduledaction", "TargetAction": { "ResizeCluster": { "ClusterIdentifier": "mycluster", "NumberOfNodes": 2, "Classic": false } }, "Schedule": "at(2019-12-25T00:00:00)", "IamRole": "arn:aws:iam::123456789012:role/myRedshiftRole", "ScheduledActionDescription": "My scheduled action", "State": "ACTIVE", "NextInvocations": [ "2019-12-25T00:00:00Z" ] }
  • Pour plus de détails sur l’API, consultez ModifyScheduledAction dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-snapshot-copy-retention-period.

AWS CLI

Pour modifier la période de rétention de la copie d’instantané

L’exemple modify-snapshot-copy-retention-period suivant modifie le nombre de jours pendant lesquels les instantanés automatiques doivent être retenus pour le cluster spécifié dans la région AWS de destination après avoir été copiés à partir de la région AWS source.

aws redshift modify-snapshot-copy-retention-period \ --cluster-identifier mycluster \ --retention-period 15

Sortie :

{ "Cluster": { "ClusterIdentifier": "mycluster", "NodeType": "dc2.large", "ClusterStatus": "available", "ClusterAvailabilityStatus": "Available", "MasterUsername": "adminuser", "DBName": "dev", "Endpoint": { "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", "Port": 5439 }, "ClusterCreateTime": "2019-12-05T18:44:36.991Z", "AutomatedSnapshotRetentionPeriod": 3, "ManualSnapshotRetentionPeriod": -1, "ClusterSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sh-a1a123ab", "Status": "active" } ], "ClusterParameterGroups": [ { "ParameterGroupName": "default.redshift-1.0", "ParameterApplyStatus": "in-sync" } ], "ClusterSubnetGroupName": "default", "VpcId": "vpc-b1fet7t9", "AvailabilityZone": "us-west-2f", "PreferredMaintenanceWindow": "sat:16:00-sat:16:30", "PendingModifiedValues": { "NodeType": "dc2.large", "NumberOfNodes": 2, "ClusterType": "multi-node" }, "ClusterVersion": "1.0", "AllowVersionUpgrade": true, "NumberOfNodes": 4, "PubliclyAccessible": false, "Encrypted": false, "ClusterSnapshotCopyStatus": { "DestinationRegion": "us-west-1", "RetentionPeriod": 15, "ManualSnapshotRetentionPeriod": -1 }, "Tags": [ { "Key": "mytags", "Value": "tag1" } ], "EnhancedVpcRouting": false, "IamRoles": [], "MaintenanceTrackName": "current", "DeferredMaintenanceWindows": [ { "DeferMaintenanceIdentifier": "dfm-mUdVSfDcT1F4SGhw6fyF", "DeferMaintenanceStartTime": "2019-12-10T18:18:39.354Z", "DeferMaintenanceEndTime": "2020-01-09T18:18:39.354Z" } ], "NextMaintenanceWindowStartTime": "2020-01-11T16:00:00Z" } }

Pour plus d’informations, consultez Format de la planification d’instantané dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser modify-snapshot-schedule.

AWS CLI

Pour modifier la planification d’instantané

L’exemple modify-snapshot-schedule suivant modifie la fréquence de la planification d’instantanés spécifiée à toutes les 10 heures.

aws redshift modify-snapshot-schedule \ --schedule-identifier mysnapshotschedule \ --schedule-definitions "rate(10 hours)"

Sortie :

{ "ScheduleDefinitions": [ "rate(10 hours)" ], "ScheduleIdentifier": "mysnapshotschedule", "ScheduleDescription": "My schedule description", "Tags": [] }

Pour plus d’informations, consultez Format de la planification d’instantané dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez ModifySnapshotSchedule dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser purchase-reserved-node-offering.

AWS CLI

Achat d’un nœud réservé Cet exemple montre comment acheter une offre de nœud réservé. L’reserved-node-offering-id est obtenu en appelant describe-reserved-node-offerings. Commande :

aws redshift purchase-reserved-node-offering --reserved-node-offering-id ceb6a579-cf4c-4343-be8b-d832c45ab51c

Résultat :

{ "ReservedNode": { "OfferingType": "Heavy Utilization", "FixedPrice": "", "NodeType": "dw.hs1.xlarge", "ReservedNodeId": "1ba8e2e3-bc01-4d65-b35d-a4a3e931547e", "UsagePrice": "", "RecurringCharges": [ { "RecurringChargeAmount": "", "RecurringChargeFrequency": "Hourly" } ], "NodeCount": 1, "State": "payment-pending", "StartTime": "2013-02-13T17:08:39.051Z", "Duration": 31536000, "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c" }, "ResponseMetadata": { "RequestId": "01bda7bf-7600-11e2-b605-2568d7396e7f" } }

L’exemple de code suivant montre comment utiliser reboot-cluster.

AWS CLI

Redémarrage d’un cluster Cet exemple redémarre un cluster. JSON est le format de sortie par défaut. Commande :

aws redshift reboot-cluster --cluster-identifier mycluster

Résultat :

{ "Cluster": { "NodeType": "dw.hs1.xlarge", "Endpoint": { "Port": 5439, "Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com" }, "ClusterVersion": "1.0", "PubliclyAccessible": "true", "MasterUsername": "adminuser", "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": \[], "AvailabilityZone": "us-east-1a", "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "PreferredMaintenanceWindow": "sun:23:15-mon:03:15", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "rebooting", "ClusterIdentifier": "mycluster", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} }, "ResponseMetadata": { "RequestId": "61c8b564-64e8-11e2-8f7d-3b939af52818" } }
  • Pour plus de détails sur l’API, consultez RebootCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser reset-cluster-parameter-group.

AWS CLI

Réinitialisation des paramètres d’un groupe de paramètres Cet exemple montre comment réinitialiser tous les paramètres d’un groupe de paramètres. Commande :

aws redshift reset-cluster-parameter-group --parameter-group-name myclusterparametergroup --reset-all-parameters

L’exemple de code suivant montre comment utiliser resize-cluster.

AWS CLI

Pour redimensionner un cluster

L’exemple resize-cluster suivant redimensionne le cluster spécifié.

aws redshift resize-cluster \ --cluster-identifier mycluster \ --cluster-type multi-node \ --node-type dc2.large \ --number-of-nodes 6 \ --classic

Sortie :

{ "Cluster": { "ClusterIdentifier": "mycluster", "NodeType": "dc2.large", "ClusterStatus": "resizing", "ClusterAvailabilityStatus": "Modifying", "MasterUsername": "adminuser", "DBName": "dev", "Endpoint": { "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", "Port": 5439 }, "ClusterCreateTime": "2019-12-05T18:44:36.991Z", "AutomatedSnapshotRetentionPeriod": 3, "ManualSnapshotRetentionPeriod": -1, "ClusterSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sh-a1a123ab", "Status": "active" } ], "ClusterParameterGroups": [ { "ParameterGroupName": "default.redshift-1.0", "ParameterApplyStatus": "in-sync" } ], "ClusterSubnetGroupName": "default", "VpcId": "vpc-a1abc1a1", "AvailabilityZone": "us-west-2f", "PreferredMaintenanceWindow": "sat:16:00-sat:16:30", "PendingModifiedValues": { "NodeType": "dc2.large", "NumberOfNodes": 6, "ClusterType": "multi-node" }, "ClusterVersion": "1.0", "AllowVersionUpgrade": true, "NumberOfNodes": 4, "PubliclyAccessible": false, "Encrypted": false, "ClusterSnapshotCopyStatus": { "DestinationRegion": "us-west-1", "RetentionPeriod": 15, "ManualSnapshotRetentionPeriod": -1 }, "Tags": [ { "Key": "mytags", "Value": "tag1" } ], "EnhancedVpcRouting": false, "IamRoles": [], "MaintenanceTrackName": "current", "DeferredMaintenanceWindows": [ { "DeferMaintenanceIdentifier": "dfm-mUdVCfDcT1B4SGhw6fyF", "DeferMaintenanceStartTime": "2019-12-10T18:18:39.354Z", "DeferMaintenanceEndTime": "2020-01-09T18:18:39.354Z" } ], "NextMaintenanceWindowStartTime": "2020-01-11T16:00:00Z", "ResizeInfo": { "ResizeType": "ClassicResize", "AllowCancelResize": true } } }

Pour plus d’informations, consultez Redimensionnement d’un cluster dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez ResizeCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser restore-from-cluster-snapshot.

AWS CLI

Restauration d’un cluster à partir d’un instantané Cet exemple restaure un cluster à partir d’un instantané. Commande :

aws redshift restore-from-cluster-snapshot --cluster-identifier mycluster-clone --snapshot-identifier my-snapshot-id

Résultat :

{ "Cluster": { "NodeType": "dw.hs1.xlarge", "ClusterVersion": "1.0", "PubliclyAccessible": "true", "MasterUsername": "adminuser", "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": \[], "PreferredMaintenanceWindow": "sun:23:15-mon:03:15", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "creating", "ClusterIdentifier": "mycluster-clone", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} }, "ResponseMetadata": { "RequestId": "77fd512b-64e3-11e2-8f5b-e90bd6c77476" } }

L’exemple de code suivant montre comment utiliser restore-table-from-cluster-snapshot.

AWS CLI

Pour restaurer une table à partir d’un instantané de cluster

L’exemple restore-table-from-cluster-snapshot suivant crée une nouvelle table à partir de la table spécifiée dans l’instantané de cluster spécifié.

aws redshift restore-table-from-cluster-snapshot / --cluster-identifier mycluster / --snapshot-identifier mycluster-2019-11-19-16-17 / --source-database-name dev / --source-schema-name public / --source-table-name mytable / --target-database-name dev / --target-schema-name public / --new-table-name mytable-clone

Sortie :

{ "TableRestoreStatus": { "TableRestoreRequestId": "a123a12b-abc1-1a1a-a123-a1234ab12345", "Status": "PENDING", "RequestTime": "2019-12-20T00:20:16.402Z", "ClusterIdentifier": "mycluster", "SnapshotIdentifier": "mycluster-2019-11-19-16-17", "SourceDatabaseName": "dev", "SourceSchemaName": "public", "SourceTableName": "mytable", "TargetDatabaseName": "dev", "TargetSchemaName": "public", "NewTableName": "mytable-clone" } }

Pour plus d’informations, consultez Restauration d’une table à partir d’un instantané dans le Guide de gestion des clusters Amazon Redshift.

L’exemple de code suivant montre comment utiliser revoke-cluster-security-group-ingress.

AWS CLI

Révocation de l’accès à un groupe de sécurité EC2 Cet exemple révoque l’accès à un groupe de sécurité Amazon EC2 nommé. Commande :

aws redshift revoke-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --ec2-security-group-name myec2securitygroup --ec2-security-group-owner-id 123445677890

Révocation de l’accès à une plage d’adresses CIDR Cet exemple révoque l’accès à une plage d’adresses CIDR. Commande :

aws redshift revoke-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32

L’exemple de code suivant montre comment utiliser revoke-snapshot-access.

AWS CLI

Révocation de l’autorisation d’un compte AWS pour restaurer un instantané Cet exemple révoque l’autorisation du compte AWS 444455556666 pour restaurer l’instantané my-snapshot-id. JSON est le format de sortie par défaut. Commande :

aws redshift revoke-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666

Résultat :

{ "Snapshot": { "Status": "available", "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", "EstimatedSecondsToCompletion": 0, "AvailabilityZone": "us-east-1a", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "Encrypted": false, "OwnerAccount": "111122223333", "BackupProgressInMegabytes": 11.0, "ElapsedTimeInSeconds": 0, "DBName": "dev", "CurrentBackupRateInMegabytesPerSecond: 0.1534, "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "ActualIncrementalBackupSizeInMegabytes"; 11.0, "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "mycluster", "TotalBackupSizeInMegabytes": 20.0, "Port": 5439, "NumberOfNodes": 2, "SnapshotIdentifier": "my-snapshot-id" } }
  • Pour plus de détails sur l’API, consultez RevokeSnapshotAccess dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser rotate-encryption-key.

AWS CLI

Pour effectuer une rotation de la clé de chiffrement pour un cluster

L’exemple rotate-encryption-key suivant effectue une rotation de la clé de chiffrement pour le cluster spécifié.

aws redshift rotate-encryption-key \ --cluster-identifier mycluster

Sortie :

{ "Cluster": { "ClusterIdentifier": "mycluster", "NodeType": "dc2.large", "ClusterStatus": "rotating-keys", "ClusterAvailabilityStatus": "Modifying", "MasterUsername": "adminuser", "DBName": "dev", "Endpoint": { "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", "Port": 5439 }, "ClusterCreateTime": "2019-12-10T19:25:45.886Z", "AutomatedSnapshotRetentionPeriod": 30, "ManualSnapshotRetentionPeriod": -1, "ClusterSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sh-a1a123ab", "Status": "active" } ], "ClusterParameterGroups": [ { "ParameterGroupName": "default.redshift-1.0", "ParameterApplyStatus": "in-sync" } ], "ClusterSubnetGroupName": "default", "VpcId": "vpc-a1abc1a1", "AvailabilityZone": "us-west-2a", "PreferredMaintenanceWindow": "sat:16:00-sat:16:30", "PendingModifiedValues": {}, "ClusterVersion": "1.0", "AllowVersionUpgrade": true, "NumberOfNodes": 2, "PubliclyAccessible": false, "Encrypted": true, "Tags": [], "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY", "EnhancedVpcRouting": false, "IamRoles": [ { "IamRoleArn": "arn:aws:iam::123456789012:role/myRedshiftRole", "ApplyStatus": "in-sync" } ], "MaintenanceTrackName": "current", "DeferredMaintenanceWindows": [], "NextMaintenanceWindowStartTime": "2019-12-14T16:00:00Z" } }

Pour plus d’informations, consultez Chiffrement de base de données Amazon Redshift dans le Guide de gestion des clusters Amazon Redshift.

  • Pour plus de détails sur l’API, consultez RotateEncryptionKey dans la Référence des commandes de l’AWS CLI.