class CfnGlobalReplicationGroupPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.ElastiCache.CfnGlobalReplicationGroupPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awselasticache#CfnGlobalReplicationGroupPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.elasticache.CfnGlobalReplicationGroupPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_elasticache.CfnGlobalReplicationGroupPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_elasticache » CfnGlobalReplicationGroupPropsMixin

Implements IMixin

Extends Mixin

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.

The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

• The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

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 { aws_elasticache as elasticache } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnGlobalReplicationGroupPropsMixin = new elasticache.CfnGlobalReplicationGroupPropsMixin({
  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'],
    }],
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnGlobalReplicationGroupPropsMixin(props: CfnGlobalReplicationGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnGlobalReplicationGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ElastiCache::GlobalReplicationGroup.

Properties

Name	Type	Description
props	CfnGlobalReplicationGroupMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnGlobalReplicationGroupMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.