The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

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 => { AtRestEncryptionEnabled => $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->AtRestEncryptionEnabled

DESCRIPTION

Contains all of the attributes of a specific cluster.

ATTRIBUTES

AtRestEncryptionEnabled => Bool

  A flag that enables encryption at-rest when set to C<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 or 4.x.

Default: false

AuthTokenEnabled => Bool

  A flag that enables using an C<AuthToken> (password) when issuing Redis
commands.

Default: false

AutoMinorVersionUpgrade => Bool

  This parameter is currently disabled.

CacheClusterCreateTime => Str

  The date and time when the cluster was created.

CacheClusterId => Str

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

CacheClusterStatus => Str

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

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

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

CacheNodeType => Str

  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:

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • 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

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

      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

Notes:

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

  • Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

  • Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see:

  • Amazon ElastiCache Product Features and Details (http://aws.amazon.com/elasticache/details)

  • Cache Node Type-Specific Parameters for Memcached (http://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific)

  • Cache Node Type-Specific Parameters for Redis (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific)

CacheParameterGroup => Paws::ElastiCache::CacheParameterGroupStatus

  Status of the cache parameter group.

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

ClientDownloadLandingPage => Str

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

ConfigurationEndpoint => Paws::ElastiCache::Endpoint

  Represents a Memcached cluster endpoint which, if Automatic Discovery
is enabled on the cluster, can be used by an application to connect to
any node in the cluster. The configuration endpoint will always have
C<.cfg> in it.

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

Engine => Str

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

EngineVersion => Str

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

NotificationConfiguration => Paws::ElastiCache::NotificationConfiguration

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

NumCacheNodes => Int

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

PendingModifiedValues => Paws::ElastiCache::PendingModifiedValues

PreferredAvailabilityZone => Str

  The name of the Availability Zone in which the 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 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

ReplicationGroupId => Str

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

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

  A list of VPC Security Groups associated with the cluster.

SnapshotRetentionLimit => Int

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

SnapshotWindow => Str

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

Example: 05:00-09:00

TransitEncryptionEnabled => Bool

  A flag that enables in-transit encryption when set to C<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 or 4.x.

Default: false

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