CacheCluster class
Contains all of the attributes of a specific cluster.
Constructors
-
CacheCluster({String? arn, bool? atRestEncryptionEnabled, bool? authTokenEnabled, DateTime? authTokenLastModifiedDate, bool? autoMinorVersionUpgrade, DateTime? cacheClusterCreateTime, String? cacheClusterId, String? cacheClusterStatus, String? cacheNodeType, List<
CacheNode> ? cacheNodes, CacheParameterGroupStatus? cacheParameterGroup, List<CacheSecurityGroupMembership> ? cacheSecurityGroups, String? cacheSubnetGroupName, String? clientDownloadLandingPage, Endpoint? configurationEndpoint, String? engine, String? engineVersion, NotificationConfiguration? notificationConfiguration, int? numCacheNodes, PendingModifiedValues? pendingModifiedValues, String? preferredAvailabilityZone, String? preferredMaintenanceWindow, String? preferredOutpostArn, String? replicationGroupId, List<SecurityGroupMembership> ? securityGroups, int? snapshotRetentionLimit, String? snapshotWindow, bool? transitEncryptionEnabled}) - CacheCluster.fromXml(XmlElement elem)
-
factory
Properties
- arn → String?
-
The ARN (Amazon Resource Name) of the cache cluster.
final
- atRestEncryptionEnabled → bool?
-
A flag that enables encryption at-rest when set to
true
.final - authTokenEnabled → bool?
-
A flag that enables using an
AuthToken
(password) when issuing Redis commands.final - authTokenLastModifiedDate → DateTime?
-
The date the auth token was last modified
final
- autoMinorVersionUpgrade → bool?
-
This parameter is currently disabled.
final
- cacheClusterCreateTime → DateTime?
-
The date and time when the cluster was created.
final
- cacheClusterId → String?
-
The user-supplied identifier of the cluster. This identifier is a unique key
that identifies a cluster.
final
- cacheClusterStatus → String?
-
The current state of this cluster, one of the following values:
available
,creating
,deleted
,deleting
,incompatible-network
,modifying
,rebooting cluster nodes
,restore-failed
, orsnapshotting
.final -
cacheNodes
→ List<
CacheNode> ? -
A list of cache nodes that are members of the cluster.
final
- cacheNodeType → String?
-
The name of the compute and memory capacity node type for the cluster.
final
- cacheParameterGroup → CacheParameterGroupStatus?
-
Status of the cache parameter group.
final
-
cacheSecurityGroups
→ List<
CacheSecurityGroupMembership> ? -
A list of cache security group elements, composed of name and status
sub-elements.
final
- cacheSubnetGroupName → String?
-
The name of the cache subnet group associated with the cluster.
final
- clientDownloadLandingPage → String?
-
The URL of the web page where you can download the latest ElastiCache client
library.
final
- configurationEndpoint → 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
.cfg
in it.final - engine → String?
-
The name of the cache engine (
memcached
orredis
) to be used for this cluster.final - engineVersion → String?
-
The version of the cache engine that is used in this cluster.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- notificationConfiguration → NotificationConfiguration?
-
Describes a notification topic and its status. Notification topics are used
for publishing ElastiCache events to subscribers using Amazon Simple
Notification Service (SNS).
final
- numCacheNodes → int?
-
The number of cache nodes in the cluster.
final
- pendingModifiedValues → PendingModifiedValues?
-
final
- preferredAvailabilityZone → String?
-
The name of the Availability Zone in which the cluster is located or
"Multiple" if the cache nodes are located in different Availability Zones.
final
- preferredMaintenanceWindow → String?
-
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.
final
- preferredOutpostArn → String?
-
The outpost ARN in which the cache cluster is created.
final
- replicationGroupId → String?
-
The replication group to which this cluster belongs. If this field is empty,
the cluster is not associated with any replication group.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroups
→ List<
SecurityGroupMembership> ? -
A list of VPC Security Groups associated with the cluster.
final
- snapshotRetentionLimit → int?
-
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.final - snapshotWindow → String?
-
The daily time range (in UTC) during which ElastiCache begins taking a daily
snapshot of your cluster.
final
- transitEncryptionEnabled → bool?
-
A flag that enables in-transit encryption when set to
true
.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited