amazonka-elasticache-2.0: Amazon ElastiCache SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ElastiCache.CreateCacheCluster

Description

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

This operation is not supported for Redis (cluster mode enabled) clusters.

Synopsis

Creating a Request

data CreateCacheCluster Source #

Represents the input of a CreateCacheCluster operation.

See: newCreateCacheCluster smart constructor.

Constructors

CreateCacheCluster' 

Fields

  • aZMode :: Maybe AZMode

    Specifies 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.

    This parameter is only supported for Memcached clusters.

    If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

  • authToken :: Maybe Text

    Reserved parameter. The password used to access a password protected server.

    Password constraints:

    • Must be only printable ASCII characters.
    • Must be at least 16 characters and no more than 128 characters in length.
    • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see AUTH password at http://redis.io/commands/AUTH.

  • autoMinorVersionUpgrade :: Maybe Bool

    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

  • cacheNodeType :: Maybe Text

    The compute and memory capacity of the nodes in the node group (shard).

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

        For region availability, see Supported Node Types

        M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

        M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

        T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

        T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        T1 node types: cache.t1.micro

        M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

        M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

        cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

        For region availability, see Supported Node Types

        R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

        R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

        R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    Additional node type info

    • All current generation instance types are created in Amazon VPC by default.
    • Redis append-only files (AOF) are not supported for T1 or T2 instances.
    • Redis Multi-AZ with automatic failover is not supported on T1 instances.
    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
  • cacheParameterGroupName :: Maybe Text

    The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

  • cacheSecurityGroupNames :: Maybe [Text]

    A list of security group names to associate with this cluster.

    Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

  • cacheSubnetGroupName :: Maybe Text

    The name of the subnet group to be used for the cluster.

    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

    If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

  • engine :: Maybe Text

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

    Valid values for this parameter are: memcached | redis

  • engineVersion :: Maybe Text

    The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

  • ipDiscovery :: Maybe IpDiscovery

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

  • logDeliveryConfigurations :: Maybe [LogDeliveryConfigurationRequest]

    Specifies the destination, format and type of the logs.

  • networkType :: Maybe NetworkType

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

  • notificationTopicArn :: Maybe Text

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

    The Amazon SNS topic owner must be the same as the cluster owner.

  • numCacheNodes :: Maybe Int

    The initial number of cache nodes that the cluster has.

    For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

  • outpostMode :: Maybe OutpostMode

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

  • port :: Maybe Int

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

  • preferredAvailabilityZone :: Maybe Text

    The EC2 Availability Zone in which the cluster is created.

    All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

    Default: System chosen Availability Zone.

  • preferredAvailabilityZones :: Maybe [Text]

    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

    This option is only supported on Memcached.

    If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

    The number of Availability Zones listed must equal the value of NumCacheNodes.

    If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

    Default: System chosen Availability Zones.

  • preferredMaintenanceWindow :: Maybe Text

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

  • preferredOutpostArn :: Maybe Text

    The outpost ARN in which the cache cluster is created.

  • preferredOutpostArns :: Maybe [Text]

    The outpost ARNs in which the cache cluster is created.

  • replicationGroupId :: Maybe Text

    The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

    If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

    This parameter is only valid if the Engine parameter is redis.

  • securityGroupIds :: Maybe [Text]

    One or more VPC security groups associated with the cluster.

    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

  • snapshotArns :: Maybe [Text]

    A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

    This parameter is only valid if the Engine parameter is redis.

    Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

  • snapshotName :: Maybe Text

    The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

    This parameter is only valid if the Engine parameter is redis.

  • snapshotRetentionLimit :: Maybe Int

    The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

    This parameter is only valid if the Engine parameter is redis.

    Default: 0 (i.e., automatic backups are disabled for this cache cluster).

  • snapshotWindow :: Maybe Text

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

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    This parameter is only valid if the Engine parameter is redis.

  • tags :: Maybe [Tag]

    A list of tags to be added to this resource.

  • transitEncryptionEnabled :: Maybe Bool

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

    Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.

  • cacheClusterId :: Text

    The node group (shard) identifier. This parameter is stored as a lowercase string.

    Constraints:

    • A name must contain from 1 to 50 alphanumeric characters or hyphens.
    • The first character must be a letter.
    • A name cannot end with a hyphen or contain two consecutive hyphens.

