AWS CDK

2.233.0

interface CfnGlobalReplicationGroupMixinProps

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.ElastiCache.Mixins.CfnGlobalReplicationGroupMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awselasticache/mixins#CfnGlobalReplicationGroupMixinProps`
Java	`software.amazon.awscdk.mixins.preview.services.elasticache.mixins.CfnGlobalReplicationGroupMixinProps`
Python	`aws_cdk.mixins_preview.aws_elasticache.mixins.CfnGlobalReplicationGroupMixinProps`
TypeScript	`@aws-cdk/mixins-preview` » `aws_elasticache` » `mixins` » `CfnGlobalReplicationGroupMixinProps`

Properties for CfnGlobalReplicationGroupPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as elasticache_mixins } from '@aws-cdk/mixins-preview/aws-elasticache';
const cfnGlobalReplicationGroupMixinProps: elasticache_mixins.CfnGlobalReplicationGroupMixinProps = {
  automaticFailoverEnabled: false,
  cacheNodeType: 'cacheNodeType',
  cacheParameterGroupName: 'cacheParameterGroupName',
  engine: 'engine',
  engineVersion: 'engineVersion',
  globalNodeGroupCount: 123,
  globalReplicationGroupDescription: 'globalReplicationGroupDescription',
  globalReplicationGroupIdSuffix: 'globalReplicationGroupIdSuffix',
  members: [{
    replicationGroupId: 'replicationGroupId',
    replicationGroupRegion: 'replicationGroupRegion',
    role: 'role',
  }],
  regionalConfigurations: [{
    replicationGroupId: 'replicationGroupId',
    replicationGroupRegion: 'replicationGroupRegion',
    reshardingConfigurations: [{
      nodeGroupId: 'nodeGroupId',
      preferredAvailabilityZones: ['preferredAvailabilityZones'],
    }],
  }],
};

Properties

Name	Type	Description
automaticFailoverEnabled?	`boolean \|` `IResolvable`	Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
cacheNodeType?	`string`	The cache node type of the Global datastore.
cacheParameterGroupName?	`string`	The name of the cache parameter group to use with the Global datastore.
engine?	`string`	The ElastiCache engine.
engineVersion?	`string`	The Elasticache Valkey or Redis OSS engine version.
globalNodeGroupCount?	`number`	The number of node groups that comprise the Global Datastore.
globalReplicationGroupDescription?	`string`	The optional description of the Global datastore.
globalReplicationGroupIdSuffix?	`string`	The suffix name of a Global Datastore.
members?	`IResolvable` `\| (IResolvable` `\|` `GlobalReplicationGroupMemberProperty)[]`	The replication groups that comprise the Global datastore.
regionalConfigurations?	`IResolvable` `\| (IResolvable` `\|` `RegionalConfigurationProperty)[]`	The Regions that comprise the Global Datastore.

automaticFailoverEnabled?

Type: boolean | IResolvable (optional)

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.

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

cacheNodeType?

Type: string (optional)

The cache node type of the Global datastore.

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

cacheParameterGroupName?

Type: string (optional)

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.

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

engine?

Type: string (optional)

The ElastiCache engine.

For Valkey or Redis OSS only.

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

engineVersion?

Type: string (optional)

The Elasticache Valkey or Redis OSS engine version.

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

globalNodeGroupCount?

Type: number (optional)

The number of node groups that comprise the Global Datastore.

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

globalReplicationGroupDescription?

Type: string (optional)

The optional description of the Global datastore.

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

globalReplicationGroupIdSuffix?

Type: string (optional)

The suffix name of a Global Datastore.

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

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

members?

Type: IResolvable | (IResolvable | GlobalReplicationGroupMemberProperty)[] (optional)

The replication groups that comprise the Global datastore.

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

regionalConfigurations?

Type: IResolvable | (IResolvable | RegionalConfigurationProperty)[] (optional)

The Regions that comprise the Global Datastore.

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

← Previous Next →