/ 
Paws-0.25
River stage two • 9 direct dependents • 11 total dependents
⭐ Starred 171 GitHub stars
/ Paws::ElastiCache::CacheCluster

NAME

Paws::ElastiCache::CacheCluster

USAGE

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 => { AutoMinorVersionUpgrade => $value, ..., SnapshotWindow => $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->AutoMinorVersionUpgrade

DESCRIPTION

Contains all of the attributes of a specific cache cluster.

ATTRIBUTES

AutoMinorVersionUpgrade => Bool

This parameter is currently disabled.

CacheClusterCreateTime => Str

The date and time when the cache cluster was created.

CacheClusterId => Str

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

CacheClusterStatus => Str

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

CacheNodes => ArrayRef[Paws::ElastiCache::CacheNode]

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

CacheNodeType => Str

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

Valid node types are as follows:

  • General purpose:

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

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

  • Compute optimized: cache.c1.xlarge

  • Memory optimized

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

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).

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

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

CacheParameterGroup => Paws::ElastiCache::CacheParameterGroupStatus

CacheSecurityGroups => ArrayRef[Paws::ElastiCache::CacheSecurityGroupMembership]

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

CacheSubnetGroupName => Str

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

ClientDownloadLandingPage => Str

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

ConfigurationEndpoint => Paws::ElastiCache::Endpoint

Engine => Str

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

EngineVersion => Str

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

NotificationConfiguration => Paws::ElastiCache::NotificationConfiguration

NumCacheNodes => Int

The number of cache nodes in the cache cluster.

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

PendingModifiedValues => Paws::ElastiCache::PendingModifiedValues

PreferredAvailabilityZone => Str

The name of the Availability Zone in which the cache cluster is located
or "Multiple" if the cache nodes are located in different Availability
Zones.

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 C<ddd> are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

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

ReplicationGroupId => Str

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

SecurityGroups => ArrayRef[Paws::ElastiCache::SecurityGroupMembership]

A list of VPC Security Groups associated with the cache cluster.

SnapshotRetentionLimit => Int

The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them. For example, if you set
I<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.

Example: 05:00-09:00

SEE ALSO

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