Instances

Instances details
ToHeaders CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

toHeaders :: CreateCacheCluster -> [Header] #

ToPath CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

toPath :: CreateCacheCluster -> ByteString #

ToQuery CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

toQuery :: CreateCacheCluster -> QueryString #

AWSRequest CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Associated Types

type AWSResponse CreateCacheCluster #

Methods

request :: (Service -> Service) -> CreateCacheCluster -> Request CreateCacheCluster #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCacheCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCacheCluster))) #

Generic CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Associated Types

type Rep CreateCacheCluster :: Type -> Type #

Methods

from :: CreateCacheCluster -> Rep CreateCacheCluster x #

to :: Rep CreateCacheCluster x -> CreateCacheCluster #

Read CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

readsPrec :: Int -> ReadS CreateCacheCluster #

readList :: ReadS [CreateCacheCluster] #

readPrec :: ReadPrec CreateCacheCluster #

readListPrec :: ReadPrec [CreateCacheCluster] #

Show CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

showsPrec :: Int -> CreateCacheCluster -> ShowS #

show :: CreateCacheCluster -> String #

showList :: [CreateCacheCluster] -> ShowS #

NFData CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

rnf :: CreateCacheCluster -> () #

Eq CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

(==) :: CreateCacheCluster -> CreateCacheCluster -> Bool #

(/=) :: CreateCacheCluster -> CreateCacheCluster -> Bool #

Hashable CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

hashWithSalt :: Int -> CreateCacheCluster -> Int #

hash :: CreateCacheCluster -> Int #

type AWSResponse CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

type AWSResponse CreateCacheCluster = CreateCacheClusterResponse
type Rep CreateCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

