ReplicationGroupState class

Input properties used for looking up and filtering ReplicationGroup resources.

Constructors

ReplicationGroupState({Input<bool?>? applyImmediately, Input<String?>? arn, Input<bool?>? atRestEncryptionEnabled, Input<String?>? authToken, Input<String?>? authTokenUpdateStrategy, Input<String?>? authTokenWo, Input<int?>? authTokenWoVersion, Input<bool?>? autoMinorVersionUpgrade, Input<bool?>? automaticFailoverEnabled, Input<bool?>? clusterEnabled, Input<String?>? clusterMode, Input<String?>? configurationEndpointAddress, Input<bool?>? dataTieringEnabled, Input<String?>? description, Input<String?>? durability, Input<String?>? engine, Input<String?>? engineVersion, Input<String?>? engineVersionActual, Input<String?>? finalSnapshotIdentifier, Input<String?>? globalReplicationGroupId, Input<String?>? ipDiscovery, Input<String?>? kmsKeyId, Input<List<ReplicationGroupLogDeliveryConfiguration>?>? logDeliveryConfigurations, Input<String?>? maintenanceWindow, Input<List<String>?>? memberClusters, Input<bool?>? multiAzEnabled, Input<String?>? networkType, Input<List<ReplicationGroupNodeGroupConfiguration>?>? nodeGroupConfigurations, Input<String?>? nodeType, Input<String?>? notificationTopicArn, Input<int?>? numCacheClusters, Input<int?>? numNodeGroups, Input<String?>? parameterGroupName, Input<int?>? port, Input<List<String>?>? preferredCacheClusterAzs, Input<String?>? primaryEndpointAddress, Input<String?>? readerEndpointAddress, Input<String?>? region, Input<int?>? replicasPerNodeGroup, Input<String?>? replicationGroupId, Input<List<String>?>? securityGroupIds, Input<List<String>?>? securityGroupNames, Input<List<String>?>? snapshotArns, Input<String?>? snapshotName, Input<int?>? snapshotRetentionLimit, Input<String?>? snapshotWindow, Input<String?>? subnetGroupName, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<bool?>? transitEncryptionEnabled, Input<String?>? transitEncryptionMode, Input<List<String>?>? userGroupIds})
Creates a new ReplicationGroupState. applyImmediately Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. arn ARN of the created ElastiCache Replication Group. atRestEncryptionEnabled Whether to enable encryption at rest. authToken Password used to access a password protected server. Can be specified only if transitEncryptionEnabled = true. authTokenUpdateStrategy Strategy used when modifying authToken or authTokenWo on an existing replication group. Not used during initial create. Valid values are SET, ROTATE, and DELETE. If omitted during an auth token change, AWS defaults to ROTATE. If value is DELETE then authToken and authTokenWo must be omitted. authTokenWo NOTE: This field is write-only and its value will not be updated in state as part of read operations. authTokenWoVersion Integer that, when changed, triggers a re-send of authTokenWo to the replication group. Requires authTokenWo. autoMinorVersionUpgrade Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. automaticFailoverEnabled Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If enabled, numCacheClusters must be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to false. clusterEnabled Indicates if cluster mode is enabled. clusterMode Specifies whether cluster mode is enabled or disabled. Valid values are enabled or disabled or compatible configurationEndpointAddress Address of the replication group configuration endpoint when cluster mode is enabled. dataTieringEnabled Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. description User-created description for the replication group. Must not be empty. durability Specifies the durability mode for the replication group. Valid values are default, async, sync, or disabled. Requires cluster mode enabled and Valkey 9.0 or higher. engine Name of the cache engine to be used for the clusters in this replication group. engineVersion Version number of the cache engine to be used for the cache clusters in this replication group. engineVersionActual Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine. finalSnapshotIdentifier The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made. globalReplicationGroupId The ID of the global replication group to which this replication group should belong. If this parameter is specified, the replication group is added to the specified global replication group as a secondary replication group; otherwise, the replication group is not part of any global replication group. If globalReplicationGroupId is set, the numNodeGroups parameter cannot be set. ipDiscovery The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6. kmsKeyId The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if atRestEncryptionEnabled = true. logDeliveryConfigurations Specifies the destination and format of Redis OSS/Valkey SLOWLOG or Redis OSS/Valkey 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 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 memberClusters Identifiers of all the nodes that are part of this replication group. multiAzEnabled Specifies whether to enable Multi-AZ Support for the replication group. networkType The IP versions for cache cluster connections. Valid values are ipv4, ipv6 or dualStack. nodeGroupConfigurations Configuration block for node groups (shards). Can be specified only if numNodeGroups is set. Conflicts with preferredCacheClusterAzs. See Node Group Configuration below for more details. nodeType Instance class to be used. notificationTopicArn ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic numCacheClusters Number of cache clusters (primary and replicas) this replication group will have. numNodeGroups Number of node groups (shards) for this Redis replication group. parameterGroupName Name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter cluster-enabled set to true. port Port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. preferredCacheClusterAzs List of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is considered. The first item in the list will be the primary node. Ignored when updating. primaryEndpointAddress (Redis only) Address of the endpoint for the primary node in the replication group, if the cluster mode is disabled. readerEndpointAddress (Redis only) Address of the endpoint for the reader node in the replication group, if the cluster mode is disabled. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replicasPerNodeGroup Number of replica nodes in each node group. replicationGroupId Replication group identifier. This parameter is stored as a lowercase string. securityGroupIds IDs of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in a VPC. securityGroupNames Names of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in a VPC. snapshotArns List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas. snapshotName Name of a snapshot from which to restore data into the new node group. Changing the 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. The minimum snapshot window is a 60 minute period. Example: 05:00-09:00 subnetGroupName Name of the cache subnet group to be used for the replication group. tags Map of tags to assign to the resource. Adding tags to this resource will add or overwrite any existing tags on the clusters in the replication group and not to the group itself. 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 Whether to enable encryption in transit. transitEncryptionMode A setting that enables clients to migrate to in-transit encryption with no downtime. userGroupIds User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. NOTE: This argument is a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.
const
ReplicationGroupState.fromMap(Map<String, dynamic> map)
factory

