DAX を使用した例 AWS CLI - AWS Command Line Interface
アクション

このドキュメントは、 のバージョン 1 AWS CLI 専用です。のバージョン 2 に関連するドキュメントについては AWS CLI、バージョン 2 ユーザーガイド を参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DAX を使用した例 AWS CLI

次のコード例は、 AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示していますDAX。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

トピック

アクション

次のコード例は、create-cluster を使用する方法を示しています。

AWS CLI

DAXクラスターを作成するには

次のcreate-cluster例では、指定された設定でDAXクラスターを作成します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」の「ステップ 3: DAX クラスターを作成する」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateCluster」の「」を参照してください。

次の例は、create-parameter-group を使用する方法を説明しています。

AWS CLI

パラメータグループを作成するには

次の create-parameter-group「」例では、指定された設定でパラメータグループを作成します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateParameterGroup」の「」を参照してください。

次のコード例は、create-subnet-group を使用する方法を示しています。

AWS CLI

DAXサブネットグループを作成するには

次のcreate-subnet-group例では、指定された設定でサブネットグループを作成します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」の「ステップ 2: サブネットグループを作成する」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateSubnetGroup」の「」を参照してください。

次の例は、decrease-replication-factor を使用する方法を説明しています。

AWS CLI

クラスターから 1 つ以上のノードを削除するには

次のdecrease-replication-factor例では、指定されたDAXクラスター内のノードの数を 1 つに減らします。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDecreaseReplicationFactor」の「」を参照してください。

次の例は、delete-cluster を使用する方法を説明しています。

AWS CLI

DAXクラスターを削除するには

次のdelete-cluster例では、指定されたDAXクラスターを削除します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteCluster」の「」を参照してください。

次のコード例は、delete-parameter-group を使用する方法を示しています。

AWS CLI

パラメータグループを削除するには

次のdelete-parameter-group例では、指定されたDAXパラメータグループを削除します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteParameterGroup」の「」を参照してください。

次の例は、delete-subnet-group を使用する方法を説明しています。

AWS CLI

サブネットグループを削除するには

次のdelete-subnet-group例では、指定されたDAXサブネットグループを削除します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteSubnetGroup」の「」を参照してください。

次の例は、describe-clusters を使用する方法を説明しています。

AWS CLI

プロビジョニングされたすべてのDAXクラスターに関する情報を返すには

次のdescribe-clusters例では、プロビジョニングされたすべてのDAXクラスターの詳細を表示します。

aws dax describe-clusters

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeClusters」の「」を参照してください。

次のコード例は、describe-default-parameters を使用する方法を示しています。

AWS CLI

のデフォルトのシステムパラメータ情報を返すには DAX

次のdescribe-default-parameters例では、 のデフォルトのシステムパラメータ情報を表示しますDAX。

aws dax describe-default-parameters

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeDefaultParameters」の「」を参照してください。

次のコード例は、describe-events を使用する方法を示しています。

AWS CLI

DAXクラスターとパラメータグループに関連するすべてのイベントを返すには

次のdescribe-events例では、DAXクラスターとパラメータグループに関連するイベントの詳細を表示します。

aws dax describe-events

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEvents」の「」を参照してください。

次のコード例は、describe-parameter-groups を使用する方法を示しています。

AWS CLI

で定義されているパラメータグループを記述するには DAX

次のdescribe-parameter-groups例では、 で定義されているパラメータグループの詳細を取得しますDAX。

aws dax describe-parameter-groups

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeParameterGroups」の「」を参照してください。

次のコード例は、describe-parameters を使用する方法を示しています。

AWS CLI

パラメータグループで定義されたDAXパラメータを記述するには

次のdescribe-parameters例では、指定されたパラメータグループで定義されているDAXパラメータの詳細を取得します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeParameters」の「」を参照してください。

次の例は、describe-subnet-groups を使用する方法を説明しています。

AWS CLI

で定義されるサブネットグループを記述するには DAX

次のdescribe-subnet-groups例では、 で定義されているサブネットグループの詳細を取得しますDAX。

aws dax describe-subnet-groups

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeSubnetGroups」の「」を参照してください。

次のコード例は、increase-replication-factor を使用する方法を示しています。

AWS CLI

DAXクラスターのレプリケーション係数を増やすには

次のincrease-replication-factor例では、指定されたDAXクラスターのレプリケーション係数を 3 に引き上げます。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスIncreaseReplicationFactor」の「」を参照してください。

次の例は、list-tags を使用する方法を説明しています。

AWS CLI

DAXリソースのタグを一覧表示するには

次のlist-tags例では、指定されたDAXクラスターにアタッチされたタグキーと値を一覧表示します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListTags」の「」を参照してください。

次のコード例は、tag-resource を使用する方法を示しています。

AWS CLI

DAXリソースにタグを付けるには

次のtag-resource例では、指定されたタグキー名と関連値を指定されたDAXクラスターにアタッチして、クラスターの使用状況を記述します。

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

出力:

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

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスTagResource」の「」を参照してください。

次のコード例は、untag-resource を使用する方法を示しています。

AWS CLI

DAXリソースからタグを削除するには

次のuntag-resource例では、指定されたキー名のタグをDAXクラスターから削除します。

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

出力:

{
    "Tags": []
}

詳細については、「Amazon DynamoDB デベロッパーガイド」のDAX「クラスターの管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスUntagResource」の「」を参照してください。