type Rep CreateCacheCluster = D1 ('MetaData "CreateCacheCluster" "Amazonka.ElastiCache.CreateCacheCluster" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "CreateCacheCluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "aZMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AZMode)) :*: (S1 ('MetaSel ('Just "authToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "cacheNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cacheParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "cacheSecurityGroupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "cacheSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "ipDiscovery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpDiscovery)) :*: S1 ('MetaSel ('Just "logDeliveryConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LogDeliveryConfigurationRequest])))) :*: ((S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkType)) :*: S1 ('MetaSel ('Just "notificationTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "numCacheNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "outpostMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutpostMode)))))) :*: (((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "preferredAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preferredAvailabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preferredOutpostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "preferredOutpostArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "snapshotArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snapshotRetentionLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "snapshotWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "transitEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cacheClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateCacheCluster Source #

Arguments

:: Text

CreateCacheCluster

-> CreateCacheCluster 

Create a value of CreateCacheCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aZMode:CreateCacheCluster', createCacheCluster_aZMode - Specifies 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.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

$sel:authToken:CreateCacheCluster', createCacheCluster_authToken - Reserved parameter. The password used to access a password protected server.

Password constraints:

  • Must be only printable ASCII characters.
  • Must be at least 16 characters and no more than 128 characters in length.
  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

CreateCacheCluster, createCacheCluster_autoMinorVersionUpgrade - If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

CreateCacheCluster, createCacheCluster_cacheNodeType - The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

      For region availability, see Supported Node Types

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

      cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

      For region availability, see Supported Node Types

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.
  • Redis append-only files (AOF) are not supported for T1 or T2 instances.
  • Redis Multi-AZ with automatic failover is not supported on T1 instances.
  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

CreateCacheCluster, createCacheCluster_cacheParameterGroupName - The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

$sel:cacheSecurityGroupNames:CreateCacheCluster', createCacheCluster_cacheSecurityGroupNames - A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

CreateCacheCluster, createCacheCluster_cacheSubnetGroupName - The name of the subnet group to be used for the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

CreateCacheCluster, createCacheCluster_engine - The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

CreateCacheCluster, createCacheCluster_engineVersion - The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

CreateCacheCluster, createCacheCluster_ipDiscovery - The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

CreateCacheCluster, createCacheCluster_logDeliveryConfigurations - Specifies the destination, format and type of the logs.

CreateCacheCluster, createCacheCluster_networkType - Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

$sel:notificationTopicArn:CreateCacheCluster', createCacheCluster_notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

CreateCacheCluster, createCacheCluster_numCacheNodes - The initial number of cache nodes that the cluster has.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

$sel:outpostMode:CreateCacheCluster', createCacheCluster_outpostMode - Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

CreateCacheCluster, createCacheCluster_port - The port number on which each of the cache nodes accepts connections.

CreateCacheCluster, createCacheCluster_preferredAvailabilityZone - The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

CreateCacheCluster, createCacheCluster_preferredAvailabilityZones - A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheNodes.

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

CreateCacheCluster, createCacheCluster_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

CreateCacheCluster, createCacheCluster_preferredOutpostArn - The outpost ARN in which the cache cluster is created.

CreateCacheCluster, createCacheCluster_preferredOutpostArns - The outpost ARNs in which the cache cluster is created.

CreateCacheCluster, createCacheCluster_replicationGroupId - The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

$sel:securityGroupIds:CreateCacheCluster', createCacheCluster_securityGroupIds - One or more VPC security groups associated with the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

$sel:snapshotArns:CreateCacheCluster', createCacheCluster_snapshotArns - A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

CreateCacheCluster, createCacheCluster_snapshotName - The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

CreateCacheCluster, createCacheCluster_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

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

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

$sel:tags:CreateCacheCluster', createCacheCluster_tags - A list of tags to be added to this resource.

CreateCacheCluster, createCacheCluster_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.

Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.

CreateCacheCluster, createCacheCluster_cacheClusterId - The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 alphanumeric characters or hyphens.
  • The first character must be a letter.
  • A name cannot end with a hyphen or contain two consecutive hyphens.

Request Lenses

createCacheCluster_aZMode :: Lens' CreateCacheCluster (Maybe AZMode) Source #

Specifies 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.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

createCacheCluster_authToken :: Lens' CreateCacheCluster (Maybe Text) Source #

Reserved parameter. The password used to access a password protected server.

Password constraints:

  • Must be only printable ASCII characters.
  • Must be at least 16 characters and no more than 128 characters in length.
  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

createCacheCluster_autoMinorVersionUpgrade :: Lens' CreateCacheCluster (Maybe Bool) Source #

If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

createCacheCluster_cacheNodeType :: Lens' CreateCacheCluster (Maybe Text) Source #

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

      For region availability, see Supported Node Types

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

      cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

      For region availability, see Supported Node Types

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.
  • Redis append-only files (AOF) are not supported for T1 or T2 instances.
  • Redis Multi-AZ with automatic failover is not supported on T1 instances.
  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

createCacheCluster_cacheParameterGroupName :: Lens' CreateCacheCluster (Maybe Text) Source #

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

createCacheCluster_cacheSecurityGroupNames :: Lens' CreateCacheCluster (Maybe [Text]) Source #

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

createCacheCluster_cacheSubnetGroupName :: Lens' CreateCacheCluster (Maybe Text) Source #

The name of the subnet group to be used for the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

createCacheCluster_engine :: Lens' CreateCacheCluster (Maybe Text) Source #

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

Valid values for this parameter are: memcached | redis

createCacheCluster_engineVersion :: Lens' CreateCacheCluster (Maybe Text) Source #

The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

createCacheCluster_ipDiscovery :: Lens' CreateCacheCluster (Maybe IpDiscovery) Source #

The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

createCacheCluster_logDeliveryConfigurations :: Lens' CreateCacheCluster (Maybe [LogDeliveryConfigurationRequest]) Source #

Specifies the destination, format and type of the logs.

createCacheCluster_networkType :: Lens' CreateCacheCluster (Maybe NetworkType) Source #

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

createCacheCluster_notificationTopicArn :: Lens' CreateCacheCluster (Maybe Text) Source #

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

The Amazon SNS topic owner must be the same as the cluster owner.

createCacheCluster_numCacheNodes :: Lens' CreateCacheCluster (Maybe Int) Source #

The initial number of cache nodes that the cluster has.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

createCacheCluster_outpostMode :: Lens' CreateCacheCluster (Maybe OutpostMode) Source #

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

createCacheCluster_port :: Lens' CreateCacheCluster (Maybe Int) Source #

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

createCacheCluster_preferredAvailabilityZone :: Lens' CreateCacheCluster (Maybe Text) Source #

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

createCacheCluster_preferredAvailabilityZones :: Lens' CreateCacheCluster (Maybe [Text]) Source #

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheNodes.

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

createCacheCluster_preferredMaintenanceWindow :: Lens' CreateCacheCluster (Maybe Text) Source #

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

createCacheCluster_preferredOutpostArn :: Lens' CreateCacheCluster (Maybe Text) Source #

The outpost ARN in which the cache cluster is created.

createCacheCluster_preferredOutpostArns :: Lens' CreateCacheCluster (Maybe [Text]) Source #

The outpost ARNs in which the cache cluster is created.

createCacheCluster_replicationGroupId :: Lens' CreateCacheCluster (Maybe Text) Source #

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

createCacheCluster_securityGroupIds :: Lens' CreateCacheCluster (Maybe [Text]) Source #

One or more VPC security groups associated with the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

createCacheCluster_snapshotArns :: Lens' CreateCacheCluster (Maybe [Text]) Source #

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

createCacheCluster_snapshotName :: Lens' CreateCacheCluster (Maybe Text) Source #

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

createCacheCluster_snapshotRetentionLimit :: Lens' CreateCacheCluster (Maybe Int) Source #

The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

createCacheCluster_snapshotWindow :: Lens' CreateCacheCluster (Maybe Text) Source #

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

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

createCacheCluster_tags :: Lens' CreateCacheCluster (Maybe [Tag]) Source #

A list of tags to be added to this resource.

createCacheCluster_transitEncryptionEnabled :: Lens' CreateCacheCluster (Maybe Bool) Source #

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

Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.

createCacheCluster_cacheClusterId :: Lens' CreateCacheCluster Text Source #

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 alphanumeric characters or hyphens.
  • The first character must be a letter.
  • A name cannot end with a hyphen or contain two consecutive hyphens.

Destructuring the Response

data CreateCacheClusterResponse Source #

See: newCreateCacheClusterResponse smart constructor.

Constructors

CreateCacheClusterResponse' 

Fields

Instances

Instances details
Generic CreateCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Associated Types

type Rep CreateCacheClusterResponse :: Type -> Type #

Methods

from :: CreateCacheClusterResponse -> Rep CreateCacheClusterResponse x #

to :: Rep CreateCacheClusterResponse x -> CreateCacheClusterResponse #

Read CreateCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

readsPrec :: Int -> ReadS CreateCacheClusterResponse #

readList :: ReadS [CreateCacheClusterResponse] #

readPrec :: ReadPrec CreateCacheClusterResponse #

readListPrec :: ReadPrec [CreateCacheClusterResponse] #

Show CreateCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

showsPrec :: Int -> CreateCacheClusterResponse -> ShowS #

show :: CreateCacheClusterResponse -> String #

showList :: [CreateCacheClusterResponse] -> ShowS #

NFData CreateCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

rnf :: CreateCacheClusterResponse -> () #

Eq CreateCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

Methods

(==) :: CreateCacheClusterResponse -> CreateCacheClusterResponse -> Bool #

(/=) :: CreateCacheClusterResponse -> CreateCacheClusterResponse -> Bool #

type Rep CreateCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateCacheCluster

type Rep CreateCacheClusterResponse = D1 ('MetaData "CreateCacheClusterResponse" "Amazonka.ElastiCache.CreateCacheCluster" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "CreateCacheClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cacheCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCacheClusterResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateCacheClusterResponse'

-> CreateCacheClusterResponse 

Create a value of CreateCacheClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheCluster:CreateCacheClusterResponse', createCacheClusterResponse_cacheCluster - Undocumented member.

$sel:httpStatus:CreateCacheClusterResponse', createCacheClusterResponse_httpStatus - The response's http status code.

Response Lenses

createCacheClusterResponse_cacheCluster :: Lens' CreateCacheClusterResponse (Maybe CacheCluster) Source #

Undocumented member.

createCacheClusterResponse_httpStatus :: Lens' CreateCacheClusterResponse Int Source #

The response's http status code.