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

FreeBSD Manual Pages

  
 
  

home | help
Paws::ElastiCache::ModUseraContributedPPws::ElastiCache::ModifyCacheCluster(3)

NAME
       Paws::ElastiCache::ModifyCacheCluster - Arguments for method
       ModifyCacheCluster on Paws::ElastiCache

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

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

       As an example:

	 $service_obj->ModifyCacheCluster(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.

ATTRIBUTES
   ApplyImmediately => Bool
       If "true", this parameter causes	the modifications in this request and
       any pending modifications to be applied,	asynchronously and as soon as
       possible, regardless of the PreferredMaintenanceWindow setting for the
       cache cluster.

       If "false", then	changes	to the cache cluster are applied on the	next
       maintenance reboot, or the next failure reboot, whichever occurs	first.

       If you perform a	"ModifyCacheCluster" before a pending modification is
       applied,	the pending modification is replaced by	the newer
       modification.

       Valid values: "true" | "false"

       Default:	"false"

   AutoMinorVersionUpgrade => Bool
       This parameter is currently disabled.

   AZMode => Str
       Specifies whether the new nodes in this Memcached cache cluster are all
       created in a single Availability	Zone or	created	across multiple
       Availability Zones.

       Valid values: "single-az" | "cross-az".

       This option is only supported for Memcached cache clusters.

       You cannot specify "single-az" if the Memcached cache cluster already
       has cache nodes in different Availability Zones.	If "cross-az" is
       specified, existing Memcached nodes remain in their current
       Availability Zone.

       Only newly created nodes	will be	located	in different Availability
       Zones. For instructions on how to move existing Memcached nodes to
       different Availability Zones, see the Availability Zone Considerations
       section of Cache	Node Considerations for	Memcached.

   REQUIRED CacheClusterId => Str
       The cache cluster identifier. This value	is stored as a lowercase
       string.

   CacheNodeIdsToRemove	=> ArrayRef[Str]
       A list of cache node IDs	to be removed. A node ID is a numeric
       identifier (0001, 0002, etc.). This parameter is	only valid when
       NumCacheNodes is	less than the existing number of cache nodes. The
       number of cache node IDs	supplied in this parameter must	match the
       difference between the existing number of cache nodes in	the cluster or
       pending cache nodes, whichever is greater, and the value	of
       NumCacheNodes in	the request.

       For example: If you have	3 active cache nodes, 7	pending	cache nodes,
       and the number of cache nodes in	this "ModifyCacheCluser" call is 5,
       you must	list 2 (7 - 5) cache node IDs to remove.

   CacheParameterGroupName => Str
       The name	of the cache parameter group to	apply to this cache cluster.
       This change is asynchronously applied as	soon as	possible for
       parameters when the ApplyImmediately parameter is specified as true for
       this request.

   CacheSecurityGroupNames => ArrayRef[Str]
       A list of cache security	group names to authorize on this cache
       cluster.	This change is asynchronously applied as soon as possible.

       This parameter can be used only with clusters that are created outside
       of an Amazon Virtual Private Cloud (VPC).

       Constraints: Must contain no more than 255 alphanumeric characters.
       Must not	be "Default".

   EngineVersion => Str
       The upgraded version of the cache engine	to be run on the cache nodes.

   NewAvailabilityZones	=> ArrayRef[Str]
       The list	of Availability	Zones where the	new Memcached cache nodes will
       be created.

       This parameter is only valid when NumCacheNodes in the request is
       greater than the	sum of the number of active cache nodes	and the	number
       of cache	nodes pending creation (which may be zero). The	number of
       Availability Zones supplied in this list	must match the cache nodes
       being added in this request.

       This option is only supported on	Memcached clusters.

       Scenarios:

       o   Scenario 1: You have	3 active nodes and wish	to add 2 nodes.

	   Specify "NumCacheNodes=5" (3	+ 2) and optionally specify two
	   Availability	Zones for the two new nodes.

       o   Scenario 2: You have	3 active nodes and 2 nodes pending creation
	   (from the scenario 1	call) and want to add 1	more node.

	   Specify "NumCacheNodes=6" ((3 + 2) +	1)

	   and optionally specify an Availability Zone for the new node.

       o   Scenario 3: You want	to cancel all pending actions.

	   Specify "NumCacheNodes=3" to	cancel all pending actions.

       The Availability	Zone placement of nodes	pending	creation cannot	be
       modified. If you	wish to	cancel any nodes pending creation, add 0 nodes
       by setting "NumCacheNodes" to the number	of current nodes.

       If "cross-az" is	specified, existing Memcached nodes remain in their
       current Availability Zone. Only newly created nodes can be located in
       different Availability Zones. For guidance on how to move existing
       Memcached nodes to different Availability Zones,	see the	Availability
       Zone Considerations section of Cache Node Considerations	for Memcached.

       Impact of new add/remove	requests upon pending requests

       Scenarios

       Pending action

       New Request

       Results

       Scenario-1

       Delete

       Delete

       The new delete, pending or immediate, replaces the pending delete.

       Scenario-2

       Delete

       Create

       The new create, pending or immediate, replaces the pending delete.

       Scenario-3

       Create

       Delete

       The new delete, pending or immediate, replaces the pending create.

       Scenario-4

       Create

       Create

       The new create is added to the pending create.

       Important:

       If the new create request is Apply Immediately -	Yes, all creates are
       performed immediately. If the new create	request	is Apply Immediately -
       No, all creates are pending.

       Example:
       "NewAvailabilityZones.member.1=us-west-2a&NewAvailabilityZones.member.2=us-west-2b&NewAvailabilityZones.member.3=us-west-2c"

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

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

   NotificationTopicStatus => Str
       The status of the Amazon	SNS notification topic.	Notifications are sent
       only if the status is active.

       Valid values: "active" |	"inactive"

   NumCacheNodes => Int
       The number of cache nodes that the cache	cluster	should have. If	the
       value for "NumCacheNodes" is greater than the sum of the	number of
       current cache nodes and the number of cache nodes pending creation
       (which may be zero), then more nodes will be added. If the value	is
       less than the number of existing	cache nodes, then nodes	will be
       removed.	If the value is	equal to the number of current cache nodes,
       then any	pending	add or remove requests are canceled.

       If you are removing cache nodes,	you must use the
       "CacheNodeIdsToRemove" parameter	to provide the IDs of the specific
       cache nodes to remove.

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

       Note:

       Adding or removing Memcached cache nodes	can be applied immediately or
       as a pending action. See	"ApplyImmediately".

       A pending action	to modify the number of	cache nodes in a cluster
       during its maintenance window, whether by adding	or removing nodes in
       accordance with the scale out architecture, is not queued. The
       customer's latest request to add	or remove nodes	to the cluster
       overrides any previous pending actions to modify	the number of cache
       nodes in	the cluster. For example, a request to remove 2	nodes would
       override	a previous pending action to remove 3 nodes. Similarly,	a
       request to add 2	nodes would override a previous	pending	action to
       remove 3	nodes and vice versa. As Memcached cache nodes may now be
       provisioned in different	Availability Zones with	flexible cache node
       placement, a request to add nodes does not automatically	override a
       previous	pending	action to add nodes. The customer can modify the
       previous	pending	action to add more nodes or explicitly cancel the
       pending request and retry the new request. To cancel pending actions to
       modify the number of cache nodes	in a cluster, use the
       "ModifyCacheCluster" request and	set NumCacheNodes equal	to the number
       of cache	nodes currently	in the cache cluster.

   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"

   SecurityGroupIds => ArrayRef[Str]
       Specifies the VPC Security Groups associated with the cache cluster.

       This parameter can be used only with clusters that are created in an
       Amazon Virtual Private Cloud (VPC).

   SnapshotRetentionLimit => Int
       The number of days for which ElastiCache	will retain automatic cache
       cluster 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.

       Important

       If the value of SnapshotRetentionLimit is set to	zero (0), backups are
       turned off.

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

SEE ALSO
       This class forms	part of	Paws, documenting arguments for	method
       ModifyCacheCluster in Paws::ElastiCache

BUGS and CONTRIBUTIONS
       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

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

NAME | DESCRIPTION | ATTRIBUTES | SEE ALSO | BUGS and CONTRIBUTIONS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Paws::ElastiCache::ModifyCacheCluster&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help