ClusterState class
Input properties used for looking up and filtering Cluster resources.
Constructors
-
ClusterState({Input<
bool?> ? applyImmediately, Input<String?> ? arn, Input<String?> ? autoMinorVersionUpgrade, Input<String?> ? availabilityZone, Input<String?> ? azMode, Input<List< ? cacheNodes, Input<ClusterCacheNode> ?>String?> ? clusterAddress, Input<String?> ? clusterId, Input<String?> ? configurationEndpoint, Input<String?> ? engine, Input<String?> ? engineVersion, Input<String?> ? engineVersionActual, Input<String?> ? finalSnapshotIdentifier, Input<String?> ? ipDiscovery, Input<List< ? logDeliveryConfigurations, Input<ClusterLogDeliveryConfiguration> ?>String?> ? maintenanceWindow, Input<String?> ? networkType, Input<String?> ? nodeType, Input<String?> ? notificationTopicArn, Input<int?> ? numCacheNodes, Input<String?> ? outpostMode, Input<String?> ? parameterGroupName, Input<int?> ? port, Input<List< ? preferredAvailabilityZones, Input<String> ?>String?> ? preferredOutpostArn, Input<String?> ? region, Input<String?> ? replicationGroupId, Input<List< ? securityGroupIds, Input<String> ?>String?> ? snapshotArns, Input<String?> ? snapshotName, Input<int?> ? snapshotRetentionLimit, Input<String?> ? snapshotWindow, Input<String?> ? subnetGroupName, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>bool?> ? transitEncryptionEnabled}) -
Creates a new ClusterState.
applyImmediatelyWhether any database modifications are applied immediately, or during the next maintenance window. Default isfalse. See Amazon ElastiCache Documentation for more information.arnThe ARN of the created ElastiCache Cluster.autoMinorVersionUpgradeSpecifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window.availabilityZoneAvailability Zone for the cache cluster. If you want to create cache nodes in multi-az, usepreferredAvailabilityZonesinstead. Default: System chosen Availability Zone. Changing this value will re-create the resource.azModeWhether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter aresingle-azorcross-az, default issingle-az. If you want to choosecross-az,numCacheNodesmust be greater than1.cacheNodesList of node objects includingid,address,portandavailabilityZone.clusterAddress(Memcached only) DNS name of the cache cluster without the port appended.clusterIdGroup identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.configurationEndpoint(Memcached only) Configuration endpoint to allow host discovery.engineName of the cache engine to be used for this cache cluster. Valid values arememcached,redis.engineVersionVersion number of the cache engine to be used.engineVersionActualBecause ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.finalSnapshotIdentifierName of your final cluster snapshot. If omitted, no final snapshot will be made.ipDiscoveryThe IP version to advertise in the discovery protocol. Valid values areipv4oripv6.logDeliveryConfigurationsSpecifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.maintenanceWindowSpecifies the weekly time range for when maintenancenetworkTypeThe IP versions for cache cluster connections. IPv6 is supported with Redis engine6.2onword or Memcached version1.6.6for all Nitro system instances. Valid values areipv4,ipv6ordualStack.nodeTypeThe instance class used.notificationTopicArnARN of an SNS topic to send ElastiCache notifications to. Example:arn:aws:sns:us-east-1:012345678999:my_sns_topic.numCacheNodesThe initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed.outpostModeSpecify the outpost mode that will apply to the cache cluster creation. Valid values are"single-outpost"and"cross-outpost", however AWS currently only supports"single-outpost"mode.parameterGroupNameThe name of the parameter group to associate with this cache cluster.portThe port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided withreplicationGroupId. Changing this value will re-create the resource.preferredAvailabilityZonesList of the Availability Zones in which cache nodes are created. If you are creating your cluster in an Amazon VPC you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value ofnumCacheNodes. If you want all the nodes in the same Availability Zone, useavailabilityZoneinstead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones. Detecting drift of existing node availability zone is not currently supported. Updating this argument by itself to migrate existing node availability zones is not currently supported and will show a perpetual difference.preferredOutpostArnThe outpost ARN in which the cache cluster will be created.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.replicationGroupIdID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.securityGroupIdsOne or more VPC security groups associated with the cache cluster. Cannot be provided withreplication_group_id.snapshotArnsSingle-element string list containing an ARN of a Redis RDB snapshot file stored in Amazon S3. The object name cannot contain any commas. ChangingsnapshotArnsforces a new resource.snapshotNameName of a snapshot from which to restore data into the new node group. ChangingsnapshotNameforces a new resource.snapshotRetentionLimitNumber of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting asnapshotRetentionLimitis not supported on cache.t1.micro cache nodessnapshotWindowDaily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00subnetGroupNameName of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided withreplication_group_id.tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.transitEncryptionEnabledEnable encryption in-transit. Supported only with Memcached versions1.6.12and later, running in a VPC. For Redis or Valkey transit encryption, useaws.elasticache.ReplicationGroupinstead. See the ElastiCache in-transit encryption documentation for more details.const -
ClusterState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
applyImmediately
→ Input<
bool?> ? -
Whether any database modifications are applied immediately, or during the next maintenance window. Default is
false. See Amazon ElastiCache Documentation for more information.final -
arn
→ Input<
String?> ? -
The ARN of the created ElastiCache Cluster.
final
-
autoMinorVersionUpgrade
→ Input<
String?> ? -
Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window.
Only supported for engine type
"redis"and if the engine version is 6 or higher. Defaults totrue.final -
availabilityZone
→ Input<
String?> ? -
Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use
preferredAvailabilityZonesinstead. Default: System chosen Availability Zone. Changing this value will re-create the resource.final -
azMode
→ Input<
String?> ? -
Whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter are
single-azorcross-az, default issingle-az. If you want to choosecross-az,numCacheNodesmust be greater than1.final -
cacheNodes
→ Input<
List< ?ClusterCacheNode> ?> -
List of node objects including
id,address,portandavailabilityZone.final -
clusterAddress
→ Input<
String?> ? -
(Memcached only) DNS name of the cache cluster without the port appended.
final
-
clusterId
→ Input<
String?> ? -
Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.
final
-
configurationEndpoint
→ Input<
String?> ? -
(Memcached only) Configuration endpoint to allow host discovery.
final
-
engine
→ Input<
String?> ? -
Name of the cache engine to be used for this cache cluster. Valid values are
memcached,redis.final -
engineVersion
→ Input<
String?> ? -
Version number of the cache engine to be used.
If not set, defaults to the latest version.
See Describe Cache Engine Versions in the AWS Documentation for supported versions.
When
engineisredisand the version is 7 or higher, the major and minor version should be set, e.g.,7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. Otherwise, specify the full version desired, e.g.,5.0.6. The actual engine version used is returned in the attributeengineVersionActual, see Attribute Reference below. Cannot be provided withreplication_group_id.final -
engineVersionActual
→ Input<
String?> ? -
Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
final
-
finalSnapshotIdentifier
→ Input<
String?> ? -
Name of your final cluster snapshot. If omitted, no final snapshot will be made.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
ipDiscovery
→ Input<
String?> ? -
The IP version to advertise in the discovery protocol. Valid values are
ipv4oripv6.final -
logDeliveryConfigurations
→ Input<
List< ?ClusterLogDeliveryConfiguration> ?> -
Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.
final
-
maintenanceWindow
→ Input<
String?> ? -
Specifies the weekly time range for when maintenance
on the cache cluster is performed. The format is
ddd:hh24:mi-ddd:hh24:mi(24H Clock UTC). The minimum maintenance window is a 60 minute period. Example:sun:05:00-sun:09:00.final -
networkType
→ Input<
String?> ? -
The IP versions for cache cluster connections. IPv6 is supported with Redis engine
6.2onword or Memcached version1.6.6for all Nitro system instances. Valid values areipv4,ipv6ordualStack.final -
nodeType
→ Input<
String?> ? -
The instance class used.
See AWS documentation for information on supported node types for Redis OSS and guidance on selecting node types for Redis OSS.
See AWS documentation for information on supported node types for Memcached and guidance on selecting node types for Memcached.
For Memcached, changing this value will re-create the resource.
final
-
notificationTopicArn
→ Input<
String?> ? -
ARN of an SNS topic to send ElastiCache notifications to. Example:
arn:aws:sns:us-east-1:012345678999:my_sns_topic.final -
numCacheNodes
→ Input<
int?> ? -
The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed.
final
-
outpostMode
→ Input<
String?> ? -
Specify the outpost mode that will apply to the cache cluster creation. Valid values are
"single-outpost"and"cross-outpost", however AWS currently only supports"single-outpost"mode.final -
parameterGroupName
→ Input<
String?> ? -
The name of the parameter group to associate with this cache cluster.
final
-
port
→ Input<
int?> ? -
The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with
replicationGroupId. Changing this value will re-create the resource.final -
preferredAvailabilityZones
→ Input<
List< ?String> ?> -
List of the Availability Zones in which cache nodes are created. If you are creating your cluster in an Amazon VPC you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of
numCacheNodes. If you want all the nodes in the same Availability Zone, useavailabilityZoneinstead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones. Detecting drift of existing node availability zone is not currently supported. Updating this argument by itself to migrate existing node availability zones is not currently supported and will show a perpetual difference.final -
preferredOutpostArn
→ Input<
String?> ? -
The outpost ARN in which the cache cluster will be created.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
replicationGroupId
→ Input<
String?> ? -
ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroupIds
→ Input<
List< ?String> ?> -
One or more VPC security groups associated with the cache cluster. Cannot be provided with
replication_group_id.final -
snapshotArns
→ Input<
String?> ? -
Single-element string list containing an ARN of a Redis RDB snapshot file stored in Amazon S3. The object name cannot contain any commas. Changing
snapshotArnsforces a new resource.final -
snapshotName
→ Input<
String?> ? -
Name of a snapshot from which to restore data into the new node group. Changing
snapshotNameforces a new resource.final -
snapshotRetentionLimit
→ Input<
int?> ? -
Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a
snapshotRetentionLimitis not supported on cache.t1.micro cache nodesfinal -
snapshotWindow
→ Input<
String?> ? -
Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00
final
-
subnetGroupName
→ Input<
String?> ? -
Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided with
replication_group_id.final -
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
transitEncryptionEnabled
→ Input<
bool?> ? -
Enable encryption in-transit. Supported only with Memcached versions
1.6.12and later, running in a VPC. For Redis or Valkey transit encryption, useaws.elasticache.ReplicationGroupinstead. See the ElastiCache in-transit encryption documentation for more details.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited