ClusterState constructor
- Input<
bool?> ? applyImmediately, - Input<
String?> ? arn, - Input<
String?> ? autoMinorVersionUpgrade, - Input<
String?> ? availabilityZone, - Input<
String?> ? azMode, - Input<
List< ? cacheNodes,ClusterCacheNode> ?> - Input<
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,ClusterLogDeliveryConfiguration> ?> - Input<
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,String> ?> - Input<
String?> ? preferredOutpostArn, - Input<
String?> ? region, - Input<
String?> ? replicationGroupId, - Input<
List< ? securityGroupIds,String> ?> - Input<
String?> ? snapshotArns, - Input<
String?> ? snapshotName, - Input<
int?> ? snapshotRetentionLimit, - Input<
String?> ? snapshotWindow, - Input<
String?> ? subnetGroupName, - Input<
Map< ? tags,String, String> ?> - Input<
Map< ? tagsAll,String, String> ?> - Input<
bool?> ? transitEncryptionEnabled,
Creates a new ClusterState.
applyImmediately Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information.
arn The ARN of the created ElastiCache Cluster.
autoMinorVersionUpgrade Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window.
availabilityZone Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferredAvailabilityZones instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.
azMode 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-az or cross-az, default is single-az. If you want to choose cross-az, numCacheNodes must be greater than 1.
cacheNodes List of node objects including id, address, port and availabilityZone.
clusterAddress (Memcached only) DNS name of the cache cluster without the port appended.
clusterId Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.
configurationEndpoint (Memcached only) Configuration endpoint to allow host discovery.
engine Name of the cache engine to be used for this cache cluster. Valid values are memcached, redis.
engineVersion Version number of the cache engine to be used.
engineVersionActual Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
finalSnapshotIdentifier Name of your final cluster snapshot. If omitted, no final snapshot will be made.
ipDiscovery The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.
logDeliveryConfigurations 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.
maintenanceWindow Specifies the weekly time range for when maintenance
networkType The IP versions for cache cluster connections. IPv6 is supported with Redis engine 6.2 onword or Memcached version 1.6.6 for all Nitro system instances. Valid values are ipv4, ipv6 or dualStack.
nodeType The instance class used.
notificationTopicArn ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.
numCacheNodes 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.
outpostMode 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.
parameterGroupName The name of the parameter group to associate with this cache cluster.
port 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.
preferredAvailabilityZones 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, use availabilityZone instead, 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.
preferredOutpostArn The outpost ARN in which the cache cluster will be created.
region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
replicationGroupId 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.
securityGroupIds One or more VPC security groups associated with the cache cluster. Cannot be provided with replication_group_id.
snapshotArns 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 snapshotArns forces a new resource.
snapshotName Name of a snapshot from which to restore data into the new node group. Changing snapshotName forces a new resource.
snapshotRetentionLimit 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 snapshotRetentionLimit is not supported on cache.t1.micro cache nodes
snapshotWindow Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00
subnetGroupName 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.
tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
transitEncryptionEnabled Enable encryption in-transit. Supported only with Memcached versions 1.6.12 and later, running in a VPC. For Redis or Valkey transit encryption, use aws.elasticache.ReplicationGroup instead. See the ElastiCache in-transit encryption documentation for more details.
Implementation
const ClusterState({
this.applyImmediately,
this.arn,
this.autoMinorVersionUpgrade,
this.availabilityZone,
this.azMode,
this.cacheNodes,
this.clusterAddress,
this.clusterId,
this.configurationEndpoint,
this.engine,
this.engineVersion,
this.engineVersionActual,
this.finalSnapshotIdentifier,
this.ipDiscovery,
this.logDeliveryConfigurations,
this.maintenanceWindow,
this.networkType,
this.nodeType,
this.notificationTopicArn,
this.numCacheNodes,
this.outpostMode,
this.parameterGroupName,
this.port,
this.preferredAvailabilityZones,
this.preferredOutpostArn,
this.region,
this.replicationGroupId,
this.securityGroupIds,
this.snapshotArns,
this.snapshotName,
this.snapshotRetentionLimit,
this.snapshotWindow,
this.subnetGroupName,
this.tags,
this.tagsAll,
this.transitEncryptionEnabled,
});