![]() |
![]()
| ![]() |
![]()
NAMEPaws::ElastiCache::CacheCluster USAGEThis 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 DESCRIPTIONContains all of the attributes of a specific cluster. ATTRIBUTESARN => StrThe ARN (Amazon Resource Name) of the cache cluster. AtRestEncryptionEnabled => BoolA 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" AuthTokenEnabled => BoolA flag that enables using an "AuthToken" (password) when issuing Redis commands. Default: "false" AuthTokenLastModifiedDate => StrThe date the auth token was last modified AutoMinorVersionUpgrade => BoolThis parameter is currently disabled. CacheClusterCreateTime => StrThe date and time when the cluster was created. CacheClusterId => StrThe user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster. CacheClusterStatus => StrThe current state of this cluster, one of the following values: "available", "creating", "deleted", "deleting", "incompatible-network", "modifying", "rebooting cluster nodes", "restore-failed", or "snapshotting". CacheNodes => ArrayRef[Paws::ElastiCache::CacheNode]A list of cache nodes that are members of the cluster. CacheNodeType => StrThe 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.
Additional node type info
CacheParameterGroup => Paws::ElastiCache::CacheParameterGroupStatusStatus 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 => StrThe name of the cache subnet group associated with the cluster. ClientDownloadLandingPage => StrThe URL of the web page where you can download the latest ElastiCache client library. ConfigurationEndpoint => Paws::ElastiCache::EndpointRepresents 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" Engine => StrThe name of the cache engine ("memcached" or "redis") to be used for this cluster. EngineVersion => StrThe version of the cache engine that is used in this cluster. LogDeliveryConfigurations => ArrayRef[Paws::ElastiCache::LogDeliveryConfiguration]Returns the destination, format and type of the logs. NotificationConfiguration => Paws::ElastiCache::NotificationConfigurationDescribes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS). NumCacheNodes => IntThe 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. PendingModifiedValues => Paws::ElastiCache::PendingModifiedValuesPreferredAvailabilityZone => StrThe name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones. PreferredMaintenanceWindow => StrSpecifies 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:
Example: "sun:23:00-mon:01:30" PreferredOutpostArn => StrThe outpost ARN in which the cache cluster is created. ReplicationGroupId => StrThe replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group. ReplicationGroupLogDeliveryEnabled => BoolA boolean value indicating whether log delivery is enabled for the replication group. SecurityGroups => ArrayRef[Paws::ElastiCache::SecurityGroupMembership]A list of VPC Security Groups associated with the cluster. SnapshotRetentionLimit => IntThe 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. SnapshotWindow => StrThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: "05:00-09:00" TransitEncryptionEnabled => BoolA 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" SEE ALSOThis class forms part of Paws, describing an object used in Paws::ElastiCache BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|