Properties

applyImmediately → Input<bool?>?
Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false.
final
arn → Input<String?>?
ARN of the created ElastiCache Replication Group.
final
atRestEncryptionEnabled → Input<bool?>?
Whether to enable encryption at rest. When engine is redis, default is false. When engine is valkey, default is true.
final
authToken → Input<String?>?
Password used to access a password protected server. Can be specified only if transitEncryptionEnabled = true.
final
authTokenUpdateStrategy → Input<String?>?
Strategy used when modifying authToken or authTokenWo on an existing replication group. Not used during initial create. Valid values are SET, ROTATE, and DELETE. If omitted during an auth token change, AWS defaults to ROTATE. If value is DELETE then authToken and authTokenWo must be omitted.
final
authTokenWo → Input<String?>?
NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password used to access a password protected server, whose value will not be stored in state. Can be specified only if transitEncryptionEnabled = true. Conflicts with authToken. Requires authTokenWoVersion.
final
authTokenWoVersion → Input<int?>?
Integer that, when changed, triggers a re-send of authTokenWo to the replication group. Requires authTokenWo.
final
automaticFailoverEnabled → Input<bool?>?
Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If enabled, numCacheClusters must be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to false.
final
autoMinorVersionUpgrade → Input<bool?>?
Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Only supported for engine types "redis" and "valkey" and if the engine version is 6 or higher. Defaults to true.
final
clusterEnabled → Input<bool?>?
Indicates if cluster mode is enabled.
final
clusterMode → Input<String?>?
Specifies whether cluster mode is enabled or disabled. Valid values are enabled or disabled or compatible
final
configurationEndpointAddress → Input<String?>?
Address of the replication group configuration endpoint when cluster mode is enabled.
final
dataTieringEnabled → Input<bool?>?
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.
final
description → Input<String?>?
User-created description for the replication group. Must not be empty.
final
durability → Input<String?>?
Specifies the durability mode for the replication group. Valid values are default, async, sync, or disabled. Requires cluster mode enabled and Valkey 9.0 or higher.
final
engine → Input<String?>?
Name of the cache engine to be used for the clusters in this replication group. Valid values are redis or valkey. Default is redis.
final
engineVersion → Input<String?>?
Version number of the cache engine to be used for the cache clusters in this replication group. If the version is 7 or higher, the major and minor version should be set, e.g., 7.2. If 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 attribute engineVersionActual, see Attribute Reference below.
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?>?
The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made.
final
globalReplicationGroupId → Input<String?>?
The ID of the global replication group to which this replication group should belong. If this parameter is specified, the replication group is added to the specified global replication group as a secondary replication group; otherwise, the replication group is not part of any global replication group. If globalReplicationGroupId is set, the numNodeGroups parameter cannot be set.
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 ipv4 or ipv6.
final
kmsKeyId → Input<String?>?
The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if atRestEncryptionEnabled = true.
final
logDeliveryConfigurations → Input<List<ReplicationGroupLogDeliveryConfiguration>?>?
Specifies the destination and format of Redis OSS/Valkey SLOWLOG or Redis OSS/Valkey 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
memberClusters → Input<List<String>?>?
Identifiers of all the nodes that are part of this replication group.
final
multiAzEnabled → Input<bool?>?
Specifies whether to enable Multi-AZ Support for the replication group. If true, automaticFailoverEnabled must also be enabled. Defaults to false.
final
networkType → Input<String?>?
The IP versions for cache cluster connections. Valid values are ipv4, ipv6 or dualStack.
final
nodeGroupConfigurations → Input<List<ReplicationGroupNodeGroupConfiguration>?>?
Configuration block for node groups (shards). Can be specified only if numNodeGroups is set. Conflicts with preferredCacheClusterAzs. See Node Group Configuration below for more details.
final
nodeType → Input<String?>?
Instance class to be used. See AWS documentation for information on supported node types and guidance on selecting node types. Required unless globalReplicationGroupId is set. Cannot be set if globalReplicationGroupId is set.
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
numCacheClusters → Input<int?>?
Number of cache clusters (primary and replicas) this replication group will have. If automaticFailoverEnabled or multiAzEnabled are true, must be at least 2. Updates will occur before other modifications. Conflicts with numNodeGroups and replicasPerNodeGroup. Defaults to 1.
final
numNodeGroups → Input<int?>?
Number of node groups (shards) for this Redis replication group. Changing this number will trigger a resizing operation before other settings modifications. Conflicts with numCacheClusters.
final
parameterGroupName → Input<String?>?
Name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter cluster-enabled set to true.
final
port → Input<int?>?
Port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379.
final
preferredCacheClusterAzs → Input<List<String>?>?
List of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is considered. The first item in the list will be the primary node. Ignored when updating.
final
primaryEndpointAddress → Input<String?>?
(Redis only) Address of the endpoint for the primary node in the replication group, if the cluster mode is disabled.
final
readerEndpointAddress → Input<String?>?
(Redis only) Address of the endpoint for the reader node in the replication group, if the cluster mode is disabled.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
replicasPerNodeGroup → Input<int?>?
Number of replica nodes in each node group. Changing this number will trigger a resizing operation before other settings modifications. Default AWS limit is 5. Higher values may be available with a quota increase. Conflicts with numCacheClusters. Can only be set if numNodeGroups is set.
final
replicationGroupId → Input<String?>?
Replication group identifier. This parameter is stored as a lowercase string.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIds → Input<List<String>?>?
IDs of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in a VPC.
final
securityGroupNames → Input<List<String>?>?
Names of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in a VPC.
final
snapshotArns → Input<List<String>?>?
List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas.
final
snapshotName → Input<String?>?
Name of a snapshot from which to restore data into the new node group. Changing the snapshotName forces 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 snapshotRetentionLimit is not supported on cache.t1.micro cache nodes
final
snapshotWindow → Input<String?>?
Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: 05:00-09:00
final
subnetGroupName → Input<String?>?
Name of the cache subnet group to be used for the replication group.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. Adding tags to this resource will add or overwrite any existing tags on the clusters in the replication group and not to the group itself. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
transitEncryptionEnabled → Input<bool?>?
Whether to enable encryption in transit. Changing this argument with an engineVersion < 7.0.5 will force a replacement. Engine versions prior to 7.0.5 only allow this transit encryption to be configured during creation of the replication group.
final
transitEncryptionMode → Input<String?>?
A setting that enables clients to migrate to in-transit encryption with no downtime. Valid values are preferred and required. When enabling encryption on an existing replication group, this must first be set to preferred before setting it to required in a subsequent apply. See the TransitEncryptionMode field in the CreateReplicationGroup API documentation for additional details.
final
userGroupIds → Input<List<String>?>?
User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. NOTE: This argument is a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.
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