software.amazon.awscdk.services.elasticache

Class CfnGlobalReplicationGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticache.CfnGlobalReplicationGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.982Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnGlobalReplicationGroup(@NotNull
                                                          software.constructs.Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrGlobalReplicationGroupId

@Stability(value=Stable)
 @NotNull
public String getAttrGlobalReplicationGroupId()

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

getAttrStatus

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getMembers

@Stability(value=Stable)
 @NotNull
public Object getMembers()

The replication groups that comprise the Global datastore.

setMembers

@Stability(value=Stable)
public void setMembers(@NotNull
                                                IResolvable value)

The replication groups that comprise the Global datastore.

setMembers

@Stability(value=Stable)
public void setMembers(@NotNull
                                                List<Object> value)

The replication groups that comprise the Global datastore.

getAutomaticFailoverEnabled

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setAutomaticFailoverEnabled(@Nullable
                                                                 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

@Stability(value=Stable)
public void setAutomaticFailoverEnabled(@Nullable
                                                                 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

@Stability(value=Stable)
 @Nullable
public String getCacheNodeType()

The cache node type of the Global datastore.

setCacheNodeType

@Stability(value=Stable)
public void setCacheNodeType(@Nullable
                                                      String value)

The cache node type of the Global datastore.

getCacheParameterGroupName

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setCacheParameterGroupName(@Nullable
                                                                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

@Stability(value=Stable)
 @Nullable
public String getEngineVersion()

The Elasticache Redis engine version.

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)

The Elasticache Redis engine version.

getGlobalNodeGroupCount

@Stability(value=Stable)
 @Nullable
public Number getGlobalNodeGroupCount()

The number of node groups that comprise the Global Datastore.

setGlobalNodeGroupCount

@Stability(value=Stable)
public void setGlobalNodeGroupCount(@Nullable
                                                             Number value)

The number of node groups that comprise the Global Datastore.

getGlobalReplicationGroupDescription

@Stability(value=Stable)
 @Nullable
public String getGlobalReplicationGroupDescription()

The optional description of the Global datastore.

setGlobalReplicationGroupDescription

@Stability(value=Stable)
public void setGlobalReplicationGroupDescription(@Nullable
                                                                          String value)

The optional description of the Global datastore.

getGlobalReplicationGroupIdSuffix

@Stability(value=Stable)
 @Nullable
public String getGlobalReplicationGroupIdSuffix()

The suffix name of a Global Datastore.

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

setGlobalReplicationGroupIdSuffix

@Stability(value=Stable)
public void setGlobalReplicationGroupIdSuffix(@Nullable
                                                                       String value)

The suffix name of a Global Datastore.

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

getRegionalConfigurations

@Stability(value=Stable)
 @Nullable
public Object getRegionalConfigurations()

The Amazon Regions that comprise the Global Datastore.

setRegionalConfigurations

@Stability(value=Stable)
public void setRegionalConfigurations(@Nullable
                                                               IResolvable value)

The Amazon Regions that comprise the Global Datastore.

setRegionalConfigurations

@Stability(value=Stable)
public void setRegionalConfigurations(@Nullable
                                                               List<Object> value)

The Amazon Regions that comprise the Global Datastore.