Class CfnGlobalReplicationGroup

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnGlobalReplicationGroup

Implements

IInspectable

IGlobalReplicationGroupRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ElastiCache

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGlobalReplicationGroup : CfnResource, IInspectable, IGlobalReplicationGroupRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnGlobalReplicationGroup Inherits CfnResource Implements IInspectable, IGlobalReplicationGroupRef, IConstruct, IDependable, IEnvironmentAware

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

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 cfnGlobalReplicationGroup = new CfnGlobalReplicationGroup(this, "MyCfnGlobalReplicationGroup", 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

Constructors

CfnGlobalReplicationGroup(Construct, string, ICfnGlobalReplicationGroupProps)

Create a new AWS::ElastiCache::GlobalReplicationGroup.

Properties

AttrGlobalReplicationGroupId	The ID used to associate a secondary cluster to the Global Replication Group.
AttrStatus	The status of the Global Datastore.
AutomaticFailoverEnabled	Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CacheNodeType	The cache node type of the Global datastore.
CacheParameterGroupName	The name of the cache parameter group to use with the Global datastore.
CfnProperties	Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.
CfnPropertyNames	Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.
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.
GlobalReplicationGroupRef	A reference to a GlobalReplicationGroup resource.
Members	The replication groups that comprise the Global datastore.
RegionalConfigurations	The Regions that comprise the Global Datastore.

Methods

ArnForGlobalReplicationGroup(IGlobalReplicationGroupRef)	Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.
FromGlobalReplicationGroupId(Construct, string, string)	Creates a new IGlobalReplicationGroupRef from a globalReplicationGroupId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnGlobalReplicationGroup(object)	Checks whether the given object is a CfnGlobalReplicationGroup.
RenderProperties(IDictionary<string, object>)	Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.

Constructors

CfnGlobalReplicationGroup(Construct, string, ICfnGlobalReplicationGroupProps)

Create a new AWS::ElastiCache::GlobalReplicationGroup.

public CfnGlobalReplicationGroup(Construct scope, string id, ICfnGlobalReplicationGroupProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnGlobalReplicationGroupProps: Resource properties.

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

Properties

AttrGlobalReplicationGroupId

The ID used to associate a secondary cluster to the Global Replication Group.

public virtual string AttrGlobalReplicationGroupId { get; }

Property Value

string

Remarks

CloudformationAttribute: GlobalReplicationGroupId

AttrStatus

The status of the Global Datastore.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

Can be Creating , Modifying , Available , Deleting or Primary-Only . Primary-only status indicates the global datastore contains only a primary cluster. Either all secondary clusters are deleted or not successfully created.

CloudformationAttribute: Status

AutomaticFailoverEnabled

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

public virtual object? AutomaticFailoverEnabled { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

CacheNodeType

The cache node type of the Global datastore.

public virtual string? CacheNodeType { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

CacheParameterGroupName

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

public virtual string? CacheParameterGroupName { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

Engine

The ElastiCache engine.

public virtual string? Engine { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

EngineVersion

The Elasticache Valkey or Redis OSS engine version.

public virtual string? EngineVersion { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

GlobalNodeGroupCount

The number of node groups that comprise the Global Datastore.

public virtual double? GlobalNodeGroupCount { get; set; }

Property Value

double?

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

GlobalReplicationGroupDescription

The optional description of the Global datastore.

public virtual string? GlobalReplicationGroupDescription { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

GlobalReplicationGroupIdSuffix

The suffix name of a Global Datastore.

public virtual string? GlobalReplicationGroupIdSuffix { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

GlobalReplicationGroupRef

A reference to a GlobalReplicationGroup resource.

public virtual IGlobalReplicationGroupReference GlobalReplicationGroupRef { get; }

Property Value

IGlobalReplicationGroupReference

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

Members

The replication groups that comprise the Global datastore.

public virtual object Members { get; set; }

Property Value

object

Remarks

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

RegionalConfigurations

The Regions that comprise the Global Datastore.

public virtual object? RegionalConfigurations { get; set; }

Property Value

object

Remarks

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

Methods

ArnForGlobalReplicationGroup(IGlobalReplicationGroupRef)

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

public static string ArnForGlobalReplicationGroup(IGlobalReplicationGroupRef resource)

Parameters

resource IGlobalReplicationGroupRef

Returns

string

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

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 cfnGlobalReplicationGroup = new CfnGlobalReplicationGroup(this, "MyCfnGlobalReplicationGroup", 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" }
                     } }
                 } }
             });

FromGlobalReplicationGroupId(Construct, string, string)

Creates a new IGlobalReplicationGroupRef from a globalReplicationGroupId.

public static IGlobalReplicationGroupRef FromGlobalReplicationGroupId(Construct scope, string id, string globalReplicationGroupId)

Parameters

scope Construct
id string
globalReplicationGroupId string

Returns

IGlobalReplicationGroupRef

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

IsCfnGlobalReplicationGroup(object)

Checks whether the given object is a CfnGlobalReplicationGroup.

public static bool IsCfnGlobalReplicationGroup(object x)

Parameters

x object

Returns

bool

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

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

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

CloudformationResource: AWS::ElastiCache::GlobalReplicationGroup

ExampleMetadata: fixture=_generated

Implements

IInspectable

IGlobalReplicationGroupRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware