aws-cdk-lib.aws_elasticache.CfnGlobalReplicationGroupProps

interface CfnGlobalReplicationGroupProps

LanguageType name
.NETAmazon.CDK.AWS.ElastiCache.CfnGlobalReplicationGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticache#CfnGlobalReplicationGroupProps
Javasoftware.amazon.awscdk.services.elasticache.CfnGlobalReplicationGroupProps
Pythonaws_cdk.aws_elasticache.CfnGlobalReplicationGroupProps
TypeScript aws-cdk-lib » aws_elasticache » CfnGlobalReplicationGroupProps

Properties for defining a CfnGlobalReplicationGroup.

Example

// 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',
  engineVersion: 'engineVersion',
  globalNodeGroupCount: 123,
  globalReplicationGroupDescription: 'globalReplicationGroupDescription',
  globalReplicationGroupIdSuffix: 'globalReplicationGroupIdSuffix',
  regionalConfigurations: [{
    replicationGroupId: 'replicationGroupId',
    replicationGroupRegion: 'replicationGroupRegion',
    reshardingConfigurations: [{
      nodeGroupId: 'nodeGroupId',
      preferredAvailabilityZones: ['preferredAvailabilityZones'],
    }],
  }],
};

Properties

NameTypeDescription
membersIResolvable | IResolvable | GlobalReplicationGroupMemberProperty[]The replication groups that comprise the Global datastore.
automaticFailoverEnabled?boolean | IResolvableSpecifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
cacheNodeType?stringThe cache node type of the Global datastore.
cacheParameterGroupName?stringThe name of the cache parameter group to use with the Global datastore.
engineVersion?stringThe Elasticache Redis engine version.
globalNodeGroupCount?numberThe number of node groups that comprise the Global Datastore.
globalReplicationGroupDescription?stringThe optional description of the Global datastore.
globalReplicationGroupIdSuffix?stringThe suffix name of a Global Datastore.
regionalConfigurations?IResolvable | IResolvable | RegionalConfigurationProperty[]The Regions that comprise the Global Datastore.

members

Type: IResolvable | IResolvable | GlobalReplicationGroupMemberProperty[]

The replication groups 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 Redis (cluster mode enabled) replication groups.


cacheNodeType?

Type: string (optional)

The cache node type of the Global datastore.


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.


engineVersion?

Type: string (optional)

The Elasticache Redis engine version.


globalNodeGroupCount?

Type: number (optional)

The number of node groups that comprise the Global Datastore.


globalReplicationGroupDescription?

Type: string (optional)

The optional description of the Global datastore.


globalReplicationGroupIdSuffix?

Type: string (optional)

The suffix name of a Global Datastore.

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


regionalConfigurations?

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

The Regions that comprise the Global Datastore.