GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::ElastiCache::CreateCacheCluster(3) User Contributed Perl Documentation Paws::ElastiCache::CreateCacheCluster(3)

Paws::ElastiCache::CreateCacheCluster - Arguments for method CreateCacheCluster on Paws::ElastiCache

This class represents the parameters used for calling the method CreateCacheCluster on the Amazon ElastiCache service. Use the attributes of this class as arguments to method CreateCacheCluster.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCacheCluster.

    my $elasticache = Paws->service('ElastiCache');
    # CreateCacheCluster
    # Creates a Memcached cluster with 2 nodes.
    my $CreateCacheClusterResult = $elasticache->CreateCacheCluster(
      'AZMode'               => 'cross-az',
      'CacheClusterId'       => 'my-memcached-cluster',
      'CacheNodeType'        => 'cache.r3.large',
      'CacheSubnetGroupName' => 'default',
      'Engine'               => 'memcached',
      'EngineVersion'        => '1.4.24',
      'NumCacheNodes'        => 2,
      'Port'                 => 11211
    );
    # Results:
    my $CacheCluster = $CreateCacheClusterResult->CacheCluster;
    # Returns a L<Paws::ElastiCache::CreateCacheClusterResult> object.
    # CreateCacheCluster
    # Creates a Redis cluster with 1 node.
    my $CreateCacheClusterResult = $elasticache->CreateCacheCluster(
      'AutoMinorVersionUpgrade'   => 1,
      'CacheClusterId'            => 'my-redis',
      'CacheNodeType'             => 'cache.r3.larage',
      'CacheSubnetGroupName'      => 'default',
      'Engine'                    => 'redis',
      'EngineVersion'             => '3.2.4',
      'NumCacheNodes'             => 1,
      'Port'                      => 6379,
      'PreferredAvailabilityZone' => 'us-east-1c',
      'SnapshotRetentionLimit'    => 7
    );
    # Results:
    my $CacheCluster = $CreateCacheClusterResult->CacheCluster;
    # Returns a L<Paws::ElastiCache::CreateCacheClusterResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/elasticache/CreateCacheCluster>

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 (http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH.

This parameter is currently disabled.

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.

Valid values are: "single-az", "cross-az"

REQUIRED CacheClusterId => Str

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.

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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)

    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"

    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)

    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)

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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)

    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)

    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.

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.

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

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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html).

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

Valid values for this parameter are: "memcached" | "redis"

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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), 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.

Specifies the destination, format and type of the logs.

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.

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/ (http://aws.amazon.com/contact-us/elasticache-node-limit-request/).

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

Valid values are: "single-outpost", "cross-outpost"

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

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.

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.

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. Valid values for "ddd" are:

The outpost ARN in which the cache cluster is created.

The outpost ARNs in which the cache cluster is created.

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

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

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"

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

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

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

A list of tags to be added to this resource.

This class forms part of Paws, documenting arguments for method CreateCacheCluster in Paws::ElastiCache

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.