software.amazon.awscdk.services.elasticache

Interface CfnGlobalReplicationGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalReplicationGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.984Z")
 @Stability(value=Stable)
public interface CfnGlobalReplicationGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnGlobalReplicationGroup`.

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.*;
 CfnGlobalReplicationGroupProps cfnGlobalReplicationGroupProps = CfnGlobalReplicationGroupProps.builder()
         .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	Interface and Description
static class	CfnGlobalReplicationGroupProps.Builder A builder for CfnGlobalReplicationGroupProps
static class	CfnGlobalReplicationGroupProps.Jsii$Proxy An implementation for CfnGlobalReplicationGroupProps

Method Summary

Modifier and Type	Method and Description
static CfnGlobalReplicationGroupProps.Builder	builder()
default Object	getAutomaticFailoverEnabled() Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
default String	getCacheNodeType() The cache node type of the Global datastore.
default String	getCacheParameterGroupName() The name of the cache parameter group to use with the Global datastore.
default String	getEngineVersion() The Elasticache Redis engine version.
default Number	getGlobalNodeGroupCount() The number of node groups that comprise the Global Datastore.
default String	getGlobalReplicationGroupDescription() The optional description of the Global datastore.
default String	getGlobalReplicationGroupIdSuffix() The suffix name of a Global Datastore.
Object	getMembers() The replication groups that comprise the Global datastore.
default Object	getRegionalConfigurations() The Amazon Regions that comprise the Global Datastore.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMembers

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

The replication groups that comprise the Global datastore.

getAutomaticFailoverEnabled

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

getCacheNodeType

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

The cache node type of the Global datastore.

getCacheParameterGroupName

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

getEngineVersion

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

The Elasticache Redis engine version.

getGlobalNodeGroupCount

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

The number of node groups that comprise the Global Datastore.

getGlobalReplicationGroupDescription

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

The optional description of the Global datastore.

getGlobalReplicationGroupIdSuffix

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

The suffix name of a Global Datastore.

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

getRegionalConfigurations

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

The Amazon Regions that comprise the Global Datastore.

builder

@Stability(value=Stable)
static CfnGlobalReplicationGroupProps.Builder builder()

Returns:

a CfnGlobalReplicationGroupProps.Builder of CfnGlobalReplicationGroupProps