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

Exemples d’utilisation de l’AWS CLI avec MemoryDB

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

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 copy-snapshot.

AWS CLI

Pour copier un instantané

L’exemple copy-snapshot suivant illustre la création d’une copie d’un instantané.

aws memorydb copy-snapshot \
    --source-snapshot-name my-cluster-snapshot \
    --target-snapshot-name my-cluster-snapshot-copy

Sortie

{
    "Snapshot": {
        "Name": "my-cluster-snapshot-copy",
        "Status": "creating",
        "Source": "manual",
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:snapshot/my-cluster-snapshot-copy",
        "ClusterConfiguration": {
            "Name": "my-cluster",
            "Description": " ",
            "NodeType": "db.r6g.large",
            "EngineVersion": "6.2",
            "MaintenanceWindow": "wed:03:00-wed:04:00",
            "Port": 6379,
            "ParameterGroupName": "default.memorydb-redis6",
            "SubnetGroupName": "my-sg",
            "VpcId": "vpc-xx2574fc",
            "SnapshotRetentionLimit": 0,
            "SnapshotWindow": "04:30-05:30",
            "NumShards": 2
        }
    }
}

Pour plus d’informations, consultez Copie d’un instantané dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour créer une liste ACL

L’exemple create-acl suivant crée une nouvelle liste de contrôle d’accès.

aws memorydb create-acl \
    --acl-name "new-acl-1" \
    --user-names "my-user"

Sortie :

{
    "ACL": {
        "Name": "new-acl-1",
        "Status": "creating",
        "UserNames": [
            "my-user"
        ],
        "MinimumEngineVersion": "6.2",
        "Clusters": [],
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:acl/new-acl-1"
    }
}

Pour plus d’informations, consultez Authentification des utilisateurs avec des listes de contrôle d’accès dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour créer un cluster

L’exemple create-cluster suivant crée un nouveau cluster.

aws memorydb create-cluster \
    --cluster-name my-new-cluster \
    --node-type db.r6g.large \
    --acl-name my-acl \
    --subnet-group my-sg

Sortie :

