aws logo
AWS Classic v5.29.0, Feb 1 23

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

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var primary = new Aws.ElastiCache.ReplicationGroup("primary", new()
    {
        ReplicationGroupDescription = "primary replication group",
        Engine = "redis",
        EngineVersion = "5.0.6",
        NodeType = "cache.m5.large",
        NumberCacheClusters = 1,
    });

    var example = new Aws.ElastiCache.GlobalReplicationGroup("example", new()
    {
        GlobalReplicationGroupIdSuffix = "example",
        PrimaryReplicationGroupId = primary.Id,
    });

    var secondary = new Aws.ElastiCache.ReplicationGroup("secondary", new()
    {
        ReplicationGroupDescription = "secondary replication group",
        GlobalReplicationGroupId = example.GlobalReplicationGroupId,
        NumberCacheClusters = 1,
    }, new CustomResourceOptions
    {
        Provider = aws.Other_region,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			ReplicationGroupDescription: pulumi.String("primary replication group"),
			Engine:                      pulumi.String("redis"),
			EngineVersion:               pulumi.String("5.0.6"),
			NodeType:                    pulumi.String("cache.m5.large"),
			NumberCacheClusters:         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{
			ReplicationGroupDescription: pulumi.String("secondary replication group"),
			GlobalReplicationGroupId:    example.GlobalReplicationGroupId,
			NumberCacheClusters:         pulumi.Int(1),
		}, pulumi.Provider(aws.Other_region))
		if err != nil {
			return err
		}
		return nil
	})
}
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 com.pulumi.resources.CustomResourceOptions;
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()        
            .replicationGroupDescription("primary replication group")
            .engine("redis")
            .engineVersion("5.0.6")
            .nodeType("cache.m5.large")
            .numberCacheClusters(1)
            .build());

        var example = new GlobalReplicationGroup("example", GlobalReplicationGroupArgs.builder()        
            .globalReplicationGroupIdSuffix("example")
            .primaryReplicationGroupId(primary.id())
            .build());

        var secondary = new ReplicationGroup("secondary", ReplicationGroupArgs.builder()        
            .replicationGroupDescription("secondary replication group")
            .globalReplicationGroupId(example.globalReplicationGroupId())
            .numberCacheClusters(1)
            .build(), CustomResourceOptions.builder()
                .provider(aws.other_region())
                .build());

    }
}
import pulumi
import pulumi_aws as aws

primary = aws.elasticache.ReplicationGroup("primary",
    replication_group_description="primary replication group",
    engine="redis",
    engine_version="5.0.6",
    node_type="cache.m5.large",
    number_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_description="secondary replication group",
    global_replication_group_id=example.global_replication_group_id,
    number_cache_clusters=1,
    opts=pulumi.ResourceOptions(provider=aws["other_region"]))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const primary = new aws.elasticache.ReplicationGroup("primary", {
    replicationGroupDescription: "primary replication group",
    engine: "redis",
    engineVersion: "5.0.6",
    nodeType: "cache.m5.large",
    numberCacheClusters: 1,
});
const example = new aws.elasticache.GlobalReplicationGroup("example", {
    globalReplicationGroupIdSuffix: "example",
    primaryReplicationGroupId: primary.id,
});
const secondary = new aws.elasticache.ReplicationGroup("secondary", {
    replicationGroupDescription: "secondary replication group",
    globalReplicationGroupId: example.globalReplicationGroupId,
    numberCacheClusters: 1,
}, {
    provider: aws.other_region,
});
resources:
  example:
    type: aws:elasticache:GlobalReplicationGroup
    properties:
      globalReplicationGroupIdSuffix: example
      primaryReplicationGroupId: ${primary.id}
  primary:
    type: aws:elasticache:ReplicationGroup
    properties:
      replicationGroupDescription: primary replication group
      engine: redis
      engineVersion: 5.0.6
      nodeType: cache.m5.large
      numberCacheClusters: 1
  secondary:
    type: aws:elasticache:ReplicationGroup
    properties:
      replicationGroupDescription: secondary replication group
      globalReplicationGroupId: ${example.globalReplicationGroupId}
      numberCacheClusters: 1
    options:
      provider: ${aws.other_region}

