Interface ICfnGlobalReplicationGroupProps

Properties for defining a CfnGlobalReplicationGroup.

Namespace: Amazon.CDK.AWS.ElastiCache

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnGlobalReplicationGroupProps

Syntax (vb)

Public Interface ICfnGlobalReplicationGroupProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ElastiCache;

             var cfnGlobalReplicationGroupProps = new CfnGlobalReplicationGroupProps {
                 Members = new [] { new GlobalReplicationGroupMemberProperty {
                     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 = new [] { new RegionalConfigurationProperty {
                     ReplicationGroupId = "replicationGroupId",
                     ReplicationGroupRegion = "replicationGroupRegion",
                     ReshardingConfigurations = new [] { new ReshardingConfigurationProperty {
                         NodeGroupId = "nodeGroupId",
                         PreferredAvailabilityZones = new [] { "preferredAvailabilityZones" }
                     } }
                 } }
             };

Synopsis

Properties

AutomaticFailoverEnabled	Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
CacheNodeType	The cache node type of the Global datastore.
CacheParameterGroupName	The name of the cache parameter group to use with the Global datastore.
Engine	The ElastiCache engine.
EngineVersion	The Elasticache Valkey or Redis OSS engine version.
GlobalNodeGroupCount	The number of node groups that comprise the Global Datastore.
GlobalReplicationGroupDescription	The optional description of the Global datastore.
GlobalReplicationGroupIdSuffix	The suffix name of a Global Datastore.
Members	The replication groups that comprise the Global datastore.
RegionalConfigurations	The Regions that comprise the Global Datastore.

Properties

AutomaticFailoverEnabled

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

object? AutomaticFailoverEnabled { get; }

Property Value

object

Remarks

AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-automaticfailoverenabled

Type union: either bool or IResolvable

CacheNodeType

The cache node type of the Global datastore.

string? CacheNodeType { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cachenodetype

CacheParameterGroupName

The name of the cache parameter group to use with the Global datastore.

string? CacheParameterGroupName { get; }

Property Value

string

Remarks

It must be compatible with the major engine version used by the Global datastore.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cacheparametergroupname

Engine

The ElastiCache engine.

string? Engine { get; }

Property Value

string

Remarks

For Valkey or Redis OSS only.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engine

EngineVersion

The Elasticache Valkey or Redis OSS engine version.

string? EngineVersion { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engineversion

GlobalNodeGroupCount

The number of node groups that comprise the Global Datastore.

double? GlobalNodeGroupCount { get; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalnodegroupcount

GlobalReplicationGroupDescription

The optional description of the Global datastore.

string? GlobalReplicationGroupDescription { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupdescription

GlobalReplicationGroupIdSuffix

The suffix name of a Global Datastore.

string? GlobalReplicationGroupIdSuffix { get; }

Property Value

string

Remarks

The suffix guarantees uniqueness of the Global Datastore name across multiple regions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupidsuffix

Members

The replication groups that comprise the Global datastore.

object Members { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-members

Type union: either IResolvable or (either IResolvable or CfnGlobalReplicationGroup.IGlobalReplicationGroupMemberProperty)[]

RegionalConfigurations

The Regions that comprise the Global Datastore.

object? RegionalConfigurations { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-regionalconfigurations

Type union: either IResolvable or (either IResolvable or CfnGlobalReplicationGroup.IRegionalConfigurationProperty)[]