Package 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, IGlobalReplicationGroupRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:04.890Z") @Stability(Stable) public class CfnGlobalReplicationGroup extends CfnResource implements IInspectable, IGlobalReplicationGroupRef
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")
         .engine("engine")
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGlobalReplicationGroup

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

    • CfnGlobalReplicationGroup

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

    • CfnGlobalReplicationGroup

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromGlobalReplicationGroupId

      @Stability(Stable) @NotNull public static IGlobalReplicationGroupRef fromGlobalReplicationGroupId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String globalReplicationGroupId)
      Creates a new IGlobalReplicationGroupRef from a globalReplicationGroupId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      globalReplicationGroupId - This parameter is required.

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrGlobalReplicationGroupId()
      The ID used to associate a secondary cluster to the Global Replication Group.

    • getAttrStatus

      @Stability(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGlobalReplicationGroupRef

      @Stability(Stable) @NotNull public GlobalReplicationGroupReference getGlobalReplicationGroupRef()
      A reference to a GlobalReplicationGroup resource.
      Specified by:
      getGlobalReplicationGroupRef in interface IGlobalReplicationGroupRef

    • getMembers

      @Stability(Stable) @NotNull public Object getMembers()
      The replication groups that comprise the Global datastore.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty>

    • setMembers

      @Stability(Stable) public void setMembers(@NotNull IResolvable value)
      The replication groups that comprise the Global datastore.

    • setMembers

      @Stability(Stable) public void setMembers(@NotNull List<Object> value)
      The replication groups that comprise the Global datastore.

    • getAutomaticFailoverEnabled

      @Stability(Stable) @Nullable public Object getAutomaticFailoverEnabled()
      Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

      Returns union: either Boolean or IResolvable

    • setAutomaticFailoverEnabled

      @Stability(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.

    • setAutomaticFailoverEnabled

      @Stability(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.

    • getCacheNodeType

      @Stability(Stable) @Nullable public String getCacheNodeType()
      The cache node type of the Global datastore.

    • setCacheNodeType

      @Stability(Stable) public void setCacheNodeType(@Nullable String value)
      The cache node type of the Global datastore.

    • getCacheParameterGroupName

      @Stability(Stable) @Nullable public String getCacheParameterGroupName()
      The name of the cache parameter group to use with the Global datastore.

    • setCacheParameterGroupName

      @Stability(Stable) public void setCacheParameterGroupName(@Nullable String value)
      The name of the cache parameter group to use with the Global datastore.

    • getEngine

      @Stability(Stable) @Nullable public String getEngine()
      The ElastiCache engine.

    • setEngine

      @Stability(Stable) public void setEngine(@Nullable String value)
      The ElastiCache engine.

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The Elasticache Valkey or Redis OSS engine version.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The Elasticache Valkey or Redis OSS engine version.

    • getGlobalNodeGroupCount

      @Stability(Stable) @Nullable public Number getGlobalNodeGroupCount()
      The number of node groups that comprise the Global Datastore.

    • setGlobalNodeGroupCount

      @Stability(Stable) public void setGlobalNodeGroupCount(@Nullable Number value)
      The number of node groups that comprise the Global Datastore.

    • getGlobalReplicationGroupDescription

      @Stability(Stable) @Nullable public String getGlobalReplicationGroupDescription()
      The optional description of the Global datastore.

    • setGlobalReplicationGroupDescription

      @Stability(Stable) public void setGlobalReplicationGroupDescription(@Nullable String value)
      The optional description of the Global datastore.

    • getGlobalReplicationGroupIdSuffix

      @Stability(Stable) @Nullable public String getGlobalReplicationGroupIdSuffix()
      The suffix name of a Global Datastore.

    • setGlobalReplicationGroupIdSuffix

      @Stability(Stable) public void setGlobalReplicationGroupIdSuffix(@Nullable String value)
      The suffix name of a Global Datastore.

    • getRegionalConfigurations

      @Stability(Stable) @Nullable public Object getRegionalConfigurations()
      The Regions that comprise the Global Datastore.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalReplicationGroup.RegionalConfigurationProperty>

    • setRegionalConfigurations

      @Stability(Stable) public void setRegionalConfigurations(@Nullable IResolvable value)
      The Regions that comprise the Global Datastore.

    • setRegionalConfigurations

      @Stability(Stable) public void setRegionalConfigurations(@Nullable List<Object> value)
      The Regions that comprise the Global Datastore.