Beispiele für die Verwendung der AWS CLI mit DAX - AWS Command Line Interface
Aktionen

Beispiele für die Verwendung der AWS CLI mit DAX

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit DAX nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie create-cluster verwendet wird.

AWS CLI

So erstellen Sie einen DAX-Cluster

Im folgenden create-cluster-Beispiel wird ein DAX-Cluster mit den angegebenen Einstellungen erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Schritt 3: Erstellen eines DAX-Clusters im Amazon-DynamoDB-Entwicklerhandbuch.

  • API-Details finden Sie unter CreateCluster in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-parameter-group verwendet wird.

AWS CLI

So erstellen Sie eine Parametergruppe

Das folgende Beispiel für ``create-parameter-group`` erstellt eine Parametergruppe mit den angegebenen Einstellungen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie create-subnet-group verwendet wird.

AWS CLI

So erstellen Sie eine DAX-Subnetzgruppe

Im folgenden create-subnet-group-Beispiel wird eine Subnetzgruppe mit den angegebenen Einstellungen erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Schritt 2: Erstellen einer Subnetzgruppe im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie decrease-replication-factor verwendet wird.

AWS CLI

So entfernen Sie einen oder mehrere Knoten aus dem Cluster

Im folgenden decrease-replication-factor-Beispiel wird die Anzahl der Knoten im angegebenen DAX-Cluster auf 1 reduziert.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie delete-cluster verwendet wird.

AWS CLI

So löschen Sie einen DAX-Cluster

Im folgenden delete-cluster-Beispiel wird der angegebene DAX-Cluster gelöscht.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

  • API-Details finden Sie unter DeleteCluster in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-parameter-group verwendet wird.

AWS CLI

So löschen Sie eine Parametergruppe

Im folgenden delete-parameter-group-Beispiel wird die angegebene DAX-Parametergruppe gelöscht.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie delete-subnet-group verwendet wird.

AWS CLI

So löschen Sie eine Subnetzgruppe

Im folgenden delete-subnet-group-Beispiel wird die angegebene DAX-Subnetzgruppe gelöscht.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-clusters verwendet wird.

AWS CLI

So geben Sie Informationen über alle bereitgestellten DAX-Cluster zurück

Im folgenden describe-clusters-Beispiel werden Details zu allen bereitgestellten DAX-Clustern angezeigt.

aws dax describe-clusters

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-default-parameters verwendet wird.

AWS CLI

So geben Sie die Standard-Systemparameterinformationen für DAX zurück

Im folgenden describe-default-parameters-Beispiel werden die Standardsystemparameter für DAX angezeigt.

aws dax describe-default-parameters

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-events verwendet wird.

AWS CLI

So geben Sie alle Ereignisse im Zusammenhang mit DAX-Clustern und Parametergruppen zurück

Im folgenden describe-events-Beispiel werden Details zu Ereignissen angezeigt, die sich auf DAX-Cluster und Parametergruppen beziehen.

aws dax describe-events

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

  • API-Details finden Sie unter DescribeEvents in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-parameter-groups verwendet wird.

AWS CLI

So beschreiben Sie die in DAX definierten Parametergruppen

Im folgenden describe-parameter-groups-Beispiel werden Details zu den Parametergruppen abgerufen, die in DAX definiert sind.

aws dax describe-parameter-groups

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-parameters verwendet wird.

AWS CLI

So beschreiben Sie die Parameter, die in einer DAX-Parametergruppe definiert sind

Im folgenden describe-parameters-Beispiel werden Details zu den Parametern abgerufen, die in der angegebenen DAX-Parametergruppe definiert sind.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie describe-subnet-groups verwendet wird.

AWS CLI

So beschreiben Sie in DAX definierte Subnetzgruppen

Im folgenden describe-subnet-groups-Beispiel werden Details zu den Subnetzgruppen abgerufen, die in DAX definiert sind.

aws dax describe-subnet-groups

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie increase-replication-factor verwendet wird.

AWS CLI

So erhöhen Sie den Replikationsfaktor für einen DAX-Cluster

Im folgenden increase-replication-factor-Beispiel wird der Replikationsfaktor des angegebenen DAX-Clusters auf 3 erhöht.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

Das folgende Codebeispiel zeigt, wie list-tags verwendet wird.

AWS CLI

So listen Sie Tags auf einer DAX-Ressource auf

Das folgende list-tags-Beispiel listet die Tag-Schlüssel und Werte auf, die an den angegebenen DAX-Cluster angehängt sind.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

  • API-Details finden Sie unter ListTags in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So taggen Sie eine DAX-Ressource

Im folgenden tag-resource-Beispiel werden der angegebene Tag-Schlüsselname und der zugehörige Wert an den angegebenen DAX-Cluster angehängt, um die Clusterauslastung zu beschreiben.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

  • API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

So entfernen Sie Tags von einer DAX-Ressource

Im folgenden untag-resource-Beispiel wird das Tag mit dem angegebenen Schlüsselnamen von einem DAX-Cluster entfernt.

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

Ausgabe:

{
    "Tags": []
}

Weitere Informationen finden Sie unter Verwalten von DAX-Clustern im Amazon-DynamoDB-Entwicklerhandbuch.

  • API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.