Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. memorydb
  5. MultiRegionCluster
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.memorydb.MultiRegionCluster

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Provides a MemoryDB Multi Region Cluster.

More information about MemoryDB can be found in the Developer Guide.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.memorydb.MultiRegionCluster("example", {
    multiRegionClusterNameSuffix: "example",
    nodeType: "db.r7g.xlarge",
});
const exampleCluster = new aws.memorydb.Cluster("example", {
    aclName: exampleAwsMemorydbAcl.id,
    autoMinorVersionUpgrade: false,
    name: "example",
    nodeType: "db.t4g.small",
    numShards: 2,
    securityGroupIds: [exampleAwsSecurityGroup.id],
    snapshotRetentionLimit: 7,
    subnetGroupName: exampleAwsMemorydbSubnetGroup.id,
    multiRegionClusterName: example.multiRegionClusterName,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.memorydb.MultiRegionCluster("example",
    multi_region_cluster_name_suffix="example",
    node_type="db.r7g.xlarge")
example_cluster = aws.memorydb.Cluster("example",
    acl_name=example_aws_memorydb_acl["id"],
    auto_minor_version_upgrade=False,
    name="example",
    node_type="db.t4g.small",
    num_shards=2,
    security_group_ids=[example_aws_security_group["id"]],
    snapshot_retention_limit=7,
    subnet_group_name=example_aws_memorydb_subnet_group["id"],
    multi_region_cluster_name=example.multi_region_cluster_name)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/memorydb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := memorydb.NewMultiRegionCluster(ctx, "example", &memorydb.MultiRegionClusterArgs{
			MultiRegionClusterNameSuffix: pulumi.String("example"),
			NodeType:                     pulumi.String("db.r7g.xlarge"),
		})
		if err != nil {
			return err
		}
		_, err = memorydb.NewCluster(ctx, "example", &memorydb.ClusterArgs{
			AclName:                 pulumi.Any(exampleAwsMemorydbAcl.Id),
			AutoMinorVersionUpgrade: pulumi.Bool(false),
			Name:                    pulumi.String("example"),
			NodeType:                pulumi.String("db.t4g.small"),
			NumShards:               pulumi.Int(2),
			SecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			SnapshotRetentionLimit: pulumi.Int(7),
			SubnetGroupName:        pulumi.Any(exampleAwsMemorydbSubnetGroup.Id),
			MultiRegionClusterName: example.MultiRegionClusterName,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.MemoryDb.MultiRegionCluster("example", new()
    {
        MultiRegionClusterNameSuffix = "example",
        NodeType = "db.r7g.xlarge",
    });

    var exampleCluster = new Aws.MemoryDb.Cluster("example", new()
    {
        AclName = exampleAwsMemorydbAcl.Id,
        AutoMinorVersionUpgrade = false,
        Name = "example",
        NodeType = "db.t4g.small",
        NumShards = 2,
        SecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        SnapshotRetentionLimit = 7,
        SubnetGroupName = exampleAwsMemorydbSubnetGroup.Id,
        MultiRegionClusterName = example.MultiRegionClusterName,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.memorydb.MultiRegionCluster;
import com.pulumi.aws.memorydb.MultiRegionClusterArgs;
import com.pulumi.aws.memorydb.Cluster;
import com.pulumi.aws.memorydb.ClusterArgs;
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 example = new MultiRegionCluster("example", MultiRegionClusterArgs.builder()
            .multiRegionClusterNameSuffix("example")
            .nodeType("db.r7g.xlarge")
            .build());

        var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
            .aclName(exampleAwsMemorydbAcl.id())
            .autoMinorVersionUpgrade(false)
            .name("example")
            .nodeType("db.t4g.small")
            .numShards(2)
            .securityGroupIds(exampleAwsSecurityGroup.id())
            .snapshotRetentionLimit(7)
            .subnetGroupName(exampleAwsMemorydbSubnetGroup.id())
            .multiRegionClusterName(example.multiRegionClusterName())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:memorydb:MultiRegionCluster
    properties:
      multiRegionClusterNameSuffix: example
      nodeType: db.r7g.xlarge
  exampleCluster:
    type: aws:memorydb:Cluster
    name: example
    properties:
      aclName: ${exampleAwsMemorydbAcl.id}
      autoMinorVersionUpgrade: false
      name: example
      nodeType: db.t4g.small
      numShards: 2
      securityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      snapshotRetentionLimit: 7
      subnetGroupName: ${exampleAwsMemorydbSubnetGroup.id}
      multiRegionClusterName: ${example.multiRegionClusterName}
Copy

Create MultiRegionCluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MultiRegionCluster(name: string, args: MultiRegionClusterArgs, opts?: CustomResourceOptions);
@overload
def MultiRegionCluster(resource_name: str,
                       args: MultiRegionClusterArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def MultiRegionCluster(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       multi_region_cluster_name_suffix: Optional[str] = None,
                       node_type: Optional[str] = None,
                       description: Optional[str] = None,
                       engine: Optional[str] = None,
                       engine_version: Optional[str] = None,
                       multi_region_parameter_group_name: Optional[str] = None,
                       num_shards: Optional[int] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       timeouts: Optional[MultiRegionClusterTimeoutsArgs] = None,
                       tls_enabled: Optional[bool] = None,
                       update_strategy: Optional[str] = None)
func NewMultiRegionCluster(ctx *Context, name string, args MultiRegionClusterArgs, opts ...ResourceOption) (*MultiRegionCluster, error)
public MultiRegionCluster(string name, MultiRegionClusterArgs args, CustomResourceOptions? opts = null)
public MultiRegionCluster(String name, MultiRegionClusterArgs args)
public MultiRegionCluster(String name, MultiRegionClusterArgs args, CustomResourceOptions options)

type: aws:memorydb:MultiRegionCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MultiRegionClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MultiRegionClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MultiRegionClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MultiRegionClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MultiRegionClusterArgs
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 multiRegionClusterResource = new Aws.MemoryDb.MultiRegionCluster("multiRegionClusterResource", new()
{
    MultiRegionClusterNameSuffix = "string",
    NodeType = "string",
    Description = "string",
    Engine = "string",
    EngineVersion = "string",
    MultiRegionParameterGroupName = "string",
    NumShards = 0,
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.MemoryDb.Inputs.MultiRegionClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    TlsEnabled = false,
    UpdateStrategy = "string",
});
Copy
example, err := memorydb.NewMultiRegionCluster(ctx, "multiRegionClusterResource", &memorydb.MultiRegionClusterArgs{
	MultiRegionClusterNameSuffix:  pulumi.String("string"),
	NodeType:                      pulumi.String("string"),
	Description:                   pulumi.String("string"),
	Engine:                        pulumi.String("string"),
	EngineVersion:                 pulumi.String("string"),
	MultiRegionParameterGroupName: pulumi.String("string"),
	NumShards:                     pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &memorydb.MultiRegionClusterTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	TlsEnabled:     pulumi.Bool(false),
	UpdateStrategy: pulumi.String("string"),
})
Copy
var multiRegionClusterResource = new MultiRegionCluster("multiRegionClusterResource", MultiRegionClusterArgs.builder()
    .multiRegionClusterNameSuffix("string")
    .nodeType("string")
    .description("string")
    .engine("string")
    .engineVersion("string")
    .multiRegionParameterGroupName("string")
    .numShards(0)
    .tags(Map.of("string", "string"))
    .timeouts(MultiRegionClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .tlsEnabled(false)
    .updateStrategy("string")
    .build());
Copy
multi_region_cluster_resource = aws.memorydb.MultiRegionCluster("multiRegionClusterResource",
    multi_region_cluster_name_suffix="string",
    node_type="string",
    description="string",
    engine="string",
    engine_version="string",
    multi_region_parameter_group_name="string",
    num_shards=0,
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    tls_enabled=False,
    update_strategy="string")
Copy
const multiRegionClusterResource = new aws.memorydb.MultiRegionCluster("multiRegionClusterResource", {
    multiRegionClusterNameSuffix: "string",
    nodeType: "string",
    description: "string",
    engine: "string",
    engineVersion: "string",
    multiRegionParameterGroupName: "string",
    numShards: 0,
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    tlsEnabled: false,
    updateStrategy: "string",
});
Copy
type: aws:memorydb:MultiRegionCluster
properties:
    description: string
    engine: string
    engineVersion: string
    multiRegionClusterNameSuffix: string
    multiRegionParameterGroupName: string
    nodeType: string
    numShards: 0
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    tlsEnabled: false
    updateStrategy: string
Copy

MultiRegionCluster 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 MultiRegionCluster resource accepts the following input properties:

MultiRegionClusterNameSuffix This property is required. string
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
NodeType This property is required. string

The node type to be used for the multi-region cluster.

The following arguments are optional:

Description string
description for the multi-region cluster.
Engine string
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
EngineVersion string
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
MultiRegionParameterGroupName string
The name of the multi-region parameter group to be associated with the cluster.
NumShards int
The number of shards for the multi-region cluster.
Tags Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Timeouts MultiRegionClusterTimeouts
TlsEnabled bool
A flag to enable in-transit encryption on the cluster.
UpdateStrategy string
MultiRegionClusterNameSuffix This property is required. string
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
NodeType This property is required. string

The node type to be used for the multi-region cluster.

The following arguments are optional:

Description string
description for the multi-region cluster.
Engine string
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
EngineVersion string
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
MultiRegionParameterGroupName string
The name of the multi-region parameter group to be associated with the cluster.
NumShards int
The number of shards for the multi-region cluster.
Tags map[string]string
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Timeouts MultiRegionClusterTimeoutsArgs
TlsEnabled bool
A flag to enable in-transit encryption on the cluster.
UpdateStrategy string
multiRegionClusterNameSuffix This property is required. String
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
nodeType This property is required. String

The node type to be used for the multi-region cluster.

The following arguments are optional:

description String
description for the multi-region cluster.
engine String
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
engineVersion String
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
multiRegionParameterGroupName String
The name of the multi-region parameter group to be associated with the cluster.
numShards Integer
The number of shards for the multi-region cluster.
tags Map<String,String>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timeouts MultiRegionClusterTimeouts
tlsEnabled Boolean
A flag to enable in-transit encryption on the cluster.
updateStrategy String
multiRegionClusterNameSuffix This property is required. string
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
nodeType This property is required. string

The node type to be used for the multi-region cluster.

The following arguments are optional:

description string
description for the multi-region cluster.
engine string
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
engineVersion string
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
multiRegionParameterGroupName string
The name of the multi-region parameter group to be associated with the cluster.
numShards number
The number of shards for the multi-region cluster.
tags {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timeouts MultiRegionClusterTimeouts
tlsEnabled boolean
A flag to enable in-transit encryption on the cluster.
updateStrategy string
multi_region_cluster_name_suffix This property is required. str
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
node_type This property is required. str

The node type to be used for the multi-region cluster.

The following arguments are optional:

description str
description for the multi-region cluster.
engine str
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
engine_version str
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
multi_region_parameter_group_name str
The name of the multi-region parameter group to be associated with the cluster.
num_shards int
The number of shards for the multi-region cluster.
tags Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timeouts MultiRegionClusterTimeoutsArgs
tls_enabled bool
A flag to enable in-transit encryption on the cluster.
update_strategy str
multiRegionClusterNameSuffix This property is required. String
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
nodeType This property is required. String

The node type to be used for the multi-region cluster.

The following arguments are optional:

description String
description for the multi-region cluster.
engine String
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
engineVersion String
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
multiRegionParameterGroupName String
The name of the multi-region parameter group to be associated with the cluster.
numShards Number
The number of shards for the multi-region cluster.
tags Map<String>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timeouts Property Map
tlsEnabled Boolean
A flag to enable in-transit encryption on the cluster.
updateStrategy String

Outputs

All input properties are implicitly available as output properties. Additionally, the MultiRegionCluster resource produces the following output properties:

Arn string
The ARN of the multi-region cluster.
Id string
The provider-assigned unique ID for this managed resource.
MultiRegionClusterName string
The name of the multi-region cluster.
Status string
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN of the multi-region cluster.
Id string
The provider-assigned unique ID for this managed resource.
MultiRegionClusterName string
The name of the multi-region cluster.
Status string
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the multi-region cluster.
id String
The provider-assigned unique ID for this managed resource.
multiRegionClusterName String
The name of the multi-region cluster.
status String
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN of the multi-region cluster.
id string
The provider-assigned unique ID for this managed resource.
multiRegionClusterName string
The name of the multi-region cluster.
status string
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN of the multi-region cluster.
id str
The provider-assigned unique ID for this managed resource.
multi_region_cluster_name str
The name of the multi-region cluster.
status str
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the multi-region cluster.
id String
The provider-assigned unique ID for this managed resource.
multiRegionClusterName String
The name of the multi-region cluster.
status String
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing MultiRegionCluster Resource

Get an existing MultiRegionCluster 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?: MultiRegionClusterState, opts?: CustomResourceOptions): MultiRegionCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        multi_region_cluster_name: Optional[str] = None,
        multi_region_cluster_name_suffix: Optional[str] = None,
        multi_region_parameter_group_name: Optional[str] = None,
        node_type: Optional[str] = None,
        num_shards: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[MultiRegionClusterTimeoutsArgs] = None,
        tls_enabled: Optional[bool] = None,
        update_strategy: Optional[str] = None) -> MultiRegionCluster
func GetMultiRegionCluster(ctx *Context, name string, id IDInput, state *MultiRegionClusterState, opts ...ResourceOption) (*MultiRegionCluster, error)
public static MultiRegionCluster Get(string name, Input<string> id, MultiRegionClusterState? state, CustomResourceOptions? opts = null)
public static MultiRegionCluster get(String name, Output<String> id, MultiRegionClusterState state, CustomResourceOptions options)
resources:  _:    type: aws:memorydb:MultiRegionCluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 multi-region cluster.
Description string
description for the multi-region cluster.
Engine string
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
EngineVersion string
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
MultiRegionClusterName string
The name of the multi-region cluster.
MultiRegionClusterNameSuffix string
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
MultiRegionParameterGroupName string
The name of the multi-region parameter group to be associated with the cluster.
NodeType string

The node type to be used for the multi-region cluster.

The following arguments are optional:

NumShards int
The number of shards for the multi-region cluster.
Status string
Tags Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Timeouts MultiRegionClusterTimeouts
TlsEnabled bool
A flag to enable in-transit encryption on the cluster.
UpdateStrategy string
Arn string
The ARN of the multi-region cluster.
Description string
description for the multi-region cluster.
Engine string
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
EngineVersion string
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
MultiRegionClusterName string
The name of the multi-region cluster.
MultiRegionClusterNameSuffix string
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
MultiRegionParameterGroupName string
The name of the multi-region parameter group to be associated with the cluster.
NodeType string

The node type to be used for the multi-region cluster.

The following arguments are optional:

NumShards int
The number of shards for the multi-region cluster.
Status string
Tags map[string]string
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Timeouts MultiRegionClusterTimeoutsArgs
TlsEnabled bool
A flag to enable in-transit encryption on the cluster.
UpdateStrategy string
arn String
The ARN of the multi-region cluster.
description String
description for the multi-region cluster.
engine String
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
engineVersion String
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
multiRegionClusterName String
The name of the multi-region cluster.
multiRegionClusterNameSuffix String
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
multiRegionParameterGroupName String
The name of the multi-region parameter group to be associated with the cluster.
nodeType String

The node type to be used for the multi-region cluster.

The following arguments are optional:

numShards Integer
The number of shards for the multi-region cluster.
status String
tags Map<String,String>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

timeouts MultiRegionClusterTimeouts
tlsEnabled Boolean
A flag to enable in-transit encryption on the cluster.
updateStrategy String
arn string
The ARN of the multi-region cluster.
description string
description for the multi-region cluster.
engine string
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
engineVersion string
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
multiRegionClusterName string
The name of the multi-region cluster.
multiRegionClusterNameSuffix string
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
multiRegionParameterGroupName string
The name of the multi-region parameter group to be associated with the cluster.
nodeType string

The node type to be used for the multi-region cluster.

The following arguments are optional:

numShards number
The number of shards for the multi-region cluster.
status string
tags {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

timeouts MultiRegionClusterTimeouts
tlsEnabled boolean
A flag to enable in-transit encryption on the cluster.
updateStrategy string
arn str
The ARN of the multi-region cluster.
description str
description for the multi-region cluster.
engine str
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
engine_version str
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
multi_region_cluster_name str
The name of the multi-region cluster.
multi_region_cluster_name_suffix str
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
multi_region_parameter_group_name str
The name of the multi-region parameter group to be associated with the cluster.
node_type str

The node type to be used for the multi-region cluster.

The following arguments are optional:

num_shards int
The number of shards for the multi-region cluster.
status str
tags Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

timeouts MultiRegionClusterTimeoutsArgs
tls_enabled bool
A flag to enable in-transit encryption on the cluster.
update_strategy str
arn String
The ARN of the multi-region cluster.
description String
description for the multi-region cluster.
engine String
The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.
engineVersion String
The version of the engine to be used for the multi-region cluster. Downgrades are not supported.
multiRegionClusterName String
The name of the multi-region cluster.
multiRegionClusterNameSuffix String
A suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.
multiRegionParameterGroupName String
The name of the multi-region parameter group to be associated with the cluster.
nodeType String

The node type to be used for the multi-region cluster.

The following arguments are optional:

numShards Number
The number of shards for the multi-region cluster.
status String
tags Map<String>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

timeouts Property Map
tlsEnabled Boolean
A flag to enable in-transit encryption on the cluster.
updateStrategy String

Supporting Types

MultiRegionClusterTimeouts
, MultiRegionClusterTimeoutsArgs

Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Update string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Update string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
update String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
update string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
update str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
update String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Import

Using pulumi import, import a cluster using the multi_region_cluster_name. For example:

$ pulumi import aws:memorydb/multiRegionCluster:MultiRegionCluster example virxk-example
Copy

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 aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws