Package software.amazon.awscdk.services.elasticache

Class CfnGlobalReplicationGroup

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.448Z") @Stability(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();

  • 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 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 Details

    • 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

    • getMembers

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

    • 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.

      AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

    • 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.

      AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

    • 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.

      AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

    • 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.

      It must be compatible with the major engine version used by 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.

      It must be compatible with the major engine version used by the Global datastore.

    • getEngineVersion

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

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The Elasticache Redis 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.

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

    • setGlobalReplicationGroupIdSuffix

      @Stability(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(Stable) @Nullable public Object getRegionalConfigurations()
      The Regions that comprise the Global Datastore.

    • 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.