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< ? logDeliveryConfigurations, Input<ReplicationGroupLogDeliveryConfiguration> ?>String?> ? maintenanceWindow, Input<List< ? memberClusters, Input<String> ?>bool?> ? multiAzEnabled, Input<String?> ? networkType, Input<List< ? nodeGroupConfigurations, Input<ReplicationGroupNodeGroupConfiguration> ?>String?> ? nodeType, Input<String?> ? notificationTopicArn, Input<int?> ? numCacheClusters, Input<int?> ? numNodeGroups, Input<String?> ? parameterGroupName, Input<int?> ? port, Input<List< ? preferredCacheClusterAzs, Input<String> ?>String?> ? primaryEndpointAddress, Input<String?> ? readerEndpointAddress, Input<String?> ? region, Input<int?> ? replicasPerNodeGroup, Input<String?> ? replicationGroupId, Input<List< ? securityGroupIds, Input<String> ?>List< ? securityGroupNames, Input<String> ?>List< ? snapshotArns, Input<String> ?>String?> ? snapshotName, Input<int?> ? snapshotRetentionLimit, Input<String?> ? snapshotWindow, Input<String?> ? subnetGroupName, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>bool?> ? transitEncryptionEnabled, Input<String?> ? transitEncryptionMode, Input<List< ? userGroupIds})String> ?> -
Creates a new ReplicationGroupState.
applyImmediatelySpecifies whether any modifications are applied immediately, or during the next maintenance window. Default isfalse.arnARN of the created ElastiCache Replication Group.atRestEncryptionEnabledWhether to enable encryption at rest.authTokenPassword used to access a password protected server. Can be specified only iftransitEncryptionEnabled = true.authTokenUpdateStrategyStrategy used when modifyingauthTokenorauthTokenWoon an existing replication group. Not used during initial create. Valid values areSET,ROTATE, andDELETE. If omitted during an auth token change, AWS defaults toROTATE. If value isDELETEthenauthTokenandauthTokenWomust be omitted.authTokenWoNOTE: This field is write-only and its value will not be updated in state as part of read operations.authTokenWoVersionInteger that, when changed, triggers a re-send ofauthTokenWoto the replication group. RequiresauthTokenWo.autoMinorVersionUpgradeSpecifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window.automaticFailoverEnabledSpecifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If enabled,numCacheClustersmust be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults tofalse.clusterEnabledIndicates if cluster mode is enabled.clusterModeSpecifies whether cluster mode is enabled or disabled. Valid values areenabledordisabledorcompatibleconfigurationEndpointAddressAddress of the replication group configuration endpoint when cluster mode is enabled.dataTieringEnabledEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set totruewhen using r6gd nodes.descriptionUser-created description for the replication group. Must not be empty.durabilitySpecifies the durability mode for the replication group. Valid values aredefault,async,sync, ordisabled. Requires cluster mode enabled and Valkey 9.0 or higher.engineName of the cache engine to be used for the clusters in this replication group.engineVersionVersion number of the cache engine to be used for the cache clusters in this replication group.engineVersionActualBecause ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.finalSnapshotIdentifierThe 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.globalReplicationGroupIdThe 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. IfglobalReplicationGroupIdis set, thenumNodeGroupsparameter cannot be set.ipDiscoveryThe IP version to advertise in the discovery protocol. Valid values areipv4oripv6.kmsKeyIdThe ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only ifatRestEncryptionEnabled = true.logDeliveryConfigurationsSpecifies 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.maintenanceWindowSpecifies the weekly time range for when maintenance on the cache cluster is performed. The format isddd:hh24:mi-ddd:hh24:mi(24H Clock UTC). The minimum maintenance window is a 60 minute period. Example:sun:05:00-sun:09:00memberClustersIdentifiers of all the nodes that are part of this replication group.multiAzEnabledSpecifies whether to enable Multi-AZ Support for the replication group.networkTypeThe IP versions for cache cluster connections. Valid values areipv4,ipv6ordualStack.nodeGroupConfigurationsConfiguration block for node groups (shards). Can be specified only ifnumNodeGroupsis set. Conflicts withpreferredCacheClusterAzs. See Node Group Configuration below for more details.nodeTypeInstance class to be used.notificationTopicArnARN of an SNS topic to send ElastiCache notifications to. Example:arn:aws:sns:us-east-1:012345678999:my_sns_topicnumCacheClustersNumber of cache clusters (primary and replicas) this replication group will have.numNodeGroupsNumber of node groups (shards) for this Redis replication group.parameterGroupNameName 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 parametercluster-enabledset to true.portPort 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.preferredCacheClusterAzsList 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.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.replicasPerNodeGroupNumber of replica nodes in each node group.replicationGroupIdReplication group identifier. This parameter is stored as a lowercase string.securityGroupIdsIDs 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.securityGroupNamesNames 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.snapshotArnsList of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas.snapshotNameName of a snapshot from which to restore data into the new node group. Changing thesnapshotNameforces 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 ofsnapshotRetentionLimitis 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. The minimum snapshot window is a 60 minute period. Example:05:00-09:00subnetGroupNameName of the cache subnet group to be used for the replication group.tagsMap 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 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.transitEncryptionEnabledWhether to enable encryption in transit.transitEncryptionModeA setting that enables clients to migrate to in-transit encryption with no downtime.userGroupIdsUser 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
engineisredis, default isfalse. Whenengineisvalkey, default istrue.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
authTokenorauthTokenWoon an existing replication group. Not used during initial create. Valid values areSET,ROTATE, andDELETE. If omitted during an auth token change, AWS defaults toROTATE. If value isDELETEthenauthTokenandauthTokenWomust 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 withauthToken. RequiresauthTokenWoVersion.final -
authTokenWoVersion
→ Input<
int?> ? -
Integer that, when changed, triggers a re-send of
authTokenWoto the replication group. RequiresauthTokenWo.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,
numCacheClustersmust be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults tofalse.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 totrue.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
enabledordisabledorcompatiblefinal -
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
truewhen 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, ordisabled. 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
redisorvalkey. Default isredis.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 attributeengineVersionActual, 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
globalReplicationGroupIdis set, thenumNodeGroupsparameter 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
ipv4oripv6.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:00final -
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,automaticFailoverEnabledmust also be enabled. Defaults tofalse.final -
networkType
→ Input<
String?> ? -
The IP versions for cache cluster connections. Valid values are
ipv4,ipv6ordualStack.final -
nodeGroupConfigurations
→ Input<
List< ?ReplicationGroupNodeGroupConfiguration> ?> -
Configuration block for node groups (shards). Can be specified only if
numNodeGroupsis set. Conflicts withpreferredCacheClusterAzs. 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
globalReplicationGroupIdis set. Cannot be set ifglobalReplicationGroupIdis 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_topicfinal -
numCacheClusters
→ Input<
int?> ? -
Number of cache clusters (primary and replicas) this replication group will have.
If
automaticFailoverEnabledormultiAzEnabledaretrue, must be at least 2. Updates will occur before other modifications. Conflicts withnumNodeGroupsandreplicasPerNodeGroup. Defaults to1.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-enabledset 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 ifnumNodeGroupsis 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
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
snapshotRetentionLimitis set to zero (0), backups are turned off. Please note that setting asnapshotRetentionLimitis 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. The minimum snapshot window is a 60 minute period. Example:
05:00-09:00final -
subnetGroupName
→ Input<
String?> ? -
Name of the cache subnet group to be used for the replication group.
final
-
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
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?> ? -
Whether to enable encryption in transit.
Changing this argument with an
engineVersion<7.0.5will force a replacement. Engine versions prior to7.0.5only 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
preferredandrequired. When enabling encryption on an existing replication group, this must first be set topreferredbefore setting it torequiredin a subsequent apply. See theTransitEncryptionModefield in theCreateReplicationGroupAPI 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