software.amazon.awscdk.services.elasticache

Class CfnGlobalReplicationGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.elasticache.CfnGlobalReplicationGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.947Z")
public class CfnGlobalReplicationGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElastiCache::GlobalReplicationGroup`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 CfnGlobalReplicationGroup cfnGlobalReplicationGroup = CfnGlobalReplicationGroup.Builder.create(this, "MyCfnGlobalReplicationGroup")
         .members(List.of(GlobalReplicationGroupMemberProperty.builder()
                 .replicationGroupId("replicationGroupId")
                 .replicationGroupRegion("replicationGroupRegion")
                 .role("role")
                 .build()))
         // the properties below are optional
         .automaticFailoverEnabled(false)
         .cacheNodeType("cacheNodeType")
         .cacheParameterGroupName("cacheParameterGroupName")
         .engineVersion("engineVersion")
         .globalNodeGroupCount(123)
         .globalReplicationGroupDescription("globalReplicationGroupDescription")
         .globalReplicationGroupIdSuffix("globalReplicationGroupIdSuffix")
         .regionalConfigurations(List.of(RegionalConfigurationProperty.builder()
                 .replicationGroupId("replicationGroupId")
                 .replicationGroupRegion("replicationGroupRegion")
                 .reshardingConfigurations(List.of(ReshardingConfigurationProperty.builder()
                         .nodeGroupId("nodeGroupId")
                         .preferredAvailabilityZones(List.of("preferredAvailabilityZones"))
                         .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGlobalReplicationGroup.Builder A fluent builder for CfnGlobalReplicationGroup.
static interface	CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty A member of a Global datastore.
static interface	CfnGlobalReplicationGroup.RegionalConfigurationProperty A list of the replication groups.
static interface	CfnGlobalReplicationGroup.ReshardingConfigurationProperty A list of `PreferredAvailabilityZones` objects that specifies the configuration of a node group in the resharded cluster.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGlobalReplicationGroup(Construct scope, java.lang.String id, CfnGlobalReplicationGroupProps props) Create a new `AWS::ElastiCache::GlobalReplicationGroup`.
protected	CfnGlobalReplicationGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGlobalReplicationGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrGlobalReplicationGroupId() The ID used to associate a secondary cluster to the Global Replication Group.
java.lang.String	getAttrStatus() The status of the Global Datastore.
java.lang.Object	getAutomaticFailoverEnabled() Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
java.lang.String	getCacheNodeType() The cache node type of the Global datastore.
java.lang.String	getCacheParameterGroupName() The name of the cache parameter group to use with the Global datastore.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getEngineVersion() The Elasticache Redis engine version.
java.lang.Number	getGlobalNodeGroupCount() The number of node groups that comprise the Global Datastore.
java.lang.String	getGlobalReplicationGroupDescription() The optional description of the Global datastore.
java.lang.String	getGlobalReplicationGroupIdSuffix() The suffix name of a Global Datastore.
java.lang.Object	getMembers() The replication groups that comprise the Global datastore.
java.lang.Object	getRegionalConfigurations() The Regions that comprise the Global Datastore.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAutomaticFailoverEnabled(java.lang.Boolean value) Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
void	setAutomaticFailoverEnabled(IResolvable value) Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
void	setCacheNodeType(java.lang.String value) The cache node type of the Global datastore.
void	setCacheParameterGroupName(java.lang.String value) The name of the cache parameter group to use with the Global datastore.
void	setEngineVersion(java.lang.String value) The Elasticache Redis engine version.
void	setGlobalNodeGroupCount(java.lang.Number value) The number of node groups that comprise the Global Datastore.
void	setGlobalReplicationGroupDescription(java.lang.String value) The optional description of the Global datastore.
void	setGlobalReplicationGroupIdSuffix(java.lang.String value) The suffix name of a Global Datastore.
void	setMembers(IResolvable value) The replication groups that comprise the Global datastore.
void	setMembers(java.util.List<java.lang.Object> value) The replication groups that comprise the Global datastore.
void	setRegionalConfigurations(IResolvable value) The Regions that comprise the Global Datastore.
void	setRegionalConfigurations(java.util.List<java.lang.Object> value) The Regions that comprise the Global Datastore.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGlobalReplicationGroup

protected CfnGlobalReplicationGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnGlobalReplicationGroup

protected CfnGlobalReplicationGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGlobalReplicationGroup

public CfnGlobalReplicationGroup(Construct scope,
                                 java.lang.String id,
                                 CfnGlobalReplicationGroupProps props)

Create a new `AWS::ElastiCache::GlobalReplicationGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrGlobalReplicationGroupId

public java.lang.String getAttrGlobalReplicationGroupId()

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

getAttrStatus

public java.lang.String getAttrStatus()

The status of the Global Datastore.

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.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getMembers

public java.lang.Object getMembers()

The replication groups that comprise the Global datastore.

setMembers

public void setMembers(IResolvable value)

The replication groups that comprise the Global datastore.

setMembers

public void setMembers(java.util.List<java.lang.Object> value)

The replication groups that comprise the Global datastore.

getAutomaticFailoverEnabled

public java.lang.Object getAutomaticFailoverEnabled()

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.

setAutomaticFailoverEnabled

public void setAutomaticFailoverEnabled(java.lang.Boolean value)

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.

setAutomaticFailoverEnabled

public void setAutomaticFailoverEnabled(IResolvable value)

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.

getCacheNodeType

public java.lang.String getCacheNodeType()

The cache node type of the Global datastore.

setCacheNodeType

public void setCacheNodeType(java.lang.String value)

The cache node type of the Global datastore.

getCacheParameterGroupName

public java.lang.String getCacheParameterGroupName()

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.

setCacheParameterGroupName

public void setCacheParameterGroupName(java.lang.String value)

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.

getEngineVersion

public java.lang.String getEngineVersion()

The Elasticache Redis engine version.

setEngineVersion

public void setEngineVersion(java.lang.String value)

The Elasticache Redis engine version.

getGlobalNodeGroupCount

public java.lang.Number getGlobalNodeGroupCount()

The number of node groups that comprise the Global Datastore.

setGlobalNodeGroupCount

public void setGlobalNodeGroupCount(java.lang.Number value)

The number of node groups that comprise the Global Datastore.

getGlobalReplicationGroupDescription

public java.lang.String getGlobalReplicationGroupDescription()

The optional description of the Global datastore.

setGlobalReplicationGroupDescription

public void setGlobalReplicationGroupDescription(java.lang.String value)

The optional description of the Global datastore.

getGlobalReplicationGroupIdSuffix

public java.lang.String getGlobalReplicationGroupIdSuffix()

The suffix name of a Global Datastore.

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

setGlobalReplicationGroupIdSuffix

public void setGlobalReplicationGroupIdSuffix(java.lang.String value)

The suffix name of a Global Datastore.

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

getRegionalConfigurations

public java.lang.Object getRegionalConfigurations()

The Regions that comprise the Global Datastore.

setRegionalConfigurations

public void setRegionalConfigurations(IResolvable value)

The Regions that comprise the Global Datastore.

setRegionalConfigurations

public void setRegionalConfigurations(java.util.List<java.lang.Object> value)

The Regions that comprise the Global Datastore.