Esta documentación es para la versión 1 de AWS CLI. Para obtener documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.
En los siguientes ejemplos de código, se muestra cómo realizar acciones e implementar escenarios comunes usando la con AWS Command Line Interface.
Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
Temas
Acciones
En el siguiente ejemplo de código, se muestra cómo utilizar create-cluster.
- AWS CLI
-
Creación de un clúster de DAX
En el siguiente ejemplo de
create-cluster, se crea un clúster de DAX con la configuración especificada.aws dax create-cluster \ --cluster-namedaxcluster\ --node-typedax.r4.large\ --replication-factor3\ --iam-role-arnroleARN\ --sse-specificationEnabled=trueSalida:
{ "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 obtener más información, consulte Paso 3: crear un clúster de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener información sobre la API, consulte CreateCluster
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-parameter-group.
- AWS CLI
-
Para crear un grupo de parámetros
En el siguiente ejemplo de create-parameter-group, se crea un grupo de parámetros con la configuración especificada.
aws dax create-parameter-group \ --parameter-group-namedaxparametergroup\ --description"A new parameter group"Salida:
{ "ParameterGroup": { "ParameterGroupName": "daxparametergroup", "Description": "A new parameter group" } }Para obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte CreateParameterGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-subnet-group.
- AWS CLI
-
Creación de un grupo de subredes de DAX
En el siguiente ejemplo de
create-subnet-group, se crea un grupo de subredes con la configuración especificada.aws dax create-subnet-group \ --subnet-group-namedaxSubnetGroup\ --subnet-idssubnet-11111111subnet-22222222Salida:
{ "SubnetGroup": { "SubnetGroupName": "daxSubnetGroup", "VpcId": "vpc-05a1fa8e00c325226", "Subnets": [ { "SubnetIdentifier": "subnet-11111111", "SubnetAvailabilityZone": "us-west-2b" }, { "SubnetIdentifier": "subnet-22222222", "SubnetAvailabilityZone": "us-west-2c" } ] } }Para obtener más información, consulte Paso 2: crear un grupo de subredes en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte CreateSubnetGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar decrease-replication-factor.
- AWS CLI
-
Eliminación de uno o varios nodos del clúster
En el siguiente ejemplo de
decrease-replication-factor, se reduce a uno el número de nodos en el clúster de DAX especificado.aws dax decrease-replication-factor \ --cluster-namedaxcluster\ --new-replication-factor1Salida:
{ "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 obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte DecreaseReplicationFactor
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-cluster.
- AWS CLI
-
Eliminación de un clúster de DAX
En el siguiente ejemplo de
delete-cluster, se elimina el clúster de DAX especificado.aws dax delete-cluster \ --cluster-namedaxclusterSalida:
{ "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 obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener información sobre la API, consulte DeleteCluster
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-parameter-group.
- AWS CLI
-
Para eliminar un grupo de parámetros
En el siguiente ejemplo de
delete-parameter-group, se elimina el grupo de parámetros de DAX especificado.aws dax delete-parameter-group \ --parameter-group-namedaxparametergroupSalida:
{ "DeletionMessage": "Parameter group daxparametergroup has been deleted." }Para obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte DeleteParameterGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-subnet-group.
- AWS CLI
-
Para eliminar un grupo de subredes
En el siguiente ejemplo de
delete-subnet-group, se elimina el grupo de subredes de DAX especificado.aws dax delete-subnet-group \ --subnet-group-namedaxSubnetGroupSalida:
{ "DeletionMessage": "Subnet group daxSubnetGroup has been deleted." }Para obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte DeleteSubnetGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-clusters.
- AWS CLI
-
Devolución de información acerca de todos los clústeres de DAX aprovisionados
En el siguiente ejemplo de
describe-clusters, se muestran detalles acerca de los clústeres de DAX aprovisionados.aws dax describe-clustersSalida:
{ "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 obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener información sobre la API, consulte DescribeClusters
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-default-parameters.
- AWS CLI
-
Devolución de información de parámetros del sistema predeterminado para DAX
En el siguiente ejemplo de
describe-default-parameters, se muestra información de parámetros del sistema predeterminado para DAX.aws dax describe-default-parametersSalida:
{ "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 obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte DescribeDefaultParameters
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-events.
- AWS CLI
-
Devolución de todos los eventos relacionados con clústeres y grupos de parámetros de DAX
En el siguiente ejemplo de
describe-events, se muestran detalles de los eventos relacionados con los grupos de parámetros y clústeres de DAX.aws dax describe-eventsSalida:
{ "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 obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte DescribeEvents
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-parameter-groups.
- AWS CLI
-
Descripción de los grupos de parámetros definidos en DAX
En el siguiente ejemplo de
describe-parameter-groups, se recuperan los detalles sobre los grupos de parámetros definidos en DAX.aws dax describe-parameter-groupsSalida:
{ "ParameterGroups": [ { "ParameterGroupName": "default.dax1.0", "Description": "Default parameter group for dax1.0" } ] }Para obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte DescribeParameterGroups
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-parameters.
- AWS CLI
-
Descripción de los parámetros definidos en un grupo de parámetros de DAX
En el siguiente ejemplo de
describe-parameters, se recupera información sobre los parámetros definidos en el grupo de parámetros de DAX especificado.aws dax describe-parameters \ --parameter-group-namedefault.dax1.0Salida:
{ "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 obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener información sobre la API, consulte DescribeParameters
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-subnet-groups.
- AWS CLI
-
Descripción de los grupos de subredes definidos en DAX
En el siguiente ejemplo de
describe-subnet-groups, se recupera la información de los grupos de subredes definidos en DAX.aws dax describe-subnet-groupsSalida:
{ "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 obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte DescribeSubnetGroups
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar increase-replication-factor.
- AWS CLI
-
Aumento del factor de replicación de un clúster de DAX
En el siguiente ejemplo de
increase-replication-factor, se aumenta a 3 el factor de replicación del clúster DAX especificado.aws dax increase-replication-factor \ --cluster-namedaxcluster\ --new-replication-factor3Salida:
{ "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 obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener detalles sobre la API, consulte IncreaseReplicationFactor
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-tags.
- AWS CLI
-
Para enumerar etiquetas de un recurso de DAX
En el siguiente ejemplo de
list-tags, se enumeran las claves y los valores de las etiquetas adjuntos al clúster de DAX especificado.aws dax list-tags \ --resource-namearn:aws:dax:us-west-2:123456789012:cache/daxclusterSalida:
{ "Tags": [ { "Key": "ClusterUsage", "Value": "prod" } ] }Para obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para obtener más información sobre la API, consulte ListTags
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.
- AWS CLI
-
Etiquetado de un recurso de DAX
En el siguiente ejemplo de
tag-resource, se asocia el nombre de la clave de etiqueta especificada y el valor asociado al clúster de DAX especificado para describir el uso del clúster.aws dax tag-resource \ --resource-namearn:aws:dax:us-west-2:123456789012:cache/daxcluster\ --tags="Key=ClusterUsage,Value=prod"Salida:
{ "Tags": [ { "Key": "ClusterUsage", "Value": "prod" } ] }Para obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para ver los detalles de la API, consulte TagResource
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.
- AWS CLI
-
Eliminación de etiquetas de un recurso de DAX
En el siguiente ejemplo de
untag-resource, se elimina la etiqueta con un nombre de clave especificado de un clúster de DAX.aws dax untag-resource \ --resource-namearn:aws:dax:us-west-2:123456789012:cache/daxcluster\ --tag-keys="ClusterUsage"Salida:
{ "Tags": [] }Para obtener más información, consulte Administración de los clústeres de DAX en la Guía para desarrolladores de Amazon DynamoDB.
-
Para ver los detalles de la API, consulte UntagResource
en la Referencia de comandos de la AWS CLI.
-
