DAXexemplos usando AWS CLI - AWS Command Line Interface
Ações

Esta documentação é para a AWS CLI única versão 1. Para obter a documentação relacionada à versão 2 do AWS CLI, consulte o Guia do usuário da versão 2.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DAXexemplos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface withDAX.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-cluster.

AWS CLI

Para criar um DAX cluster

O create-cluster exemplo a seguir cria um DAX cluster com as configurações especificadas.

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

Saída:

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

Para obter mais informações, consulte Etapa 3: Criar um DAX cluster no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte CreateClusterna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-parameter-group.

AWS CLI

Para criar um grupo de parâmetros

O exemplo `` create-parameter-group`` a seguir cria um grupo de parâmetros com as configurações especificadas.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

O código de exemplo a seguir mostra como usar create-subnet-group.

AWS CLI

Para criar um grupo de DAX sub-redes

O create-subnet-group exemplo a seguir cria um grupo de sub-redes com as configurações especificadas.

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

Saída:

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

Para obter mais informações, consulte Etapa 2: Criar um grupo de sub-rede no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte CreateSubnetGroupna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar decrease-replication-factor.

AWS CLI

Para remover um ou mais nós do cluster

O decrease-replication-factor exemplo a seguir diminui o número de nós no DAX cluster especificado para um.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

O código de exemplo a seguir mostra como usar delete-cluster.

AWS CLI

Para excluir um DAX cluster

O delete-cluster exemplo a seguir exclui o DAX cluster especificado.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte DeleteClusterna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-parameter-group.

AWS CLI

Para excluir um grupo de parâmetros

O delete-parameter-group exemplo a seguir exclui o grupo de DAX parâmetros especificado.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

O código de exemplo a seguir mostra como usar delete-subnet-group.

AWS CLI

Para excluir um grupo de sub-redes

O delete-subnet-group exemplo a seguir exclui o grupo de DAX sub-rede especificado.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte DeleteSubnetGroupna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-clusters.

AWS CLI

Para retornar informações sobre todos os clusters provisionados DAX

O describe-clusters exemplo a seguir exibe detalhes sobre todos os clusters provisionados. DAX

aws dax describe-clusters

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte DescribeClustersna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-default-parameters.

AWS CLI

Para retornar as informações padrão dos parâmetros do sistema para DAX

O describe-default-parameters exemplo a seguir exibe as informações padrão dos parâmetros do sistema paraDAX.

aws dax describe-default-parameters

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

O código de exemplo a seguir mostra como usar describe-events.

AWS CLI

Para retornar todos os eventos relacionados a DAX clusters e grupos de parâmetros

O describe-events exemplo a seguir exibe detalhes de eventos relacionados a DAX clusters e grupos de parâmetros.

aws dax describe-events

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte DescribeEventsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-parameter-groups.

AWS CLI

Para descrever os grupos de parâmetros definidos em DAX

O describe-parameter-groups exemplo a seguir recupera detalhes sobre os grupos de parâmetros definidos emDAX.

aws dax describe-parameter-groups

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

O código de exemplo a seguir mostra como usar describe-parameters.

AWS CLI

Para descrever os parâmetros definidos em um grupo de DAX parâmetros

O describe-parameters exemplo a seguir recupera detalhes sobre os parâmetros definidos no grupo de DAX parâmetros especificado.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

O código de exemplo a seguir mostra como usar describe-subnet-groups.

AWS CLI

Para descrever grupos de sub-redes definidos em DAX

O describe-subnet-groups exemplo a seguir recupera detalhes dos grupos de sub-redes definidos em. DAX

aws dax describe-subnet-groups

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

O código de exemplo a seguir mostra como usar increase-replication-factor.

AWS CLI

Para aumentar o fator de replicação de um cluster DAX

O increase-replication-factor exemplo a seguir aumenta o fator de replicação do DAX cluster especificado para 3.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

O código de exemplo a seguir mostra como usar list-tags.

AWS CLI

Para listar tags em um DAX recurso

O list-tags exemplo a seguir lista as chaves e os valores de tag anexados ao DAX cluster especificado.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte ListTagsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para marcar um DAX recurso

O tag-resource exemplo a seguir anexa o nome da chave da tag especificada e o valor associado ao DAX cluster especificado para descrever o uso do cluster.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover tags de um DAX recurso

O untag-resource exemplo a seguir remove a tag com o nome de chave especificado de um DAX cluster.

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

Saída:

{
    "Tags": []
}

Para obter mais informações, consulte Gerenciamento de DAX clusters no Amazon DynamoDB Developer Guide.

  • Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.