aws elasticache create-cache-cluster

Creates a cluster. AWS CLI reference

1 example 30 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To create a cache cluster

The following create-cache-cluster example creates a cache cluster using the Redis engine.

aws elasticache create-cache-cluster --cache-cluster-id "cluster-test" --engine redis --cache-node-type cache.m5.large --num-cache-nodes 1

Identify

--cache-cluster-idThe node group (shard) identifier.

--engineThe name of the cache engine to be used for this cluster.

--cache-node-typeThe compute and memory capacity of the nodes in the node group (shard).

--num-cache-nodesThe initial number of cache nodes that the cluster has.

Its output

{
    "CacheCluster": {
        "CacheClusterId": "cluster-test",
        "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
        "CacheNodeType": "cache.m5.large",
        "Engine": "redis",
        "EngineVersion": "5.0.5",
        "CacheClusterStatus": "creating",
        "NumCacheNodes": 1,
        "PreferredMaintenanceWindow": "sat:13:00-sat:14:00",
        "PendingModifiedValues": {},
        "CacheSecurityGroups": [],
        "CacheParameterGroup": {
            "CacheParameterGroupName": "default.redis5.0",
            "ParameterApplyStatus": "in-sync",
            "CacheNodeIdsToReboot": []
        },
        "CacheSubnetGroupName": "default",
        "AutoMinorVersionUpgrade": true,
        "SnapshotRetentionLimit": 0,
        "SnapshotWindow": "06:30-07:30",
        "TransitEncryptionEnabled": false,
        "AtRestEncryptionEnabled": false
    }
}

For more information, see Creating a Cluster in the Elasticache User Guide.

Options

30 in the AWS CLI reference

Show its 30 options

--auth-tokenReserved parameter.

--auto-minor-version-upgradeIf you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign.

--az-modeSpecifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

--cache-cluster-idThe node group (shard) identifier.

--cache-node-typeThe compute and memory capacity of the nodes in the node group (shard).

--cache-parameter-group-nameThe name of the parameter group to associate with this cluster.

--cache-security-group-namesA list of security group names to associate with this cluster.

--cache-subnet-group-nameThe name of the subnet group to be used for the cluster.

--engine-versionThe version number of the cache engine to be used for this cluster.

--engineThe name of the cache engine to be used for this cluster.

--ip-discoveryThe network type you choose when modifying a cluster, either ipv4 | ipv6.

--log-delivery-configurationsSpecifies the destination, format and type of the logs.

--network-typeMust be either ipv4 | ipv6 | dual_stack.

--notification-topic-arnThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

--num-cache-nodesThe initial number of cache nodes that the cluster has.

--outpost-modeSpecifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

--portThe port number on which each of the cache nodes accepts connections.

--preferred-availability-zoneThe EC2 Availability Zone in which the cluster is created.

--preferred-availability-zonesA list of the Availability Zones in which cache nodes are created.

--preferred-maintenance-windowSpecifies the weekly time range during which maintenance on the cluster is performed.

--preferred-outpost-arnThe outpost ARN in which the cache cluster is created.

--preferred-outpost-arnsThe outpost ARNs in which the cache cluster is created.

--replication-group-idThe ID of the replication group to which this cluster should belong.

--security-group-idsOne or more VPC security groups associated with the cluster.

--snapshot-arnsA single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.

--snapshot-nameThe name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).

--snapshot-retention-limitThe number of days for which ElastiCache retains automatic snapshots before deleting them.

--snapshot-windowThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

--tagsA list of tags to be added to this resource.

--transit-encryption-enabledA flag that enables in-transit encryption when set to true.