Managing Redis Engine Versions

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var primary = new Aws.ElastiCache.ReplicationGroup("primary", new()
    {
        ReplicationGroupDescription = "primary replication group",
        Engine = "redis",
        EngineVersion = "6.0",
        NodeType = "cache.m5.large",
        NumberCacheClusters = 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()
    {
        ReplicationGroupDescription = "secondary replication group",
        GlobalReplicationGroupId = example.GlobalReplicationGroupId,
        NumberCacheClusters = 1,
    }, new CustomResourceOptions
    {
        Provider = aws.Other_region,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			ReplicationGroupDescription: pulumi.String("primary replication group"),
			Engine:                      pulumi.String("redis"),
			EngineVersion:               pulumi.String("6.0"),
			NodeType:                    pulumi.String("cache.m5.large"),
			NumberCacheClusters:         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{
			ReplicationGroupDescription: pulumi.String("secondary replication group"),
			GlobalReplicationGroupId:    example.GlobalReplicationGroupId,
			NumberCacheClusters:         pulumi.Int(1),
		}, pulumi.Provider(aws.Other_region))
		if err != nil {
			return err
		}
		return nil
	})
}
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 com.pulumi.resources.CustomResourceOptions;
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()        
            .replicationGroupDescription("primary replication group")
            .engine("redis")
            .engineVersion("6.0")
            .nodeType("cache.m5.large")
            .numberCacheClusters(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()        
            .replicationGroupDescription("secondary replication group")
            .globalReplicationGroupId(example.globalReplicationGroupId())
            .numberCacheClusters(1)
            .build(), CustomResourceOptions.builder()
                .provider(aws.other_region())
                .build());

    }
}
import pulumi
import pulumi_aws as aws

primary = aws.elasticache.ReplicationGroup("primary",
    replication_group_description="primary replication group",
    engine="redis",
    engine_version="6.0",
    node_type="cache.m5.large",
    number_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_description="secondary replication group",
    global_replication_group_id=example.global_replication_group_id,
    number_cache_clusters=1,
    opts=pulumi.ResourceOptions(provider=aws["other_region"]))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const primary = new aws.elasticache.ReplicationGroup("primary", {
    replicationGroupDescription: "primary replication group",
    engine: "redis",
    engineVersion: "6.0",
    nodeType: "cache.m5.large",
    numberCacheClusters: 1,
});
const example = new aws.elasticache.GlobalReplicationGroup("example", {
    globalReplicationGroupIdSuffix: "example",
    primaryReplicationGroupId: primary.id,
    engineVersion: "6.2",
});
const secondary = new aws.elasticache.ReplicationGroup("secondary", {
    replicationGroupDescription: "secondary replication group",
    globalReplicationGroupId: example.globalReplicationGroupId,
    numberCacheClusters: 1,
}, {
    provider: aws.other_region,
});
resources:
  example:
    type: aws:elasticache:GlobalReplicationGroup
    properties:
      globalReplicationGroupIdSuffix: example
      primaryReplicationGroupId: ${primary.id}
      engineVersion: '6.2'
  primary:
    type: aws:elasticache:ReplicationGroup
    properties:
      replicationGroupDescription: primary replication group
      engine: redis
      engineVersion: '6.0'
      nodeType: cache.m5.large
      numberCacheClusters: 1
  secondary:
    type: aws:elasticache:ReplicationGroup
    properties:
      replicationGroupDescription: secondary replication group
      globalReplicationGroupId: ${example.globalReplicationGroupId}
      numberCacheClusters: 1
    options:
      provider: ${aws.other_region}

Create GlobalReplicationGroup Resource

new GlobalReplicationGroup(name: string, args: GlobalReplicationGroupArgs, opts?: CustomResourceOptions);
@overload
def GlobalReplicationGroup(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           automatic_failover_enabled: Optional[bool] = None,
                           cache_node_type: Optional[str] = None,
                           engine_version: Optional[str] = None,
                           global_replication_group_description: 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)
