DAX 範例使用 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DAX 範例使用 AWS CLI

下列程式碼範例說明如何使用 DAX 來執行動作和實作常見案例。 AWS Command Line Interface

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用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 叢集

下列程式碼範例會示範如何使用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:建立子網路群組

下列程式碼範例會示範如何使用decrease-replication-factor

AWS CLI

若要從叢集中移除一或多個節點

下列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 叢集

下列程式碼範例會示範如何使用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 叢集

下列程式碼範例會示範如何使用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 叢集

下列程式碼範例會示範如何使用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 叢集

下列程式碼範例會示範如何使用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 叢集

下列程式碼範例會示範如何使用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 叢集

下列程式碼範例會示範如何使用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 叢集

下列程式碼範例會示範如何使用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 叢集

下列程式碼範例會示範如何使用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中的。