Class CfnGlobalReplicationGroup
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGlobalReplicationGroup : CfnResource, IInspectable
Syntax (vb)
Public Class CfnGlobalReplicationGroup
Inherits CfnResource
Implements IInspectable
Remarks
The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
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",
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGlobalReplicationGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnGlobalReplicationGroup(Construct, String, ICfnGlobalReplicationGroupProps) |
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. |
CacheNodeType | The cache node type of the Global datastore. |
CacheParameterGroupName | The name of the cache parameter group to use with the Global datastore. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EngineVersion | The Elasticache Redis 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGlobalReplicationGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGlobalReplicationGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGlobalReplicationGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGlobalReplicationGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnGlobalReplicationGroup(Construct, String, ICfnGlobalReplicationGroupProps)
public CfnGlobalReplicationGroup(Construct scope, string id, ICfnGlobalReplicationGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnGlobalReplicationGroupProps
Resource properties.
Properties
AttrGlobalReplicationGroupId
The ID used to associate a secondary cluster to the Global Replication Group.
public virtual string AttrGlobalReplicationGroupId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: GlobalReplicationGroupId
AttrStatus
The status of the Global Datastore.
public virtual string AttrStatus { get; }
Property Value
System.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
System.Object
CacheNodeType
The cache node type of the Global datastore.
public virtual string CacheNodeType { get; set; }
Property Value
System.String
CacheParameterGroupName
The name of the cache parameter group to use with the Global datastore.
public virtual string CacheParameterGroupName { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EngineVersion
The Elasticache Redis engine version.
public virtual string EngineVersion { get; set; }
Property Value
System.String
GlobalNodeGroupCount
The number of node groups that comprise the Global Datastore.
public virtual Nullable<double> GlobalNodeGroupCount { get; set; }
Property Value
System.Nullable<System.Double>
GlobalReplicationGroupDescription
The optional description of the Global datastore.
public virtual string GlobalReplicationGroupDescription { get; set; }
Property Value
System.String
GlobalReplicationGroupIdSuffix
The suffix name of a Global Datastore.
public virtual string GlobalReplicationGroupIdSuffix { get; set; }
Property Value
System.String
Members
The replication groups that comprise the Global datastore.
public virtual object Members { get; set; }
Property Value
System.Object
RegionalConfigurations
The Regions that comprise the Global Datastore.
public virtual object RegionalConfigurations { get; set; }
Property Value
System.Object
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>