Exemples d’utilisation de l’AWS CLI avec DAX - AWS Command Line Interface
Actions

Exemples d’utilisation de l’AWS CLI avec DAX

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 DAX.

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 create-cluster.

AWS CLI

Pour créer un cluster DAX

L’exemple create-cluster suivant crée un cluster DAX avec les paramètres spécifiés.

aws dax create-cluster \
    --cluster-name daxcluster \
    --node-type dax.r4.large \
    --replication-factor 3 \
    --iam-role-arn roleARN  \
    --sse-specification Enabled=true

Sortie :

{
    "Cluster": {
        "ClusterName": "daxcluster",
        "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
        "TotalNodes": 3,
        "ActiveNodes": 0,
        "NodeType": "dax.r4.large",
        "Status": "creating",
        "ClusterDiscoveryEndpoint": {
            "Port": 8111
        },
        "PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
        "SubnetGroup": "default",
        "SecurityGroups": [
            {
                "SecurityGroupIdentifier": "sg-1af6e36e",
                "Status": "active"
            }
        ],
        "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
        "ParameterGroup": {
            "ParameterGroupName": "default.dax1.0",
            "ParameterApplyStatus": "in-sync",
            "NodeIdsToReboot": []
        },
        "SSEDescription": {
            "Status": "ENABLED"
        }
    }
}

Pour plus d’informations, consultez Étape 3 : Créer un cluster DAX dans le Manuel du développeur Amazon DynamoDB.

  • 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-parameter-group.

AWS CLI

Pour créer un groupe de paramètres

L’exemple create-parameter-group suivant crée un groupe de paramètres avec les paramètres spécifiés.

aws dax create-parameter-group \
    --parameter-group-name daxparametergroup \
    --description "A new parameter group"

Sortie :

{
    "ParameterGroup": {
        "ParameterGroupName": "daxparametergroup",
        "Description": "A new parameter group"
    }
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

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

AWS CLI

Pour créer un groupe de sous-réseaux DAX

L’exemple create-subnet-group suivant crée un groupe de sous-réseaux avec les paramètres spécifiés.

aws dax create-subnet-group \
    --subnet-group-name daxSubnetGroup \
    --subnet-ids subnet-11111111 subnet-22222222

Sortie :

{
    "SubnetGroup": {
        "SubnetGroupName": "daxSubnetGroup",
        "VpcId": "vpc-05a1fa8e00c325226",
        "Subnets": [
            {
                "SubnetIdentifier": "subnet-11111111",
                "SubnetAvailabilityZone": "us-west-2b"
            },
            {
                "SubnetIdentifier": "subnet-22222222",
                "SubnetAvailabilityZone": "us-west-2c"
            }
        ]
    }
}

Pour plus d’informations, consultez Étape 2 : Créer un groupe de sous-réseaux dans le Manuel du développeur Amazon DynamoDB.

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

L’exemple de code suivant montre comment utiliser decrease-replication-factor.

AWS CLI

Pour supprimer un ou plusieurs nœuds du cluster

L’exemple decrease-replication-factor suivant réduit à un le nombre de nœuds dans le cluster DAX spécifié.

aws dax decrease-replication-factor \
    --cluster-name daxcluster \
    --new-replication-factor 1

Sortie :

{
    "Cluster": {
        "ClusterName": "daxcluster",
        "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
        "TotalNodes": 3,
        "ActiveNodes": 3,
        "NodeType": "dax.r4.large",
        "Status": "modifying",
        "ClusterDiscoveryEndpoint": {
            "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
            "Port": 8111
        },
        "Nodes": [
            {
                "NodeId": "daxcluster-a",
                "Endpoint": {
                    "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
                    "Port": 8111
                },
                "NodeCreateTime": 1576625059.509,
                "AvailabilityZone": "us-west-2c",
                "NodeStatus": "available",
                "ParameterGroupStatus": "in-sync"
            },
            {
                "NodeId": "daxcluster-b",
                "Endpoint": {
                    "Address": "daxcluster-b.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
                    "Port": 8111
                },
                "NodeCreateTime": 1576625059.509,
                "AvailabilityZone": "us-west-2a",
                "NodeStatus": "available",
                "ParameterGroupStatus": "in-sync"
            },
            {
                "NodeId": "daxcluster-c",
                "Endpoint": {
                    "Address": "daxcluster-c.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
                    "Port": 8111
                },
                "NodeCreateTime": 1576625059.509,
                "AvailabilityZone": "us-west-2b",
                "NodeStatus": "available",
                "ParameterGroupStatus": "in-sync"
            }
        ],
        "PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
        "SubnetGroup": "default",
        "SecurityGroups": [
            {
                "SecurityGroupIdentifier": "sg-1af6e36e",
                "Status": "active"
            }
        ],
        "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
        "ParameterGroup": {
            "ParameterGroupName": "default.dax1.0",
            "ParameterApplyStatus": "in-sync",
            "NodeIdsToReboot": []
        },
        "SSEDescription": {
            "Status": "ENABLED"
        }
    }
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

AWS CLI

Pour supprimer un cluster DAX

L’exemple delete-cluster suivant supprime le cluster DAX spécifié.

aws dax delete-cluster \
    --cluster-name daxcluster

Sortie :

{
    "Cluster": {
        "ClusterName": "daxcluster",
        "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
        "TotalNodes": 3,
        "ActiveNodes": 0,
        "NodeType": "dax.r4.large",
        "Status": "deleting",
        "ClusterDiscoveryEndpoint": {
            "Address": "dd.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
            "Port": 8111
        },
        "PreferredMaintenanceWindow": "fri:06:00-fri:07:00",
        "SubnetGroup": "default",
        "SecurityGroups": [
            {
                "SecurityGroupIdentifier": "sg-1af6e36e",
                "Status": "active"
            }
        ],
        "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
        "ParameterGroup": {
            "ParameterGroupName": "default.dax1.0",
            "ParameterApplyStatus": "in-sync",
            "NodeIdsToReboot": []
        },
        "SSEDescription": {
            "Status": "ENABLED"
        }
    }
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

  • 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-parameter-group.

AWS CLI

Pour supprimer un groupe de paramètres

L’exemple delete-parameter-group suivant supprime le groupe de paramètres DAX spécifié.

aws dax  delete-parameter-group \
    --parameter-group-name daxparametergroup

Sortie :

{
    "DeletionMessage": "Parameter group daxparametergroup has been deleted."
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

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

AWS CLI

Pour supprimer un groupe de sous-réseaux

L’exemple delete-subnet-group suivant supprime le groupe de sous-réseaux DAX spécifié.

aws dax delete-subnet-group \
    --subnet-group-name daxSubnetGroup

Sortie :

{
    "DeletionMessage": "Subnet group daxSubnetGroup has been deleted."
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

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

AWS CLI

Pour renvoyer les informations sur tous les clusters DAX alloués

L’exemple describe-clusters suivant affiche les informations sur tous les clusters DAX alloués.

aws dax describe-clusters

Sortie :

{
    "Clusters": [
        {
            "ClusterName": "daxcluster",
            "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
            "TotalNodes": 1,
            "ActiveNodes": 1,
            "NodeType": "dax.r4.large",
            "Status": "available",
            "ClusterDiscoveryEndpoint": {
                "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
                "Port": 8111
            },
            "Nodes": [
                {
                    "NodeId": "daxcluster-a",
                    "Endpoint": {
                        "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
                        "Port": 8111
                    },
                    "NodeCreateTime": 1576625059.509,
                    "AvailabilityZone": "us-west-2c",
                    "NodeStatus": "available",
                    "ParameterGroupStatus": "in-sync"
                }
            ],
            "PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
            "SubnetGroup": "default",
            "SecurityGroups": [
                {
                    "SecurityGroupIdentifier": "sg-1af6e36e",
                    "Status": "active"
                }
            ],
            "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
            "ParameterGroup": {
                "ParameterGroupName": "default.dax1.0",
                "ParameterApplyStatus": "in-sync",
                "NodeIdsToReboot": []
            },
            "SSEDescription": {
                "Status": "ENABLED"
            }
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

  • 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-parameters.

AWS CLI

Pour renvoyer les informations sur les paramètres système par défaut pour DAX

L’exemple describe-default-parameters suivant affiche les informations sur les paramètres système par défaut pour DAX.

aws dax describe-default-parameters

Sortie :

{
    "Parameters": [
        {
            "ParameterName": "query-ttl-millis",
            "ParameterType": "DEFAULT",
            "ParameterValue": "300000",
            "NodeTypeSpecificValues": [],
            "Description": "Duration in milliseconds for queries to remain cached",
            "Source": "user",
            "DataType": "integer",
            "AllowedValues": "0-",
            "IsModifiable": "TRUE",
            "ChangeType": "IMMEDIATE"
        },
        {
            "ParameterName": "record-ttl-millis",
            "ParameterType": "DEFAULT",
            "ParameterValue": "300000",
            "NodeTypeSpecificValues": [],
            "Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)",
            "Source": "user",
            "DataType": "integer",
            "AllowedValues": "0-",
            "IsModifiable": "TRUE",
            "ChangeType": "IMMEDIATE"
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

AWS CLI

Pour renvoyer tous les événements liés aux clusters DAX et aux groupes de paramètres

L’exemple describe-events suivant affiche les informations sur des événements liés aux clusters DAX et aux groupes de paramètres.

aws dax describe-events

Sortie :

{
    "Events": [
        {
            "SourceName": "daxcluster",
            "SourceType": "CLUSTER",
            "Message": "Cluster deleted.",
            "Date": 1576702736.706
        },
        {
            "SourceName": "daxcluster",
            "SourceType": "CLUSTER",
            "Message": "Removed node daxcluster-b.",
            "Date": 1576702691.738
        },
        {
            "SourceName": "daxcluster",
            "SourceType": "CLUSTER",
            "Message": "Removed node daxcluster-a.",
            "Date": 1576702633.498
        },
        {
            "SourceName": "daxcluster",
            "SourceType": "CLUSTER",
            "Message": "Removed node daxcluster-c.",
            "Date": 1576702631.329
        },
        {
            "SourceName": "daxcluster",
            "SourceType": "CLUSTER",
            "Message": "Cluster created.",
            "Date": 1576626560.057
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

  • 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-parameter-groups.

AWS CLI

Pour décrire les groupes de paramètres définis dans DAX

L’exemple describe-parameter-groups suivant récupère les informations sur les groupes de paramètres définis dans DAX.

aws dax describe-parameter-groups

Sortie :

{
    "ParameterGroups": [
        {
            "ParameterGroupName": "default.dax1.0",
            "Description": "Default parameter group for dax1.0"
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

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

AWS CLI

Pour décrire les paramètres définis dans un groupe de paramètres DAX

L’exemple describe-parameters suivant récupère les informations sur les paramètres définis dans le groupe de paramètres DAX spécifié.

aws dax describe-parameters \
    --parameter-group-name default.dax1.0

Sortie :

{
    "Parameters": [
        {
            "ParameterName": "query-ttl-millis",
            "ParameterType": "DEFAULT",
            "ParameterValue": "300000",
            "NodeTypeSpecificValues": [],
            "Description": "Duration in milliseconds for queries to remain cached",
            "Source": "user",
            "DataType": "integer",
            "AllowedValues": "0-",
            "IsModifiable": "TRUE",
            "ChangeType": "IMMEDIATE"
        },
        {
            "ParameterName": "record-ttl-millis",
            "ParameterType": "DEFAULT",
            "ParameterValue": "300000",
            "NodeTypeSpecificValues": [],
            "Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)",
            "Source": "user",
            "DataType": "integer",
            "AllowedValues": "0-",
            "IsModifiable": "TRUE",
            "ChangeType": "IMMEDIATE"
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

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

AWS CLI

Pour décrire les groupes de sous-réseaux définis dans DAX

L’exemple describe-subnet-groups suivant récupère les informations sur les groupes de sous-réseaux définis dans DAX.

aws dax describe-subnet-groups

Sortie :

{
    "SubnetGroups": [
        {
            "SubnetGroupName": "default",
            "Description": "Default CacheSubnetGroup",
            "VpcId": "vpc-ee70a196",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-874953af",
                    "SubnetAvailabilityZone": "us-west-2d"
                },
                {
                    "SubnetIdentifier": "subnet-bd3d1fc4",
                    "SubnetAvailabilityZone": "us-west-2a"
                },
                {
                    "SubnetIdentifier": "subnet-72c2ff28",
                    "SubnetAvailabilityZone": "us-west-2c"
                },
                {
                    "SubnetIdentifier": "subnet-09e6aa42",
                    "SubnetAvailabilityZone": "us-west-2b"
                }
            ]
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

L’exemple de code suivant montre comment utiliser increase-replication-factor.

AWS CLI

Pour augmenter le facteur de réplication d’un cluster DAX

L’exemple increase-replication-factor suivant augmente le facteur de réplication du cluster DAX spécifié pour qu’il corresponde à 3.

aws dax increase-replication-factor \
    --cluster-name daxcluster \
    --new-replication-factor 3

Sortie :

{
    "Cluster": {
        "ClusterName": "daxcluster",
        "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
        "TotalNodes": 3,
        "ActiveNodes": 1,
        "NodeType": "dax.r4.large",
        "Status": "modifying",
        "ClusterDiscoveryEndpoint": {
            "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
            "Port": 8111
        },
        "Nodes": [
            {
                "NodeId": "daxcluster-a",
                "Endpoint": {
                    "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
                    "Port": 8111
                },
                "NodeCreateTime": 1576625059.509,
                "AvailabilityZone": "us-west-2c",
                "NodeStatus": "available",
                "ParameterGroupStatus": "in-sync"
            },
            {
                "NodeId": "daxcluster-b",
                "NodeStatus": "creating"
            },
            {
                "NodeId": "daxcluster-c",
                "NodeStatus": "creating"
            }
        ],
        "PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
        "SubnetGroup": "default",
        "SecurityGroups": [
            {
                "SecurityGroupIdentifier": "sg-1af6e36e",
                "Status": "active"
            }
        ],
        "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
        "ParameterGroup": {
            "ParameterGroupName": "default.dax1.0",
            "ParameterApplyStatus": "in-sync",
            "NodeIdsToReboot": []
        },
        "SSEDescription": {
            "Status": "ENABLED"
        }
    }
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

AWS CLI

Pour répertorier les balises sur une ressource DAX

L’exemple list-tags suivant répertorie les clés de balise et les valeurs associées au cluster DAX spécifié.

aws dax list-tags \
    --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster

Sortie :

{
    "Tags": [
        {
            "Key": "ClusterUsage",
            "Value": "prod"
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

L’exemple de code suivant montre comment utiliser tag-resource.

AWS CLI

Pour baliser une ressource DAX

L’exemple tag-resource suivant attache le nom de clé de balise spécifié et la valeur associée au cluster DAX spécifié pour décrire l’utilisation du cluster.

aws dax tag-resource \
    --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \
    --tags="Key=ClusterUsage,Value=prod"

Sortie :

{
    "Tags": [
        {
            "Key": "ClusterUsage",
            "Value": "prod"
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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

L’exemple de code suivant montre comment utiliser untag-resource.

AWS CLI

Pour supprimer des balises d’une ressource DAX

L’exemple untag-resource suivant supprime d’un cluster DAX la balise portant le nom de clé spécifié.

aws dax untag-resource  \
    --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \
    --tag-keys="ClusterUsage"

Sortie :

{
    "Tags": []
}

Pour plus d’informations, consultez Gestion des clusters DAX dans le Manuel du développeur Amazon DynamoDB.

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