{
    "Cluster": {
        "Name": "my-new-cluster",
        "Status": "creating",
        "NumberOfShards": 1,
        "AvailabilityMode": "MultiAZ",
        "ClusterEndpoint": {
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "default.memorydb-redis6",
        "ParameterGroupStatus": "in-sync",
        "SubnetGroupName": "my-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:cluster/my-new-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "sat:10:00-sat:11:00",
        "SnapshotWindow": "07:30-08:30",
        "ACLName": "my-acl",
        "AutoMinorVersionUpgrade": true
    }
}

Pour plus d’informations, consultez Gestion des clusters dans le Guide de l’utilisateur MemoryDB.

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

aws memorydb create-parameter-group \
    --parameter-group-name myRedis6x \
    --family memorydb_redis6 \
    --description "my-parameter-group"

Sortie :

{
    "ParameterGroup": {
        "Name": "myredis6x",
        "Family": "memorydb_redis6",
        "Description": "my-parameter-group",
        "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:parametergroup/myredis6x"
    }
}

Pour plus d’informations, consultez Création d’un groupe de paramètres dans le Guide de l’utilisateur MemoryDB.

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

AWS CLI

Pour créer un instantané

L’exemple create-snapshot suivant crée un instantané.

aws memorydb create-snapshot \
    --cluster-name my-cluster \
    --snapshot-name my-cluster-snapshot

Sortie :

{
    "Snapshot": {
        "Name": "my-cluster-snapshot1",
        "Status": "creating",
        "Source": "manual",
        "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:snapshot/my-cluster-snapshot",
        "ClusterConfiguration": {
            "Name": "my-cluster",
            "Description": "",
            "NodeType": "db.r6g.large",
            "EngineVersion": "6.2",
            "MaintenanceWindow": "wed:03:00-wed:04:00",
            "Port": 6379,
            "ParameterGroupName": "default.memorydb-redis6",
            "SubnetGroupName": "my-sg",
            "VpcId": "vpc-862xxxxc",
            "SnapshotRetentionLimit": 0,
            "SnapshotWindow": "04:30-05:30",
            "NumShards": 2
        }
    }
}

Pour plus d’informations, consultez Prise d’instantanés manuels dans le Guide de l’utilisateur de MemoryDB.

  • Pour plus de détails sur l’API, consultez CreateSnapshot 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

L’exemple create-subnet-group suivant crée un groupe de sous-réseau.

aws memorydb create-subnet-group \
    --subnet-group-name mysubnetgroup \
    --description "my subnet group" \
    --subnet-ids subnet-5623xxxx

Sortie :

{
    "SubnetGroup": {
        "Name": "mysubnetgroup",
        "Description": "my subnet group",
        "VpcId": "vpc-86257xxx",
        "Subnets": [
            {
                "Identifier": "subnet-5623xxxx",
                "AvailabilityZone": {
                    "Name": "us-east-1a"
                }
            }
        ],
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:subnetgroup/mysubnetgroup"
    }
}

Pour plus d’informations, consultez Création d’un groupe de sous-réseaux dans le Guide de l’utilisateur MemoryDB.

  • 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 create-user.

AWS CLI

Pour créer un utilisateur

L’exemple create-user suivant crée un utilisateur.

aws memorydb create-user \
    --user-name user-name-1 \
    --access-string "~objects:* ~items:* ~public:*" \
     --authentication-mode \
         Passwords="enterapasswordhere",Type=password

Sortie :

{
    "User": {
        "Name": "user-name-1",
        "Status": "active",
        "AccessString": "off ~objects:* ~items:* ~public:* resetchannels -@all",
        "ACLNames": [],
        "MinimumEngineVersion": "6.2",
        "Authentication": {
            "Type": "password",
            "PasswordCount": 1
        },
        "ARN": "arn:aws:memorydb:us-west-2:491658xxxxxx:user/user-name-1"
    }
}

Pour plus d’informations, consultez Authentification des utilisateurs avec des listes de contrôle d’accès dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour supprimer une liste ACL

L’exemple delete-acl suivant supprime une liste de contrôle d’accès.

aws memorydb delete-acl \
    --acl-name "new-acl-1"

Sortie :

{
    "ACL": {
        "Name": "new-acl-1",
        "Status": "deleting",
        "UserNames": [
            "pat"
        ],
        "MinimumEngineVersion": "6.2",
        "Clusters": [],
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:acl/new-acl-1"
    }
}

Pour plus d’informations, consultez Authentification des utilisateurs avec des listes de contrôle d’accès dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour supprimer un cluster

L’exemple delete-cluster suivant supprime un cluster.

aws memorydb delete-cluster \
    --cluster-name my-new-cluster

Sortie :

{
    "Cluster": {
        "Name": "my-new-cluster",
        "Status": "deleting",
        "NumberOfShards": 1,
        "ClusterEndpoint": {
            "Address": "clustercfg.my-new-cluster.xxxxx.memorydb.us-east-1.amazonaws.com",
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "default.memorydb-redis6",
        "ParameterGroupStatus": "in-sync",
        "SubnetGroupName": "my-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-new-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "sat:10:00-sat:11:00",
        "SnapshotWindow": "07:30-08:30",
        "AutoMinorVersionUpgrade": true
    }
}

Pour plus d’informations, consultez Suppression d’un cluster dans le Guide de l’utilisateur MemoryDB.

  • 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 un groupe de paramètres.

aws memorydb delete-parameter-group \
    --parameter-group-name myRedis6x

Sortie :

{
    "ParameterGroup": {
        "Name": "myredis6x",
        "Family": "memorydb_redis6",
        "Description": "my-parameter-group",
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:parametergroup/myredis6x"
    }
}

Pour plus d’informations, consultez Suppression d’un groupe de paramètres dans le Guide de l’utilisateur MemoryDB.

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

AWS CLI

Suppression d’un instantané

L’exemple delete-snapshot suivant supprime un instantané.

aws memorydb delete-snapshot \
    --snapshot-name my-cluster-snapshot

Sortie :

{
    "Snapshot": {
        "Name": "my-cluster-snapshot",
        "Status": "deleting",
        "Source": "manual",
        "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:snapshot/my-cluster-snapshot",
        "ClusterConfiguration": {
            "Name": "my-cluster",
            "Description": "",
            "NodeType": "db.r6g.large",
            "EngineVersion": "6.2",
            "MaintenanceWindow": "wed:03:00-wed:04:00",
            "Port": 6379,
            "ParameterGroupName": "default.memorydb-redis6",
            "SubnetGroupName": "my-sg",
            "VpcId": "vpc-862xxxxc",
            "SnapshotRetentionLimit": 0,
            "SnapshotWindow": "04:30-05:30",
            "NumShards": 2
        }
    }
}

Pour plus d’informations, consultez Suppression d’un instantané dans le Guide de l’utilisateur MemoryDB.

  • Pour plus de détails sur l’API, consultez DeleteSnapshot 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 un sous-réseau.

aws memorydb delete-subnet-group \
    --subnet-group-name mysubnetgroup

Sortie :

{
    "SubnetGroup": {
        "Name": "mysubnetgroup",
        "Description": "my subnet group",
        "VpcId": "vpc-86xxxx4fc",
        "Subnets": [
            {
                "Identifier": "subnet-56xxx61b",
                "AvailabilityZone": {
                    "Name": "us-east-1a"
                }
            }
        ],
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:subnetgroup/mysubnetgroup"
    }
}

Pour plus d’informations, consultez Suppression d’un groupe de sous-réseaux dans le Guide de l’utilisateur MemoryDB.

  • 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 delete-user.

AWS CLI

Pour supprimer un utilisateur

L’exemple delete-user suivant supprime un utilisateur.

aws memorydb delete-user \
    --user-name my-user

Sortie :

{
    "User": {
        "Name": "my-user",
        "Status": "deleting",
        "AccessString": "on ~app::* resetchannels -@all +@read",
        "ACLNames": [
            "my-acl"
        ],
        "MinimumEngineVersion": "6.2",
        "Authentication": {
            "Type": "password",
            "PasswordCount": 1
        },
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:user/my-user"
    }
}

Pour plus d’informations, consultez Authentification des utilisateurs avec des listes de contrôle d’accès dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour renvoyer une liste ACL

La commande describe-acls` suivante renvoie une liste ACL.

aws memorydb describe-acls

Sortie :

{
    "ACLs": [
        {
            "Name": "open-access",
            "Status": "active",
            "UserNames": [
                "default"
            ],
            "MinimumEngineVersion": "6.2",
            "Clusters": [],
            "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:acl/open-access"
        },
        {
            "Name": my-acl",
            "Status": "active",
            "UserNames": [],
            "MinimumEngineVersion": "6.2",
            "Clusters": [
                "my-cluster"
            ],
            "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxxx:acl/my-acl"
        }
    ]
}

Pour plus d’informations, consultez Authentification des utilisateurs avec des listes de contrôle d’accès dans le Guide de l’utilisateur MemoryDB.

  • Pour plus de détails sur l’API, consultez DescribeAcls 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 une liste de clusters

La commande describe-clusters` suivante renvoie une liste de clusters.

aws memorydb describe-clusters

Sortie :

{
    "Clusters": [
        {
                "Name": "my-cluster",
                "Status": "available",
                "NumberOfShards": 2,
                "ClusterEndpoint": {
                    "Address": "clustercfg.my-cluster.llru6f.memorydb.us-east-1.amazonaws.com",
                    "Port": 6379
                },
                "NodeType": "db.r6g.large",
                "EngineVersion": "6.2",
                "EnginePatchVersion": "6.2.6",
                "ParameterGroupName": "default.memorydb-redis6",
                "ParameterGroupStatus": "in-sync",
                "SecurityGroups": [
                    {
                        "SecurityGroupId": "sg-0a1434xxxxxc9fae",
                        "Status": "active"
                    }
                ],
                "SubnetGroupName": "pat-sg",
                "TLSEnabled": true,
                "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:cluster/my-cluster",
                "SnapshotRetentionLimit": 0,
                "MaintenanceWindow": "wed:03:00-wed:04:00",
                "SnapshotWindow": "04:30-05:30",
                "ACLName": "my-acl",
                "AutoMinorVersionUpgrade": true
        }
    ]
}

Pour plus d’informations, consultez Gestion des clusters dans le Guide de l’utilisateur MemoryDB.

  • 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-engine-versions.

AWS CLI

Pour renvoyer une liste des versions du moteur

La commande describe-engine-versions` suivante renvoie une liste des versions du moteur.

aws memorydb describe-engine-versions

Sortie :

{
    "EngineVersions": [
        {
            "EngineVersion": "6.2",
            "EnginePatchVersion": "6.2.6",
            "ParameterGroupFamily": "memorydb_redis6"
        }
    ]
}

Pour plus d’informations, consultez Versions du moteur et mise à niveau dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour renvoyer une liste d’événements

La commande describe-events` suivante renvoie une liste d’événements.

aws memorydb describe-events

Sortie :

{
    "Events": [
        {
            "SourceName": "my-cluster",
            "SourceType": "cluster",
            "Message": "Increase replica count started for replication group my-cluster on 2022-07-22T14:09:01.440Z",
            "Date": "2022-07-22T07:09:01.443000-07:00"
        },
        {
            "SourceName": "my-user",
            "SourceType": "user",
            "Message": "Create user my-user operation completed.",
            "Date": "2022-07-22T07:00:02.975000-07:00"
        }
    ]
}

Pour plus d’informations, consultez Surveillance des événements dans le Guide de l’utilisateur MemoryDB.

  • 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 renvoyer une liste de groupes de paramètres

La commande describe-parameter-groups` suivante renvoie une liste de groupes de paramètres.

aws memorydb describe-parameter-groups

Sortie :

{
    "ParameterGroups": [
        {
            "Name": "default.memorydb-redis6",
            "Family": "memorydb_redis6",
            "Description": "Default parameter group for memorydb_redis6",
            "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:parametergroup/default.memorydb-redis6"
        }
    ]
}

Pour plus d’informations, consultez Configuration des paramètres de moteur à l’aide de groupes de paramètres dans le Guide de l’utilisateur MemoryDB.

  • 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 renvoyer une liste de paramètres

La commande describe-parameters` suivante renvoie une liste de paramètres.

aws memorydb describe-parameters

Sortie :

{
    "Parameters": [
        {
            "Name": "acllog-max-len",
            "Value": "128",
            "Description": "The maximum length of the ACL Log",
            "DataType": "integer",
            "AllowedValues": "1-10000",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "activedefrag",
            "Value": "no",
            "Description": "Enabled active memory defragmentation",
            "DataType": "string",
            "AllowedValues": "yes,no",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "active-defrag-cycle-max",
            "Value": "75",
            "Description": "Maximal effort for defrag in CPU percentage",
            "DataType": "integer",
            "AllowedValues": "1-75",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "active-defrag-cycle-min",
            "Value": "5",
            "Description": "Minimal effort for defrag in CPU percentage",
            "DataType": "integer",
            "AllowedValues": "1-75",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "active-defrag-ignore-bytes",
            "Value": "104857600",
            "Description": "Minimum amount of fragmentation waste to start active defrag",
            "DataType": "integer",
            "AllowedValues": "1048576-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "active-defrag-max-scan-fields",
            "Value": "1000",
            "Description": "Maximum number of set/hash/zset/list fields that will be processed from the main dictionary scan",
            "DataType": "integer",
            "AllowedValues": "1-1000000",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "active-defrag-threshold-lower",
            "Value": "10",
            "Description": "Minimum percentage of fragmentation to start active defrag",
            "DataType": "integer",
            "AllowedValues": "1-100",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "active-defrag-threshold-upper",
            "Value": "100",
            "Description": "Maximum percentage of fragmentation at which we use maximum effort",
            "DataType": "integer",
            "AllowedValues": "1-100",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "active-expire-effort",
            "Value": "1",
            "Description": "The amount of effort that redis uses to expire items in the active expiration job",
            "DataType": "integer",
            "AllowedValues": "1-10",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "activerehashing",
            "Value": "yes",
            "Description": "Apply rehashing or not",
            "DataType": "string",
            "AllowedValues": "yes,no",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "client-output-buffer-limit-normal-hard-limit",
            "Value": "0",
            "Description": "Normal client output buffer hard limit in bytes",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "client-output-buffer-limit-normal-soft-limit",
            "Value": "0",
            "Description": "Normal client output buffer soft limit in bytes",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "client-output-buffer-limit-normal-soft-seconds",
            "Value": "0",
            "Description": "Normal client output buffer soft limit in seconds",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "client-output-buffer-limit-pubsub-hard-limit",
            "Value": "33554432",
            "Description": "Pubsub client output buffer hard limit in bytes",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "client-output-buffer-limit-pubsub-soft-limit",
            "Value": "8388608",
            "Description": "Pubsub client output buffer soft limit in bytes",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "client-output-buffer-limit-pubsub-soft-seconds",
            "Value": "60",
            "Description": "Pubsub client output buffer soft limit in seconds",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "hash-max-ziplist-entries",
            "Value": "512",
            "Description": "The maximum number of hash entries in order for the dataset to be compressed",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "hash-max-ziplist-value",
            "Value": "64",
            "Description": "The threshold of biggest hash entries in order for the dataset to be compressed",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "hll-sparse-max-bytes",
            "Value": "3000",
            "Description": "HyperLogLog sparse representation bytes limit",
            "DataType": "integer",
            "AllowedValues": "1-16000",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "lazyfree-lazy-eviction",
            "Value": "no",
            "Description": "Perform an asynchronous delete on evictions",
            "DataType": "string",
            "AllowedValues": "yes,no",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "lazyfree-lazy-expire",
            "Value": "no",
            "Description": "Perform an asynchronous delete on expired keys",
            "DataType": "string",
            "AllowedValues": "yes,no",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "lazyfree-lazy-server-del",
            "Value": "no",
            "Description": "Perform an asynchronous delete on key updates",
            "DataType": "string",
            "AllowedValues": "yes,no",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "lazyfree-lazy-user-del",
            "Value": "no",
            "Description": "Specifies whether the default behavior of DEL command acts the same as UNLINK",
            "DataType": "string",
            "AllowedValues": "yes,no",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "lfu-decay-time",
            "Value": "1",
            "Description": "The amount of time in minutes to decrement the key counter for LFU eviction policyd",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "lfu-log-factor",
            "Value": "10",
            "Description": "The log factor for incrementing key counter for LFU eviction policy",
            "DataType": "integer",
            "AllowedValues": "1-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "list-compress-depth",
            "Value": "0",
            "Description": "Number of quicklist ziplist nodes from each side of the list to exclude from compression. The head and tail of the list are always uncompressed for fast push/pop operations",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "maxmemory-policy",
            "Value": "noeviction",
            "Description": "Max memory policy",
            "DataType": "string",
            "AllowedValues": "volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "maxmemory-samples",
            "Value": "3",
            "Description": "Max memory samples",
            "DataType": "integer",
            "AllowedValues": "1-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "notify-keyspace-events",
            "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled",
            "DataType": "string",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "set-max-intset-entries",
            "Value": "512",
            "Description": "The limit in the size of the set in order for the dataset to be compressed",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "slowlog-log-slower-than",
            "Value": "10000",
            "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command",
            "DataType": "integer",
            "AllowedValues": "-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "slowlog-max-len",
            "Value": "128",
            "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "stream-node-max-bytes",
            "Value": "4096",
            "Description": "The maximum size of a single node in a stream in bytes",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "stream-node-max-entries",
            "Value": "100",
            "Description": "The maximum number of items a single node in a stream can contain",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "tcp-keepalive",
            "Value": "300",
            "Description": "If non-zero, send ACKs every given number of seconds",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "timeout",
            "Value": "0",
            "Description": "Close connection if client is idle for a given number of seconds, or never if 0",
            "DataType": "integer",
            "AllowedValues": "0,20-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "tracking-table-max-keys",
            "Value": "1000000",
            "Description": "The maximum number of keys allowed for the tracking table for client side caching",
            "DataType": "integer",
            "AllowedValues": "1-100000000",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "zset-max-ziplist-entries",
            "Value": "128",
            "Description": "The maximum number of sorted set entries in order for the dataset to be compressed",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        },
        {
            "Name": "zset-max-ziplist-value",
            "Value": "64",
            "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed",
            "DataType": "integer",
            "AllowedValues": "0-",
            "MinimumEngineVersion": "6.2.4"
        }
    ]
}

Pour plus d’informations, consultez Configuration des paramètres de moteur à l’aide de groupes de paramètres dans le Guide de l’utilisateur MemoryDB.

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

AWS CLI

Pour renvoyer une liste d’instantanés

La commande describe-snapshots` suivante renvoie une liste d’instantanés.

aws memorydb describe-snapshots

Sortie :

{
"Snapshots": [
    {
        "Name": "my-cluster-snapshot",
        "Status": "available",
        "Source": "manual",
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx2:snapshot/my-cluster-snapshot",
        "ClusterConfiguration": {
            "Name": "my-cluster",
            "Description": " ",
            "NodeType": "db.r6g.large",
            "EngineVersion": "6.2",
            "MaintenanceWindow": "wed:03:00-wed:04:00",
            "Port": 6379,
            "ParameterGroupName": "default.memorydb-redis6",
            "SubnetGroupName": "my-sg",
            "VpcId": "vpc-862574fc",
            "SnapshotRetentionLimit": 0,
            "SnapshotWindow": "04:30-05:30",
            "NumShards": 2
        }
    }
}

Pour plus d’informations, consultez Instantané et restauration dans le Guide de l’utilisateur MemoryDB.

  • Pour plus de détails sur l’API, consultez DescribeSnapshots 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 renvoyer une liste de groupes de sous-réseaux

La commande describe-subnet-groups` suivante renvoie une liste de groupes de sous-réseaux.

aws memorydb describe-subnet-groups

Sortie

{
    "SubnetGroups": [
        {
            "Name": "my-sg",
            "Description": "pat-sg",
            "VpcId": "vpc-86xxx4fc",
            "Subnets": [
                {
                    "Identifier": "subnet-faxx84a6",
                    "AvailabilityZone": {
                        "Name": "us-east-1b"
                    }
                },
                {
                    "Identifier": "subnet-56xxf61b",
                    "AvailabilityZone": {
                        "Name": "us-east-1a"
                    }
                }
            ],
            "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:subnetgroup/my-sg"
        }
    ]
}

Pour plus d’informations, consultez Sous-réseaux et groupes de sous-réseaux dans le Guide de l’utilisateur MemoryDB.

  • 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 describe-users.

AWS CLI

Pour renvoyer une liste d’utilisateurs

La commande describe-users` suivante renvoie une liste d’utilisateurs

aws memorydb describe-users

Sortie

{
    "Users": [
        {
            "Name": "default",
            "Status": "active",
            "AccessString": "on ~* &* +@all",
            "ACLNames": [
                "open-access"
            ],
            "MinimumEngineVersion": "6.0",
            "Authentication": {
                "Type": "no-password"
            },
            "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:user/default"
        },
        {
            "Name": "my-user",
            "Status": "active",
            "AccessString": "off ~objects:* ~items:* ~public:* resetchannels -@all",
            "ACLNames": [],
            "MinimumEngineVersion": "6.2",
            "Authentication": {
                "Type": "password",
                "PasswordCount": 2
            },
            "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:user/my-user"
        }
    ]
}

Pour plus d’informations, consultez Authentification des utilisateurs avec des listes de contrôle d’accès dans le Guide de l’utilisateur MemoryDB.

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

L’exemple de code suivant montre comment utiliser failover-shard.

AWS CLI

Pour basculer sur une partition

La commande failover-shard` suivante bascule sur une partition.

aws memorydb failover-shard \
    --cluster-name my-cluster --shard-name 0001

Sortie :

{
    "Cluster": {
        "Name": "my-cluster",
        "Status": "available",
        "NumberOfShards": 2,
        "ClusterEndpoint": {
            "Address": "clustercfg.my-cluster.xxxxxx.memorydb.us-east-1.amazonaws.com",
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "default.memorydb-redis6",
        "ParameterGroupStatus": "in-sync",
        "SecurityGroups": [
            {
                "SecurityGroupId": "sg-0a143xxxx45c9fae",
                "Status": "active"
            }
        ],
        "SubnetGroupName": "my-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "wed:03:00-wed:04:00",
        "SnapshotWindow": "04:30-05:30",
        "AutoMinorVersionUpgrade": true
    }
}

Pour plus d’informations, consultez Réduction des temps d’arrêt avec Multi-AZ dans le Guide de l’utilisateur MemoryDB.

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

L’exemple de code suivant montre comment utiliser list-allowed-node-type-updates.

AWS CLI

Pour renvoyer une liste des mises à jour des types de nœuds autorisées

La commande list-allowed-node-type-updates suivante renvoie une liste des mises à jour des types de nœuds disponibles.

aws memorydb list-allowed-node-type-updates

Sortie :

{
    "Cluster": {
        "Name": "my-cluster",
        "Status": "available",
        "NumberOfShards": 2,
        "ClusterEndpoint": {
            "Address": "clustercfg.my-cluster.xxxxxx.memorydb.us-east-1.amazonaws.com",
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "default.memorydb-redis6",
        "ParameterGroupStatus": "in-sync",
        "SecurityGroups": [
            {
                "SecurityGroupId": "sg-0a143xxxx45c9fae",
                "Status": "active"
            }
        ],
        "SubnetGroupName": "my-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "wed:03:00-wed:04:00",
        "SnapshotWindow": "04:30-05:30",
        "AutoMinorVersionUpgrade": true
    }
}

Pour plus d’informations, consultez Mise à l’échelle dans le Guide de l’utilisateur MemoryDB.

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

AWS CLI

Pour renvoyer une liste de balises

La commande list-tags suivante renvoie une liste de balises.

aws memorydb list-tags \
    --resource-arn arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster

Sortie :

{
    "TagList": [
        {
            "Key": "mytag",
            "Value": "myvalue"
        }
    ]
}

Pour plus d’informations, consultez Balisage des ressources dans le Guide de l’utilisateur MemoryDB.

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

AWS CLI

Pour réinitialiser un groupe de paramètres

La commande reset-parameter-group` suivante réinitialise un groupe de paramètres.

aws memorydb reset-parameter-group \
    --parameter-group-name my-parameter-group \
    --all-parameters

Sortie :

{
    "ParameterGroup": {
        "Name": "my-parameter-group",
        "Family": "memorydb_redis6",
        "Description": "my parameter group",
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:parametergroup/my-parameter-group"
    }
}

Pour plus d’informations, consultez Configuration des paramètres de moteur à l’aide de groupes de paramètres dans le Guide de l’utilisateur MemoryDB.

  • Pour plus de détails sur l’API, consultez ResetParameterGroup 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

La commande tag-resource` suivante ajoute une balise à une ressource.

aws memorydb tag-resource \
    --resource-arn arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster \
    --tags Key="mykey",Value="myvalue"

Sortie :

{
    "TagList": [
        {
            "Key": "mytag",
            "Value": "myvalue"
        },
        {
            "Key": "mykey",
            "Value": "myvalue"
        }
    ]
}

Pour plus d’informations, consultez Balisage des ressources dans le Guide de l’utilisateur MemoryDB.

  • 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 mettre à jour une liste ACL

La commande update-acl` suivante met à jour une liste ACL en ajoutant un utilisateur.

aws memorydb untag-resource \
    --resource-arn arn:aws:memorydb:us-east-1:491658xxxxx:cluster/my-cluster \
    --tag-keys mykey

Sortie :

{
    "TagList": [
        {
            "Key": "mytag",
            "Value": "myvalue"
        }
    ]
}

Pour plus d’informations, consultez Balisage des ressources dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour mettre à jour un cluster

La commande update-cluster`` suivante met à jour le groupe de paramètres d’un cluster vers my-parameter-group.

aws memorydb update-cluster \
    --cluster-name my-cluster \
    --parameter-group-name my-parameter-group

Sortie :

{
    "Cluster": {
        "Name": "my-cluster",
        "Status": "available",
        "NumberOfShards": 2,
        "AvailabilityMode": "MultiAZ",
        "ClusterEndpoint": {
            "Address": "clustercfg.my-cluster.llru6f.memorydb.us-east-1.amazonaws.com",
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "my-parameter-group",
        "ParameterGroupStatus": "in-sync",
        "SecurityGroups": [
            {
                "SecurityGroupId": "sg-0a143xxxxxc9fae",
                "Status": "active"
            }
        ],
        "SubnetGroupName": "pat-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "wed:03:00-wed:04:00",
        "SnapshotWindow": "04:30-05:30",
        "ACLName": "my-acl",
        "AutoMinorVersionUpgrade": true
    }
}

Pour plus d’informations, consultez Modification d’un cluster dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour créer un groupe de paramètres

La commande update-parameter-group`` suivante met à jour un groupe de paramètres.

aws memorydb update-parameter-group \
    --parameter-group-name my-parameter-group \
    --parameter-name-values "ParameterName=activedefrag, ParameterValue=no"

Sortie :

{
    "ParameterGroup": {
        "Name": "my-parameter-group",
        "Family": "memorydb_redis6",
        "Description": "my parameter group",
        "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:parametergroup/my-parameter-group"
    }
}

Pour plus d’informations, consultez Modification d’un groupe de paramètres dans le Guide de l’utilisateur MemoryDB.

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

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

AWS CLI

Pour mettre à jour un groupe de sous-réseaux

La commande update-subnet-group` suivante met à jour l’ID de sous-réseau d’un groupe de sous-réseaux.

aws memorydb update-subnet-group \
    --subnet-group-name my-sg \
    --subnet-ids subnet-01f29d458f3xxxxx

Sortie :

{
    "SubnetGroup": {
        "Name": "my-sg-1",
        "Description": "my-sg",
        "VpcId": "vpc-09d2cfc01xxxxxxx",
        "Subnets": [
            {
                "Identifier": "subnet-01f29d458fxxxxxx",
                "AvailabilityZone": {
                    "Name": "us-east-1a"
                }
            }
        ],
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:subnetgroup/my-sg"
    }
}

Pour plus d’informations, consultez Sous-réseaux et groupes de sous-réseaux dans le Guide de l’utilisateur MemoryDB.

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

L’exemple de code suivant montre comment utiliser update-user.

AWS CLI

Pour mettre à jour un utilisateur

L’exemple update-user suivant modifie la chaîne d’accès d’un utilisateur.

aws memorydb update-user \
    --user-name my-user \
    --access-string "off ~objects:* ~items:* ~public:* resetchannels -@all"

Sortie :

{
    "User": {
        "Name": "my-user",
        "Status": "modifying",
        "AccessString": "off ~objects:* ~items:* ~public:* resetchannels -@all",
        "ACLNames": [
            "myt-acl"
        ],
        "MinimumEngineVersion": "6.2",
        "Authentication": {
            "Type": "password",
            "PasswordCount": 2
        },
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:user/my-user"
    }
}

Pour plus d’informations, consultez Authentification des utilisateurs avec des listes de contrôle d’accès dans le Guide de l’utilisateur MemoryDB.

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