AWS v7.10.0 published on Friday, Oct 24, 2025 by Pulumi
aws.elasticache.GlobalReplicationGroup
Provides an ElastiCache Global Replication Group resource, which manages replication between two or more Replication Groups in different regions. For more information, see the ElastiCache User Guide.
Example Usage
Global replication group with one secondary replication group
The global replication group depends on the primary group existing. Secondary replication groups depend on the global replication group. the provider dependency management will handle this transparently using resource value references.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const primary = new aws.elasticache.ReplicationGroup("primary", {
replicationGroupId: "example-primary",
description: "primary replication group",
engine: "redis",
engineVersion: "5.0.6",
nodeType: "cache.m5.large",
numCacheClusters: 1,
});
const example = new aws.elasticache.GlobalReplicationGroup("example", {
globalReplicationGroupIdSuffix: "example",
primaryReplicationGroupId: primary.id,
});
const secondary = new aws.elasticache.ReplicationGroup("secondary", {
replicationGroupId: "example-secondary",
description: "secondary replication group",
globalReplicationGroupId: example.globalReplicationGroupId,
numCacheClusters: 1,
});
import pulumi
import pulumi_aws as aws
primary = aws.elasticache.ReplicationGroup("primary",
replication_group_id="example-primary",
description="primary replication group",
engine="redis",
engine_version="5.0.6",
node_type="cache.m5.large",
num_cache_clusters=1)
example = aws.elasticache.GlobalReplicationGroup("example",
global_replication_group_id_suffix="example",
primary_replication_group_id=primary.id)
secondary = aws.elasticache.ReplicationGroup("secondary",
replication_group_id="example-secondary",
description="secondary replication group",
global_replication_group_id=example.global_replication_group_id,
num_cache_clusters=1)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/elasticache"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
primary, err := elasticache.NewReplicationGroup(ctx, "primary", &elasticache.ReplicationGroupArgs{
ReplicationGroupId: pulumi.String("example-primary"),
Description: pulumi.String("primary replication group"),
Engine: pulumi.String("redis"),
EngineVersion: pulumi.String("5.0.6"),
NodeType: pulumi.String("cache.m5.large"),
NumCacheClusters: pulumi.Int(1),
})
if err != nil {
return err
}
example, err := elasticache.NewGlobalReplicationGroup(ctx, "example", &elasticache.GlobalReplicationGroupArgs{
GlobalReplicationGroupIdSuffix: pulumi.String("example"),
PrimaryReplicationGroupId: primary.ID(),
})
if err != nil {
return err
}
_, err = elasticache.NewReplicationGroup(ctx, "secondary", &elasticache.ReplicationGroupArgs{
ReplicationGroupId: pulumi.String("example-secondary"),
Description: pulumi.String("secondary replication group"),
GlobalReplicationGroupId: example.GlobalReplicationGroupId,
NumCacheClusters: pulumi.Int(1),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var primary = new Aws.ElastiCache.ReplicationGroup("primary", new()
{
ReplicationGroupId = "example-primary",
Description = "primary replication group",
Engine = "redis",
EngineVersion = "5.0.6",
NodeType = "cache.m5.large",
NumCacheClusters = 1,
});
var example = new Aws.ElastiCache.GlobalReplicationGroup("example", new()
{
GlobalReplicationGroupIdSuffix = "example",
PrimaryReplicationGroupId = primary.Id,
});
var secondary = new Aws.ElastiCache.ReplicationGroup("secondary", new()
{
ReplicationGroupId = "example-secondary",
Description = "secondary replication group",
GlobalReplicationGroupId = example.GlobalReplicationGroupId,
NumCacheClusters = 1,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.ReplicationGroup;
import com.pulumi.aws.elasticache.ReplicationGroupArgs;
import com.pulumi.aws.elasticache.GlobalReplicationGroup;
import com.pulumi.aws.elasticache.GlobalReplicationGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var primary = new ReplicationGroup("primary", ReplicationGroupArgs.builder()
.replicationGroupId("example-primary")
.description("primary replication group")
.engine("redis")
.engineVersion("5.0.6")
.nodeType("cache.m5.large")
.numCacheClusters(1)
.build());
var example = new GlobalReplicationGroup("example", GlobalReplicationGroupArgs.builder()
.globalReplicationGroupIdSuffix("example")
.primaryReplicationGroupId(primary.id())
.build());
var secondary = new ReplicationGroup("secondary", ReplicationGroupArgs.builder()
.replicationGroupId("example-secondary")
.description("secondary replication group")
.globalReplicationGroupId(example.globalReplicationGroupId())
.numCacheClusters(1)
.build());
}
}
resources:
example:
type: aws:elasticache:GlobalReplicationGroup
properties:
globalReplicationGroupIdSuffix: example
primaryReplicationGroupId: ${primary.id}
primary:
type: aws:elasticache:ReplicationGroup
properties:
replicationGroupId: example-primary
description: primary replication group
engine: redis
engineVersion: 5.0.6
nodeType: cache.m5.large
numCacheClusters: 1
secondary:
type: aws:elasticache:ReplicationGroup
properties:
replicationGroupId: example-secondary
description: secondary replication group
globalReplicationGroupId: ${example.globalReplicationGroupId}
numCacheClusters: 1
Managing Redis OOS/Valkey Engine Versions
The initial Redis version is determined by the version set on the primary replication group. However, once it is part of a Global Replication Group, the Global Replication Group manages the version of all member replication groups.
The provider is configured to ignore changes to engine, engine_version and parameter_group_name inside aws.elasticache.ReplicationGroup resources if they belong to a global replication group.
In this example, the primary replication group will be created with Redis 6.0, and then upgraded to Redis 6.2 once added to the Global Replication Group. The secondary replication group will be created with Redis 6.2.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const primary = new aws.elasticache.ReplicationGroup("primary", {
replicationGroupId: "example-primary",
description: "primary replication group",
engine: "redis",
engineVersion: "6.0",
nodeType: "cache.m5.large",
numCacheClusters: 1,
});
const example = new aws.elasticache.GlobalReplicationGroup("example", {
globalReplicationGroupIdSuffix: "example",
primaryReplicationGroupId: primary.id,
engineVersion: "6.2",
});
const secondary = new aws.elasticache.ReplicationGroup("secondary", {
replicationGroupId: "example-secondary",
description: "secondary replication group",
globalReplicationGroupId: example.globalReplicationGroupId,
numCacheClusters: 1,
});
import pulumi
import pulumi_aws as aws
primary = aws.elasticache.ReplicationGroup("primary",
replication_group_id="example-primary",
description="primary replication group",
engine="redis",
engine_version="6.0",
node_type="cache.m5.large",
num_cache_clusters=1)
example = aws.elasticache.GlobalReplicationGroup("example",
global_replication_group_id_suffix="example",
primary_replication_group_id=primary.id,
engine_version="6.2")
secondary = aws.elasticache.ReplicationGroup("secondary",
replication_group_id="example-secondary",
description="secondary replication group",
global_replication_group_id=example.global_replication_group_id,
num_cache_clusters=1)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/elasticache"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
primary, err := elasticache.NewReplicationGroup(ctx, "primary", &elasticache.ReplicationGroupArgs{
ReplicationGroupId: pulumi.String("example-primary"),
Description: pulumi.String("primary replication group"),
Engine: pulumi.String("redis"),
EngineVersion: pulumi.String("6.0"),
NodeType: pulumi.String("cache.m5.large"),
NumCacheClusters: pulumi.Int(1),
})
if err != nil {
return err
}
example, err := elasticache.NewGlobalReplicationGroup(ctx, "example", &elasticache.GlobalReplicationGroupArgs{
GlobalReplicationGroupIdSuffix: pulumi.String("example"),
PrimaryReplicationGroupId: primary.ID(),
EngineVersion: pulumi.String("6.2"),
})
if err != nil {
return err
}
_, err = elasticache.NewReplicationGroup(ctx, "secondary", &elasticache.ReplicationGroupArgs{
ReplicationGroupId: pulumi.String("example-secondary"),
Description: pulumi.String("secondary replication group"),
GlobalReplicationGroupId: example.GlobalReplicationGroupId,
NumCacheClusters: pulumi.Int(1),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var primary = new Aws.ElastiCache.ReplicationGroup("primary", new()
{
ReplicationGroupId = "example-primary",
Description = "primary replication group",
Engine = "redis",
EngineVersion = "6.0",
NodeType = "cache.m5.large",
NumCacheClusters = 1,
});
var example = new Aws.ElastiCache.GlobalReplicationGroup("example", new()
{
GlobalReplicationGroupIdSuffix = "example",
PrimaryReplicationGroupId = primary.Id,
EngineVersion = "6.2",
});
var secondary = new Aws.ElastiCache.ReplicationGroup("secondary", new()
{
ReplicationGroupId = "example-secondary",
Description = "secondary replication group",
GlobalReplicationGroupId = example.GlobalReplicationGroupId,
NumCacheClusters = 1,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.ReplicationGroup;
import com.pulumi.aws.elasticache.ReplicationGroupArgs;
import com.pulumi.aws.elasticache.GlobalReplicationGroup;
import com.pulumi.aws.elasticache.GlobalReplicationGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var primary = new ReplicationGroup("primary", ReplicationGroupArgs.builder()
.replicationGroupId("example-primary")
.description("primary replication group")
.engine("redis")
.engineVersion("6.0")
.nodeType("cache.m5.large")
.numCacheClusters(1)
.build());
var example = new GlobalReplicationGroup("example", GlobalReplicationGroupArgs.builder()
.globalReplicationGroupIdSuffix("example")
.primaryReplicationGroupId(primary.id())
.engineVersion("6.2")
.build());
var secondary = new ReplicationGroup("secondary", ReplicationGroupArgs.builder()
.replicationGroupId("example-secondary")
.description("secondary replication group")
.globalReplicationGroupId(example.globalReplicationGroupId())
.numCacheClusters(1)
.build());
}
}
resources:
example:
type: aws:elasticache:GlobalReplicationGroup
properties:
globalReplicationGroupIdSuffix: example
primaryReplicationGroupId: ${primary.id}
engineVersion: '6.2'
primary:
type: aws:elasticache:ReplicationGroup
properties:
replicationGroupId: example-primary
description: primary replication group
engine: redis
engineVersion: '6.0'
nodeType: cache.m5.large
numCacheClusters: 1
secondary:
type: aws:elasticache:ReplicationGroup
properties:
replicationGroupId: example-secondary
description: secondary replication group
globalReplicationGroupId: ${example.globalReplicationGroupId}
numCacheClusters: 1
Create GlobalReplicationGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GlobalReplicationGroup(name: string, args: GlobalReplicationGroupArgs, opts?: CustomResourceOptions);@overload
def GlobalReplicationGroup(resource_name: str,
args: GlobalReplicationGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GlobalReplicationGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
global_replication_group_id_suffix: Optional[str] = None,
primary_replication_group_id: Optional[str] = None,
automatic_failover_enabled: Optional[bool] = None,
cache_node_type: Optional[str] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
global_replication_group_description: Optional[str] = None,
num_node_groups: Optional[int] = None,
parameter_group_name: Optional[str] = None,
region: Optional[str] = None)func NewGlobalReplicationGroup(ctx *Context, name string, args GlobalReplicationGroupArgs, opts ...ResourceOption) (*GlobalReplicationGroup, error)public GlobalReplicationGroup(string name, GlobalReplicationGroupArgs args, CustomResourceOptions? opts = null)
public GlobalReplicationGroup(String name, GlobalReplicationGroupArgs args)
public GlobalReplicationGroup(String name, GlobalReplicationGroupArgs args, CustomResourceOptions options)
type: aws:elasticache:GlobalReplicationGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GlobalReplicationGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GlobalReplicationGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GlobalReplicationGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GlobalReplicationGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GlobalReplicationGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var globalReplicationGroupResource = new Aws.ElastiCache.GlobalReplicationGroup("globalReplicationGroupResource", new()
{
GlobalReplicationGroupIdSuffix = "string",
PrimaryReplicationGroupId = "string",
AutomaticFailoverEnabled = false,
CacheNodeType = "string",
Engine = "string",
EngineVersion = "string",
GlobalReplicationGroupDescription = "string",
NumNodeGroups = 0,
ParameterGroupName = "string",
Region = "string",
});
example, err := elasticache.NewGlobalReplicationGroup(ctx, "globalReplicationGroupResource", &elasticache.GlobalReplicationGroupArgs{
GlobalReplicationGroupIdSuffix: pulumi.String("string"),
PrimaryReplicationGroupId: pulumi.String("string"),
AutomaticFailoverEnabled: pulumi.Bool(false),
CacheNodeType: pulumi.String("string"),
Engine: pulumi.String("string"),
EngineVersion: pulumi.String("string"),
GlobalReplicationGroupDescription: pulumi.String("string"),
NumNodeGroups: pulumi.Int(0),
ParameterGroupName: pulumi.String("string"),
Region: pulumi.String("string"),
})
var globalReplicationGroupResource = new GlobalReplicationGroup("globalReplicationGroupResource", GlobalReplicationGroupArgs.builder()
.globalReplicationGroupIdSuffix("string")
.primaryReplicationGroupId("string")
.automaticFailoverEnabled(false)
.cacheNodeType("string")
.engine("string")
.engineVersion("string")
.globalReplicationGroupDescription("string")
.numNodeGroups(0)
.parameterGroupName("string")
.region("string")
.build());
global_replication_group_resource = aws.elasticache.GlobalReplicationGroup("globalReplicationGroupResource",
global_replication_group_id_suffix="string",
primary_replication_group_id="string",
automatic_failover_enabled=False,
cache_node_type="string",
engine="string",
engine_version="string",
global_replication_group_description="string",
num_node_groups=0,
parameter_group_name="string",
region="string")
const globalReplicationGroupResource = new aws.elasticache.GlobalReplicationGroup("globalReplicationGroupResource", {
globalReplicationGroupIdSuffix: "string",
primaryReplicationGroupId: "string",
automaticFailoverEnabled: false,
cacheNodeType: "string",
engine: "string",
engineVersion: "string",
globalReplicationGroupDescription: "string",
numNodeGroups: 0,
parameterGroupName: "string",
region: "string",
});
type: aws:elasticache:GlobalReplicationGroup
properties:
automaticFailoverEnabled: false
cacheNodeType: string
engine: string
engineVersion: string
globalReplicationGroupDescription: string
globalReplicationGroupIdSuffix: string
numNodeGroups: 0
parameterGroupName: string
primaryReplicationGroupId: string
region: string
GlobalReplicationGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GlobalReplicationGroup resource accepts the following input properties:
- Global
Replication stringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - Primary
Replication stringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - Automatic
Failover boolEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- Cache
Node stringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- Engine string
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - Engine
Version string - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - Global
Replication stringGroup Description - A user-created description for the global replication group.
- Num
Node intGroups - The number of node groups (shards) on the global replication group.
- Parameter
Group stringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Global
Replication stringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - Primary
Replication stringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - Automatic
Failover boolEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- Cache
Node stringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- Engine string
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - Engine
Version string - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - Global
Replication stringGroup Description - A user-created description for the global replication group.
- Num
Node intGroups - The number of node groups (shards) on the global replication group.
- Parameter
Group stringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- global
Replication StringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - primary
Replication StringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - automatic
Failover BooleanEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- cache
Node StringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- engine String
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - engine
Version String - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - global
Replication StringGroup Description - A user-created description for the global replication group.
- num
Node IntegerGroups - The number of node groups (shards) on the global replication group.
- parameter
Group StringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- global
Replication stringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - primary
Replication stringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - automatic
Failover booleanEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- cache
Node stringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- engine string
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - engine
Version string - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - global
Replication stringGroup Description - A user-created description for the global replication group.
- num
Node numberGroups - The number of node groups (shards) on the global replication group.
- parameter
Group stringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- global_
replication_ strgroup_ id_ suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - primary_
replication_ strgroup_ id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - automatic_
failover_ boolenabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- cache_
node_ strtype - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- engine str
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - engine_
version str - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - global_
replication_ strgroup_ description - A user-created description for the global replication group.
- num_
node_ intgroups - The number of node groups (shards) on the global replication group.
- parameter_
group_ strname - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- global
Replication StringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - primary
Replication StringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - automatic
Failover BooleanEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- cache
Node StringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- engine String
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - engine
Version String - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - global
Replication StringGroup Description - A user-created description for the global replication group.
- num
Node NumberGroups - The number of node groups (shards) on the global replication group.
- parameter
Group StringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Outputs
All input properties are implicitly available as output properties. Additionally, the GlobalReplicationGroup resource produces the following output properties:
- Arn string
- The ARN of the ElastiCache Global Replication Group.
- At
Rest boolEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- Auth
Token boolEnabled - A flag that indicate whether AuthToken (password) is enabled.
- Cluster
Enabled bool - Indicates whether the Global Datastore is cluster enabled.
- Engine
Version stringActual - The full version number of the cache engine running on the members of this global replication group.
- Global
Node List<GlobalGroups Replication Group Global Node Group> - Set of node groups (shards) on the global replication group. Has the values:
- Global
Replication stringGroup Id - The full ID of the global replication group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Transit
Encryption boolEnabled - A flag that indicates whether the encryption in transit is enabled.
- Arn string
- The ARN of the ElastiCache Global Replication Group.
- At
Rest boolEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- Auth
Token boolEnabled - A flag that indicate whether AuthToken (password) is enabled.
- Cluster
Enabled bool - Indicates whether the Global Datastore is cluster enabled.
- Engine
Version stringActual - The full version number of the cache engine running on the members of this global replication group.
- Global
Node []GlobalGroups Replication Group Global Node Group - Set of node groups (shards) on the global replication group. Has the values:
- Global
Replication stringGroup Id - The full ID of the global replication group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Transit
Encryption boolEnabled - A flag that indicates whether the encryption in transit is enabled.
- arn String
- The ARN of the ElastiCache Global Replication Group.
- at
Rest BooleanEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- auth
Token BooleanEnabled - A flag that indicate whether AuthToken (password) is enabled.
- cluster
Enabled Boolean - Indicates whether the Global Datastore is cluster enabled.
- engine
Version StringActual - The full version number of the cache engine running on the members of this global replication group.
- global
Node List<GlobalGroups Replication Group Global Node Group> - Set of node groups (shards) on the global replication group. Has the values:
- global
Replication StringGroup Id - The full ID of the global replication group.
- id String
- The provider-assigned unique ID for this managed resource.
- transit
Encryption BooleanEnabled - A flag that indicates whether the encryption in transit is enabled.
- arn string
- The ARN of the ElastiCache Global Replication Group.
- at
Rest booleanEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- auth
Token booleanEnabled - A flag that indicate whether AuthToken (password) is enabled.
- cluster
Enabled boolean - Indicates whether the Global Datastore is cluster enabled.
- engine
Version stringActual - The full version number of the cache engine running on the members of this global replication group.
- global
Node GlobalGroups Replication Group Global Node Group[] - Set of node groups (shards) on the global replication group. Has the values:
- global
Replication stringGroup Id - The full ID of the global replication group.
- id string
- The provider-assigned unique ID for this managed resource.
- transit
Encryption booleanEnabled - A flag that indicates whether the encryption in transit is enabled.
- arn str
- The ARN of the ElastiCache Global Replication Group.
- at_
rest_ boolencryption_ enabled - A flag that indicate whether the encryption at rest is enabled.
- auth_
token_ boolenabled - A flag that indicate whether AuthToken (password) is enabled.
- cluster_
enabled bool - Indicates whether the Global Datastore is cluster enabled.
- engine_
version_ stractual - The full version number of the cache engine running on the members of this global replication group.
- global_
node_ Sequence[Globalgroups Replication Group Global Node Group] - Set of node groups (shards) on the global replication group. Has the values:
- global_
replication_ strgroup_ id - The full ID of the global replication group.
- id str
- The provider-assigned unique ID for this managed resource.
- transit_
encryption_ boolenabled - A flag that indicates whether the encryption in transit is enabled.
- arn String
- The ARN of the ElastiCache Global Replication Group.
- at
Rest BooleanEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- auth
Token BooleanEnabled - A flag that indicate whether AuthToken (password) is enabled.
- cluster
Enabled Boolean - Indicates whether the Global Datastore is cluster enabled.
- engine
Version StringActual - The full version number of the cache engine running on the members of this global replication group.
- global
Node List<Property Map>Groups - Set of node groups (shards) on the global replication group. Has the values:
- global
Replication StringGroup Id - The full ID of the global replication group.
- id String
- The provider-assigned unique ID for this managed resource.
- transit
Encryption BooleanEnabled - A flag that indicates whether the encryption in transit is enabled.
Look up Existing GlobalReplicationGroup Resource
Get an existing GlobalReplicationGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GlobalReplicationGroupState, opts?: CustomResourceOptions): GlobalReplicationGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
at_rest_encryption_enabled: Optional[bool] = None,
auth_token_enabled: Optional[bool] = None,
automatic_failover_enabled: Optional[bool] = None,
cache_node_type: Optional[str] = None,
cluster_enabled: Optional[bool] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
engine_version_actual: Optional[str] = None,
global_node_groups: Optional[Sequence[GlobalReplicationGroupGlobalNodeGroupArgs]] = None,
global_replication_group_description: Optional[str] = None,
global_replication_group_id: Optional[str] = None,
global_replication_group_id_suffix: Optional[str] = None,
num_node_groups: Optional[int] = None,
parameter_group_name: Optional[str] = None,
primary_replication_group_id: Optional[str] = None,
region: Optional[str] = None,
transit_encryption_enabled: Optional[bool] = None) -> GlobalReplicationGroupfunc GetGlobalReplicationGroup(ctx *Context, name string, id IDInput, state *GlobalReplicationGroupState, opts ...ResourceOption) (*GlobalReplicationGroup, error)public static GlobalReplicationGroup Get(string name, Input<string> id, GlobalReplicationGroupState? state, CustomResourceOptions? opts = null)public static GlobalReplicationGroup get(String name, Output<String> id, GlobalReplicationGroupState state, CustomResourceOptions options)resources: _: type: aws:elasticache:GlobalReplicationGroup get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The ARN of the ElastiCache Global Replication Group.
- At
Rest boolEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- Auth
Token boolEnabled - A flag that indicate whether AuthToken (password) is enabled.
- Automatic
Failover boolEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- Cache
Node stringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- Cluster
Enabled bool - Indicates whether the Global Datastore is cluster enabled.
- Engine string
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - Engine
Version string - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - Engine
Version stringActual - The full version number of the cache engine running on the members of this global replication group.
- Global
Node List<GlobalGroups Replication Group Global Node Group> - Set of node groups (shards) on the global replication group. Has the values:
- Global
Replication stringGroup Description - A user-created description for the global replication group.
- Global
Replication stringGroup Id - The full ID of the global replication group.
- Global
Replication stringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - Num
Node intGroups - The number of node groups (shards) on the global replication group.
- Parameter
Group stringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- Primary
Replication stringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Transit
Encryption boolEnabled - A flag that indicates whether the encryption in transit is enabled.
- Arn string
- The ARN of the ElastiCache Global Replication Group.
- At
Rest boolEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- Auth
Token boolEnabled - A flag that indicate whether AuthToken (password) is enabled.
- Automatic
Failover boolEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- Cache
Node stringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- Cluster
Enabled bool - Indicates whether the Global Datastore is cluster enabled.
- Engine string
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - Engine
Version string - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - Engine
Version stringActual - The full version number of the cache engine running on the members of this global replication group.
- Global
Node []GlobalGroups Replication Group Global Node Group Args - Set of node groups (shards) on the global replication group. Has the values:
- Global
Replication stringGroup Description - A user-created description for the global replication group.
- Global
Replication stringGroup Id - The full ID of the global replication group.
- Global
Replication stringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - Num
Node intGroups - The number of node groups (shards) on the global replication group.
- Parameter
Group stringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- Primary
Replication stringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Transit
Encryption boolEnabled - A flag that indicates whether the encryption in transit is enabled.
- arn String
- The ARN of the ElastiCache Global Replication Group.
- at
Rest BooleanEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- auth
Token BooleanEnabled - A flag that indicate whether AuthToken (password) is enabled.
- automatic
Failover BooleanEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- cache
Node StringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- cluster
Enabled Boolean - Indicates whether the Global Datastore is cluster enabled.
- engine String
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - engine
Version String - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - engine
Version StringActual - The full version number of the cache engine running on the members of this global replication group.
- global
Node List<GlobalGroups Replication Group Global Node Group> - Set of node groups (shards) on the global replication group. Has the values:
- global
Replication StringGroup Description - A user-created description for the global replication group.
- global
Replication StringGroup Id - The full ID of the global replication group.
- global
Replication StringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - num
Node IntegerGroups - The number of node groups (shards) on the global replication group.
- parameter
Group StringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- primary
Replication StringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- transit
Encryption BooleanEnabled - A flag that indicates whether the encryption in transit is enabled.
- arn string
- The ARN of the ElastiCache Global Replication Group.
- at
Rest booleanEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- auth
Token booleanEnabled - A flag that indicate whether AuthToken (password) is enabled.
- automatic
Failover booleanEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- cache
Node stringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- cluster
Enabled boolean - Indicates whether the Global Datastore is cluster enabled.
- engine string
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - engine
Version string - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - engine
Version stringActual - The full version number of the cache engine running on the members of this global replication group.
- global
Node GlobalGroups Replication Group Global Node Group[] - Set of node groups (shards) on the global replication group. Has the values:
- global
Replication stringGroup Description - A user-created description for the global replication group.
- global
Replication stringGroup Id - The full ID of the global replication group.
- global
Replication stringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - num
Node numberGroups - The number of node groups (shards) on the global replication group.
- parameter
Group stringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- primary
Replication stringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- transit
Encryption booleanEnabled - A flag that indicates whether the encryption in transit is enabled.
- arn str
- The ARN of the ElastiCache Global Replication Group.
- at_
rest_ boolencryption_ enabled - A flag that indicate whether the encryption at rest is enabled.
- auth_
token_ boolenabled - A flag that indicate whether AuthToken (password) is enabled.
- automatic_
failover_ boolenabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- cache_
node_ strtype - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- cluster_
enabled bool - Indicates whether the Global Datastore is cluster enabled.
- engine str
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - engine_
version str - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - engine_
version_ stractual - The full version number of the cache engine running on the members of this global replication group.
- global_
node_ Sequence[Globalgroups Replication Group Global Node Group Args] - Set of node groups (shards) on the global replication group. Has the values:
- global_
replication_ strgroup_ description - A user-created description for the global replication group.
- global_
replication_ strgroup_ id - The full ID of the global replication group.
- global_
replication_ strgroup_ id_ suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - num_
node_ intgroups - The number of node groups (shards) on the global replication group.
- parameter_
group_ strname - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- primary_
replication_ strgroup_ id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- transit_
encryption_ boolenabled - A flag that indicates whether the encryption in transit is enabled.
- arn String
- The ARN of the ElastiCache Global Replication Group.
- at
Rest BooleanEncryption Enabled - A flag that indicate whether the encryption at rest is enabled.
- auth
Token BooleanEnabled - A flag that indicate whether AuthToken (password) is enabled.
- automatic
Failover BooleanEnabled - Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group.
- cache
Node StringType - The instance class used. See AWS documentation for information on supported node types and guidance on selecting node types. When creating, by default the Global Replication Group inherits the node type of the primary replication group.
- cluster
Enabled Boolean - Indicates whether the Global Datastore is cluster enabled.
- engine String
- The name of the cache engine to be used for the clusters in this global replication group.
When creating, by default the Global Replication Group inherits the engine of the primary replication group.
If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine.
Valid values are
redisorvalkey. Default isredisifengine_versionis specified. - engine
Version String - Engine version to use for the Global Replication Group.
When creating, by default the Global Replication Group inherits the version of the primary replication group.
If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version.
Cannot be downgraded without replacing the Global Replication Group and all member replication groups.
When the version is 7 or higher, the major and minor version should be set, e.g.,
7.2. When the version is 6, the major and minor version can be set, e.g.,6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g.,6.x. The actual engine version used is returned in the attributeengine_version_actual, see Attribute Reference below. - engine
Version StringActual - The full version number of the cache engine running on the members of this global replication group.
- global
Node List<Property Map>Groups - Set of node groups (shards) on the global replication group. Has the values:
- global
Replication StringGroup Description - A user-created description for the global replication group.
- global
Replication StringGroup Id - The full ID of the global replication group.
- global
Replication StringGroup Id Suffix - The suffix name of a Global Datastore. If
global_replication_group_id_suffixis changed, creates a new resource. - num
Node NumberGroups - The number of node groups (shards) on the global replication group.
- parameter
Group StringName - An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group.
- primary
Replication StringGroup Id - The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If
primary_replication_group_idis changed, creates a new resource. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- transit
Encryption BooleanEnabled - A flag that indicates whether the encryption in transit is enabled.
Supporting Types
GlobalReplicationGroupGlobalNodeGroup, GlobalReplicationGroupGlobalNodeGroupArgs
- Global
Node stringGroup Id - The ID of the global node group.
- Slots string
- The keyspace for this node group.
- Global
Node stringGroup Id - The ID of the global node group.
- Slots string
- The keyspace for this node group.
- global
Node StringGroup Id - The ID of the global node group.
- slots String
- The keyspace for this node group.
- global
Node stringGroup Id - The ID of the global node group.
- slots string
- The keyspace for this node group.
- global_
node_ strgroup_ id - The ID of the global node group.
- slots str
- The keyspace for this node group.
- global
Node StringGroup Id - The ID of the global node group.
- slots String
- The keyspace for this node group.
Import
Using pulumi import, import ElastiCache Global Replication Groups using the global_replication_group_id. For example:
$ pulumi import aws:elasticache/globalReplicationGroup:GlobalReplicationGroup my_global_replication_group okuqm-global-replication-group-1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