@overload
def GlobalReplicationGroup(resource_name: str,
                           args: GlobalReplicationGroupArgs,
                           opts: Optional[ResourceOptions] = 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.

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.

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

The GlobalReplicationGroup resource accepts the following input properties:

GlobalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

PrimaryReplicationGroupId string

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

AutomaticFailoverEnabled bool

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.

CacheNodeType string

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.

EngineVersion string

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

GlobalReplicationGroupDescription string

A user-created description for the global replication group.

NumNodeGroups int

The number of node groups (shards) on the global replication group.

ParameterGroupName string

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

GlobalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

PrimaryReplicationGroupId string

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

AutomaticFailoverEnabled bool

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.

CacheNodeType string

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.

EngineVersion string

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

GlobalReplicationGroupDescription string

A user-created description for the global replication group.

NumNodeGroups int

The number of node groups (shards) on the global replication group.

ParameterGroupName string

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

globalReplicationGroupIdSuffix String

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

primaryReplicationGroupId String

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

automaticFailoverEnabled Boolean

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.

cacheNodeType String

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.

engineVersion String

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

globalReplicationGroupDescription String

A user-created description for the global replication group.

numNodeGroups Integer

The number of node groups (shards) on the global replication group.

parameterGroupName String

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

globalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

primaryReplicationGroupId string

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

automaticFailoverEnabled boolean

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.

cacheNodeType string

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.

engineVersion string

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

globalReplicationGroupDescription string

A user-created description for the global replication group.

numNodeGroups number

The number of node groups (shards) on the global replication group.

parameterGroupName string

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

global_replication_group_id_suffix str

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

primary_replication_group_id str

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

automatic_failover_enabled bool

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_type str

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_version str

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

global_replication_group_description str

A user-created description for the global replication group.

num_node_groups int

The number of node groups (shards) on the global replication group.

parameter_group_name str

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

globalReplicationGroupIdSuffix String

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

primaryReplicationGroupId String

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

automaticFailoverEnabled Boolean

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.

cacheNodeType String

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.

engineVersion String

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

globalReplicationGroupDescription String

A user-created description for the global replication group.

numNodeGroups Number

The number of node groups (shards) on the global replication group.

parameterGroupName String

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

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.

AtRestEncryptionEnabled bool

A flag that indicate whether the encryption at rest is enabled.

AuthTokenEnabled bool

A flag that indicate whether AuthToken (password) is enabled.

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

EngineVersionActual string

The full version number of the cache engine running on the members of this global replication group.

GlobalNodeGroups List<GlobalReplicationGroupGlobalNodeGroup>

Set of node groups (shards) on the global replication group. Has the values:

GlobalReplicationGroupId string

The full ID of the global replication group.

Id string

The provider-assigned unique ID for this managed resource.

TransitEncryptionEnabled bool

A flag that indicates whether the encryption in transit is enabled.

Arn string

The ARN of the ElastiCache Global Replication Group.

AtRestEncryptionEnabled bool

A flag that indicate whether the encryption at rest is enabled.

AuthTokenEnabled bool

A flag that indicate whether AuthToken (password) is enabled.

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

EngineVersionActual string

The full version number of the cache engine running on the members of this global replication group.

GlobalNodeGroups []GlobalReplicationGroupGlobalNodeGroup

Set of node groups (shards) on the global replication group. Has the values:

GlobalReplicationGroupId string

The full ID of the global replication group.

Id string

The provider-assigned unique ID for this managed resource.

TransitEncryptionEnabled bool

A flag that indicates whether the encryption in transit is enabled.

arn String

The ARN of the ElastiCache Global Replication Group.

atRestEncryptionEnabled Boolean

A flag that indicate whether the encryption at rest is enabled.

authTokenEnabled Boolean

A flag that indicate whether AuthToken (password) is enabled.

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

engineVersionActual String

The full version number of the cache engine running on the members of this global replication group.

globalNodeGroups List<GlobalReplicationGroupGlobalNodeGroup>

Set of node groups (shards) on the global replication group. Has the values:

globalReplicationGroupId String

The full ID of the global replication group.

id String

The provider-assigned unique ID for this managed resource.

transitEncryptionEnabled Boolean

A flag that indicates whether the encryption in transit is enabled.

arn string

The ARN of the ElastiCache Global Replication Group.

atRestEncryptionEnabled boolean

A flag that indicate whether the encryption at rest is enabled.

authTokenEnabled boolean

A flag that indicate whether AuthToken (password) is enabled.

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

engineVersionActual string

The full version number of the cache engine running on the members of this global replication group.

globalNodeGroups GlobalReplicationGroupGlobalNodeGroup[]

Set of node groups (shards) on the global replication group. Has the values:

globalReplicationGroupId string

The full ID of the global replication group.

id string

The provider-assigned unique ID for this managed resource.

transitEncryptionEnabled boolean

A flag that indicates whether the encryption in transit is enabled.

arn str

The ARN of the ElastiCache Global Replication Group.

at_rest_encryption_enabled bool

A flag that indicate whether the encryption at rest is enabled.

auth_token_enabled bool

A flag that indicate whether AuthToken (password) is enabled.

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.

engine_version_actual str

The full version number of the cache engine running on the members of this global replication group.

global_node_groups Sequence[GlobalReplicationGroupGlobalNodeGroup]

Set of node groups (shards) on the global replication group. Has the values:

global_replication_group_id str

The full ID of the global replication group.

id str

The provider-assigned unique ID for this managed resource.

transit_encryption_enabled bool

A flag that indicates whether the encryption in transit is enabled.

arn String

The ARN of the ElastiCache Global Replication Group.

atRestEncryptionEnabled Boolean

A flag that indicate whether the encryption at rest is enabled.

authTokenEnabled Boolean

A flag that indicate whether AuthToken (password) is enabled.

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

engineVersionActual String

The full version number of the cache engine running on the members of this global replication group.

globalNodeGroups List<Property Map>

Set of node groups (shards) on the global replication group. Has the values:

globalReplicationGroupId String

The full ID of the global replication group.

id String

The provider-assigned unique ID for this managed resource.

transitEncryptionEnabled Boolean

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,
        transit_encryption_enabled: Optional[bool] = None) -> GlobalReplicationGroup
func 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)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
Arn string

The ARN of the ElastiCache Global Replication Group.

AtRestEncryptionEnabled bool

A flag that indicate whether the encryption at rest is enabled.

AuthTokenEnabled bool

A flag that indicate whether AuthToken (password) is enabled.

AutomaticFailoverEnabled bool

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.

CacheNodeType string

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.

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

EngineVersion string

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

EngineVersionActual string

The full version number of the cache engine running on the members of this global replication group.

GlobalNodeGroups List<GlobalReplicationGroupGlobalNodeGroupArgs>

Set of node groups (shards) on the global replication group. Has the values:

GlobalReplicationGroupDescription string

A user-created description for the global replication group.

GlobalReplicationGroupId string

The full ID of the global replication group.

GlobalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

NumNodeGroups int

The number of node groups (shards) on the global replication group.

ParameterGroupName string

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

PrimaryReplicationGroupId string

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

TransitEncryptionEnabled bool

A flag that indicates whether the encryption in transit is enabled.

Arn string

The ARN of the ElastiCache Global Replication Group.

AtRestEncryptionEnabled bool

A flag that indicate whether the encryption at rest is enabled.

AuthTokenEnabled bool

A flag that indicate whether AuthToken (password) is enabled.

AutomaticFailoverEnabled bool

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.

CacheNodeType string

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.

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

EngineVersion string

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

EngineVersionActual string

The full version number of the cache engine running on the members of this global replication group.

GlobalNodeGroups []GlobalReplicationGroupGlobalNodeGroupArgs

Set of node groups (shards) on the global replication group. Has the values:

GlobalReplicationGroupDescription string

A user-created description for the global replication group.

GlobalReplicationGroupId string

The full ID of the global replication group.

GlobalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

NumNodeGroups int

The number of node groups (shards) on the global replication group.

ParameterGroupName string

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

PrimaryReplicationGroupId string

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

TransitEncryptionEnabled bool

A flag that indicates whether the encryption in transit is enabled.

arn String

The ARN of the ElastiCache Global Replication Group.

atRestEncryptionEnabled Boolean

A flag that indicate whether the encryption at rest is enabled.

authTokenEnabled Boolean

A flag that indicate whether AuthToken (password) is enabled.

automaticFailoverEnabled Boolean

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.

cacheNodeType String

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.

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

engineVersion String

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

engineVersionActual String

The full version number of the cache engine running on the members of this global replication group.

globalNodeGroups List<GlobalReplicationGroupGlobalNodeGroupArgs>

Set of node groups (shards) on the global replication group. Has the values:

globalReplicationGroupDescription String

A user-created description for the global replication group.

globalReplicationGroupId String

The full ID of the global replication group.

