GlobalReplicationGroupArgs class
The set of arguments for GlobalReplicationGroup. The set of arguments for GlobalReplicationGroup.
Constructors
-
GlobalReplicationGroupArgs({Input<
bool?> ? automaticFailoverEnabled, Input<String?> ? cacheNodeType, Input<String?> ? engine, Input<String?> ? engineVersion, Input<String?> ? globalReplicationGroupDescription, required Input<String> globalReplicationGroupIdSuffix, Input<int?> ? numNodeGroups, Input<String?> ? parameterGroupName, required Input<String> primaryReplicationGroupId, Input<String?> ? region}) -
Creates a new GlobalReplicationGroupArgs.
automaticFailoverEnabledSpecifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails.cacheNodeTypeThe instance class used.engineThe name of the cache engine to be used for the clusters in this global replication group.engineVersionEngine version to use for the Global Replication Group.globalReplicationGroupDescriptionA user-created description for the global replication group.globalReplicationGroupIdSuffixThe suffix name of a Global Datastore. IfglobalReplicationGroupIdSuffixis changed, creates a new resource.numNodeGroupsThe number of node groups (shards) on the global replication group.parameterGroupNameAn ElastiCache Parameter Group to use for the Global Replication Group.primaryReplicationGroupIdThe ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. IfprimaryReplicationGroupIdis changed, creates a new resource.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.const -
GlobalReplicationGroupArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
automaticFailoverEnabled
→ Input<
bool?> ? -
Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails.
When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
final
-
cacheNodeType
→ Input<
String?> ? -
The instance class used.
See AWS documentation for information on supported node types
and guidance on selecting node types.
When creating, by default the Global Replication Group inherits the node type of the primary replication group.
final
-
engine
→ Input<
String?> ? -
The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengineVersionis specified.final -
engineVersion
→ Input<
String?> ? -
Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When 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. The actual engine version used is returned in the attributeengineVersionActual, see Attribute Reference below.final -
globalReplicationGroupDescription
→ Input<
String?> ? -
A user-created description for the global replication group.
final
-
globalReplicationGroupIdSuffix
→ Input<
String> -
The suffix name of a Global Datastore. If
globalReplicationGroupIdSuffixis changed, creates a new resource.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
numNodeGroups
→ Input<
int?> ? -
The number of node groups (shards) on the global replication group.
final
-
parameterGroupName
→ Input<
String?> ? -
An ElastiCache Parameter Group to use for the Global Replication Group.
Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete.
Specifying without a major version upgrade will fail.
Note that ElastiCache creates a copy of this parameter group for each member replication group.
final
-
primaryReplicationGroupId
→ Input<
String> -
The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primaryReplicationGroupIdis changed, creates a new resource.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
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