CfnGlobalReplicationGroupProps Struct
Properties for defining a CfnGlobalReplicationGroup.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticache as elasticache } from 'aws-cdk-lib';
const cfnGlobalReplicationGroupProps: elasticache.CfnGlobalReplicationGroupProps = {
members: [{
replicationGroupId: 'replicationGroupId',
replicationGroupRegion: 'replicationGroupRegion',
role: 'role',
}],
// the properties below are optional
automaticFailoverEnabled: false,
cacheNodeType: 'cacheNodeType',
cacheParameterGroupName: 'cacheParameterGroupName',
engine: 'engine',
engineVersion: 'engineVersion',
globalNodeGroupCount: 123,
globalReplicationGroupDescription: 'globalReplicationGroupDescription',
globalReplicationGroupIdSuffix: 'globalReplicationGroupIdSuffix',
regionalConfigurations: [{
replicationGroupId: 'replicationGroupId',
replicationGroupRegion: 'replicationGroupRegion',
reshardingConfigurations: [{
nodeGroupId: 'nodeGroupId',
preferredAvailabilityZones: ['preferredAvailabilityZones'],
}],
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
automaticFailoverEnabledboolean | IResolvableautomatic_failover_enabledtyping.Union[bool, IResolvable]automaticFailoverEnabledBooleanAutomaticFailoverEnabledboolAutomaticFailoverEnabledinterface{}#Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.
The cache node type of the Global datastore.
cacheParameterGroupNamestringcache_parameter_group_namestrcacheParameterGroupNameStringCacheParameterGroupNamestringCacheParameterGroupName*string#The name of the cache parameter group to use with the Global datastore.
It must be compatible with the major engine version used by the Global datastore.
The ElastiCache engine.
For Valkey or Redis OSS only.
The Elasticache Valkey or Redis OSS engine version.
globalNodeGroupCountnumberglobal_node_group_countint | floatglobalNodeGroupCountNumberGlobalNodeGroupCountdoubleGlobalNodeGroupCount*float64#The number of node groups that comprise the Global Datastore.
globalReplicationGroupDescriptionstringglobal_replication_group_descriptionstrglobalReplicationGroupDescriptionStringGlobalReplicationGroupDescriptionstringGlobalReplicationGroupDescription*string#The optional description of the Global datastore.
globalReplicationGroupIdSuffixstringglobal_replication_group_id_suffixstrglobalReplicationGroupIdSuffixStringGlobalReplicationGroupIdSuffixstringGlobalReplicationGroupIdSuffix*string#The suffix name of a Global Datastore.
The suffix guarantees uniqueness of the Global Datastore name across multiple regions.
membersIResolvable | IResolvable | CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty[]memberstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, GlobalReplicationGroupMemberProperty]]]membersIResolvableMembersIResolvableMembersinterface{}required#The replication groups that comprise the Global datastore.
regionalConfigurationsIResolvable | IResolvable | CfnGlobalReplicationGroup.RegionalConfigurationProperty[]regional_configurationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RegionalConfigurationProperty]]]regionalConfigurationsIResolvableRegionalConfigurationsIResolvableRegionalConfigurationsinterface{}#The Regions that comprise the Global Datastore.