pulumi-aws-kotlin/com.pulumi.aws.memorydb.kotlin/MultiRegionClusterArgs

MultiRegionClusterArgs

data class MultiRegionClusterArgs(val description: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val multiRegionClusterNameSuffix: Output<String>? = null, val multiRegionParameterGroupName: Output<String>? = null, val nodeType: Output<String>? = null, val numShards: Output<Int>? = null, val tags: Output<Map<String, String>>? = null, val timeouts: Output<MultiRegionClusterTimeoutsArgs>? = null, val tlsEnabled: Output<Boolean>? = null, val updateStrategy: Output<String>? = null) : ConvertibleToJava<MultiRegionClusterArgs>

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&#46;id],
    snapshotRetentionLimit: 7,
    subnetGroupName: exampleAwsMemorydbSubnetGroup.id,
    multiRegionClusterName: example.multiRegionClusterName,
});
Content copied to clipboard
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)
Content copied to clipboard
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,
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
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}
Content copied to clipboard

Import

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

$ pulumi import aws:memorydb/multiRegionCluster:MultiRegionCluster example virxk-example
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, engine: Output<String>? = null, engineVersion: Output<String>? = null, multiRegionClusterNameSuffix: Output<String>? = null, multiRegionParameterGroupName: Output<String>? = null, nodeType: Output<String>? = null, numShards: Output<Int>? = null, tags: Output<Map<String, String>>? = null, timeouts: Output<MultiRegionClusterTimeoutsArgs>? = null, tlsEnabled: Output<Boolean>? = null, updateStrategy: Output<String>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

description for the multi-region cluster.

Link copied to clipboard
val engine: Output<String>? = null

The name of the engine to be used for the multi-region cluster. Valid values are redis and valkey.

Link copied to clipboard
val engineVersion: Output<String>? = null

The version of the engine to be used for the multi-region cluster. Downgrades are not supported.

Link copied to clipboard
val multiRegionClusterNameSuffix: Output<String>? = null

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.

Link copied to clipboard
val multiRegionParameterGroupName: Output<String>? = null

The name of the multi-region parameter group to be associated with the cluster.

Link copied to clipboard
val nodeType: Output<String>? = null

The node type to be used for the multi-region cluster. The following arguments are optional:

Link copied to clipboard
val numShards: Output<Int>? = null

The number of shards for the multi-region cluster.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Link copied to clipboard
Link copied to clipboard
val tlsEnabled: Output<Boolean>? = null

A flag to enable in-transit encryption on the cluster.

Link copied to clipboard
val updateStrategy: Output<String>? = null

Functions

Link copied to clipboard
open override fun toJava(): MultiRegionClusterArgs