Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help

       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 shouln't make instances of this class. Each attribute should	be
       used as a named argument	in the call to CreateCacheCluster.

       As an example:

	 $service_obj->CreateCacheCluster(Att1 => $value1, Att2	=> $value2, ...);

       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.

   AutoMinorVersionUpgrade => Bool
       This parameter is currently disabled.

   AZMode => Str
       Specifies whether the nodes in this Memcached node group	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 cache clusters.

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

   REQUIRED CacheClusterId => Str
       The node	group identifier. This parameter is stored as a	lowercase


       o   A name must contain from 1 to 20 alphanumeric characters or

       o   The first character must be a letter.

       o   A name cannot end with a hyphen or contain two consecutive hyphens.

   CacheNodeType => Str
       The compute and memory capacity of the nodes in the node	group.

       Valid node types	are as follows:

       o   General purpose:

	   o   Current generation: "cache.t2.micro", "cache.t2.small",
	       "cache.t2.medium", "cache.m3.medium", "cache.m3.large",
	       "cache.m3.xlarge", "cache.m3.2xlarge"

	   o   Previous	generation: "cache.t1.micro", "cache.m1.small",
	       "cache.m1.medium", "cache.m1.large", "cache.m1.xlarge"

       o   Compute optimized: "cache.c1.xlarge"

       o   Memory optimized

	   o   Current generation: "cache.r3.large", "cache.r3.xlarge",
	       "cache.r3.2xlarge", "cache.r3.4xlarge", "cache.r3.8xlarge"

	   o   Previous	generation: "cache.m2.xlarge", "cache.m2.2xlarge",


       o   All t2 instances are	created	in an Amazon Virtual Private Cloud

       o   Redis backup/restore	is not supported for t2	instances.

       o   Redis Append-only files (AOF) functionality is not supported	for t1
	   or t2 instances.

       For a complete listing of cache node types and specifications, see
       Amazon ElastiCache Product Features and Details and Cache Node Type-
       Specific	Parameters for Memcached or Cache Node Type-Specific
       Parameters for Redis.

   CacheParameterGroupName => Str
       The name	of the parameter group to associate with this cache cluster.
       If this argument	is omitted, the	default	parameter group	for the
       specified engine	is used.

   CacheSecurityGroupNames => ArrayRef[Str]
       A list of security group	names to associate with	this cache cluster.

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

   CacheSubnetGroupName	=> Str
       The name	of the subnet group to be used for the cache cluster.

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

   Engine => Str
       The name	of the cache engine to be used for this	cache cluster.

       Valid values for	this parameter are:

       "memcached" | "redis"

   EngineVersion => Str
       The version number of the cache engine to be used for this cache
       cluster.	To view	the supported cache engine versions, use the
       DescribeCacheEngineVersions action.

   NotificationTopicArn	=> Str
       The Amazon Resource Name	(ARN) of the Amazon Simple Notification
       Service (SNS) topic to which notifications will be sent.

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

   NumCacheNodes => Int
       The initial number of cache nodes that the cache	cluster	will have.

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

       If you need more	than 20	nodes for your Memcached cluster, please fill
       out the ElastiCache Limit Increase Request form at

   Port	=> Int
       The port	number on which	each of	the cache nodes	will accept

   PreferredAvailabilityZone =>	Str
       The EC2 Availability Zone in which the cache cluster will be created.

       All nodes belonging to this Memcached cache 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 => ArrayRef[Str]
       A list of the Availability Zones	in which cache nodes will be created.
       The order of the	zones in the list is not important.

       This option is only supported on	Memcached.

       If you are creating your	cache 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

       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.

       Example:	One Memcached node in each of three different Availability

       Example:	All three Memcached nodes in one Availability Zone:

   PreferredMaintenanceWindow => Str
       Specifies the weekly time range during which maintenance	on the cache
       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:

       o   "sun"

       o   "mon"

       o   "tue"

       o   "wed"

       o   "thu"

       o   "fri"

       o   "sat"

       Example:	"sun:05:00-sun:09:00"

   ReplicationGroupId => Str
       The ID of the replication group to which	this cache cluster should
       belong. If this parameter is specified, the cache cluster will be added
       to the specified	replication group as a read replica; otherwise,	the
       cache cluster will be 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 cache cluster will be created
       in availability zones that provide the best spread of read replicas
       across availability zones.

       Note: This parameter is only valid if the "Engine" parameter is

   SecurityGroupIds => ArrayRef[Str]
       One or more VPC security	groups associated with the cache cluster.

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

   SnapshotArns	=> ArrayRef[Str]
       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 will be used to populate the node group. The Amazon
       S3 object name in the ARN cannot	contain	any commas.

       Note: This parameter is only valid if the "Engine" parameter is

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

   SnapshotName	=> Str
       The name	of a snapshot from which to restore data into the new node
       group. The snapshot status changes to "restoring" while the new node
       group is	being created.

       Note: This parameter is only valid if the "Engine" parameter is

   SnapshotRetentionLimit => Int
       The number of days for which ElastiCache	will retain automatic
       snapshots before	deleting them. For example, if you set
       "SnapshotRetentionLimit"	to 5, then a snapshot that was taken today
       will be retained	for 5 days before being	deleted.

       Note: This parameter is only valid if the "Engine" parameter is

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

   SnapshotWindow => Str
       The daily time range (in	UTC) during which ElastiCache will begin
       taking a	daily snapshot of your node group.

       Example:	"05:00-09:00"

       If you do not specify this parameter, then ElastiCache will
       automatically choose an appropriate time	range.

       Note: This parameter is only valid if the "Engine" parameter is

   Tags	=> ArrayRef[Paws::ElastiCache::Tag]
       A list of cost allocation tags to be added to this resource. A tag is a
       key-value pair. A tag key must be accompanied by	a tag value.

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

       The source code is located here:

       Please report bugs to:

perl v5.24.1			  2015Paws::ElastiCache::CreateCacheCluster(3)


Want to link to this manual page? Use this URL:

home | help