globalReplicationGroupIdSuffix String

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

numNodeGroups Integer

The number of node groups (shards) on the global replication group.

parameterGroupName String

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

primaryReplicationGroupId String

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

transitEncryptionEnabled Boolean

A flag that indicates whether the encryption in transit is enabled.

arn string

The ARN of the ElastiCache Global Replication Group.

atRestEncryptionEnabled boolean

A flag that indicate whether the encryption at rest is enabled.

authTokenEnabled boolean

A flag that indicate whether AuthToken (password) is enabled.

automaticFailoverEnabled boolean

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.

cacheNodeType string

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.

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

engineVersion string

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

engineVersionActual string

The full version number of the cache engine running on the members of this global replication group.

globalNodeGroups GlobalReplicationGroupGlobalNodeGroupArgs[]

Set of node groups (shards) on the global replication group. Has the values:

globalReplicationGroupDescription string

A user-created description for the global replication group.

globalReplicationGroupId string

The full ID of the global replication group.

globalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

numNodeGroups number

The number of node groups (shards) on the global replication group.

parameterGroupName string

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

primaryReplicationGroupId string

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

transitEncryptionEnabled boolean

A flag that indicates whether the encryption in transit is enabled.

arn str

The ARN of the ElastiCache Global Replication Group.

at_rest_encryption_enabled bool

A flag that indicate whether the encryption at rest is enabled.

auth_token_enabled bool

A flag that indicate whether AuthToken (password) is enabled.

automatic_failover_enabled bool

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_type str

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.

engine_version str

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

engine_version_actual str

The full version number of the cache engine running on the members of this global replication group.

global_node_groups Sequence[GlobalReplicationGroupGlobalNodeGroupArgs]

Set of node groups (shards) on the global replication group. Has the values:

global_replication_group_description str

A user-created description for the global replication group.

global_replication_group_id str

The full ID of the global replication group.

global_replication_group_id_suffix str

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

num_node_groups int

The number of node groups (shards) on the global replication group.

parameter_group_name str

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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_group_id str

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

transit_encryption_enabled bool

A flag that indicates whether the encryption in transit is enabled.

arn String

The ARN of the ElastiCache Global Replication Group.

atRestEncryptionEnabled Boolean

A flag that indicate whether the encryption at rest is enabled.

authTokenEnabled Boolean

A flag that indicate whether AuthToken (password) is enabled.

automaticFailoverEnabled Boolean

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.

cacheNodeType String

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.

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

engineVersion String

Redis 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. If the version is 6 or higher, 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 attribute engine_version_actual, see Attributes Reference below.

engineVersionActual String

The full version number of the cache engine running on the members of this global replication group.

globalNodeGroups List<Property Map>

Set of node groups (shards) on the global replication group. Has the values:

globalReplicationGroupDescription String

A user-created description for the global replication group.

globalReplicationGroupId String

The full ID of the global replication group.

globalReplicationGroupIdSuffix String

The suffix name of a Global Datastore. If global_replication_group_id_suffix is changed, creates a new resource.

numNodeGroups Number

The number of node groups (shards) on the global replication group.

parameterGroupName String

An ElastiCache Parameter Group to use for the Global Replication Group. Required when upgrading a 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.

primaryReplicationGroupId String

The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If primary_replication_group_id is changed, creates a new resource.

transitEncryptionEnabled Boolean

A flag that indicates whether the encryption in transit is enabled.

Supporting Types

GlobalReplicationGroupGlobalNodeGroup

GlobalNodeGroupId string

The ID of the global node group.

Slots string

The keyspace for this node group.

GlobalNodeGroupId string

The ID of the global node group.

Slots string

The keyspace for this node group.

globalNodeGroupId String

The ID of the global node group.

slots String

The keyspace for this node group.

globalNodeGroupId string

The ID of the global node group.

slots string

The keyspace for this node group.

global_node_group_id str

The ID of the global node group.

slots str

The keyspace for this node group.

globalNodeGroupId String

The ID of the global node group.

slots String

The keyspace for this node group.

Import

ElastiCache Global Replication Groups can be imported using the global_replication_group_id, e.g.,

 $ pulumi import aws:elasticache/globalReplicationGroup:GlobalReplicationGroup my_global_replication_group okuqm-global-replication-group-1

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.