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::CacheCluster(3) User Contributed Perl Documentation Paws::ElastiCache::CacheCluster(3)

Paws::ElastiCache::CacheCluster

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::ElastiCache::CacheCluster object:

  $service_obj->Method(Att1 => { ARN => $value, ..., TransitEncryptionEnabled => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ElastiCache::CacheCluster object:

  $result = $service_obj->Method(...);
  $result->Att1->ARN

Contains all of the attributes of a specific cluster.

The ARN (Amazon Resource Name) of the cache cluster.

A flag that enables encryption at-rest when set to "true".

You cannot modify the value of "AtRestEncryptionEnabled" after the cluster is created. To enable at-rest encryption on a cluster you must set "AtRestEncryptionEnabled" to "true" when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, "4.x" or later.

Default: "false"

A flag that enables using an "AuthToken" (password) when issuing Redis commands.

Default: "false"

The date the auth token was last modified

This parameter is currently disabled.

The date and time when the cluster was created.

The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

The current state of this cluster, one of the following values: "available", "creating", "deleted", "deleting", "incompatible-network", "modifying", "rebooting cluster nodes", "restore-failed", or "snapshotting".

A list of cache nodes that are members of the cluster.

The name of the compute and memory capacity node type for the cluster.

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.

Status of the cache parameter group.

A list of cache security group elements, composed of name and status sub-elements.

The name of the cache subnet group associated with the cluster.

The URL of the web page where you can download the latest ElastiCache client library.

Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have ".cfg" in it.

Example: "mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211"

The name of the cache engine ("memcached" or "redis") to be used for this cluster.

The version of the cache engine that is used in this cluster.

Returns the destination, format and type of the logs.

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

The number of cache nodes in the cluster.

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

The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different 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:

  • "sun"
  • "mon"
  • "tue"
  • "wed"
  • "thu"
  • "fri"
  • "sat"

Example: "sun:23:00-mon:01:30"

The outpost ARN in which the cache cluster is created.

The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

A boolean value indicating whether log delivery is enabled for the replication group.

A list of VPC Security Groups associated with the cluster.

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

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

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

Example: "05:00-09:00"

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

You cannot modify the value of "TransitEncryptionEnabled" after the cluster is created. To enable in-transit encryption on a cluster you must set "TransitEncryptionEnabled" to "true" when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, "4.x" or later.

Default: "false"

This class forms part of Paws, describing an object used 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.