1. Packages
  2. AWS Classic
  3. API Docs
  4. memorydb
  5. Cluster

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.memorydb.Cluster

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides a MemoryDB 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.Cluster("example", {
        aclName: "open-access",
        name: "my-cluster",
        nodeType: "db.t4g.small",
        numShards: 2,
        securityGroupIds: [exampleAwsSecurityGroup.id],
        snapshotRetentionLimit: 7,
        subnetGroupName: exampleAwsMemorydbSubnetGroup.id,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.memorydb.Cluster("example",
        acl_name="open-access",
        name="my-cluster",
        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"])
    
    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 {
    		_, err := memorydb.NewCluster(ctx, "example", &memorydb.ClusterArgs{
    			AclName:   pulumi.String("open-access"),
    			Name:      pulumi.String("my-cluster"),
    			NodeType:  pulumi.String("db.t4g.small"),
    			NumShards: pulumi.Int(2),
    			SecurityGroupIds: pulumi.StringArray{
    				exampleAwsSecurityGroup.Id,
    			},
    			SnapshotRetentionLimit: pulumi.Int(7),
    			SubnetGroupName:        pulumi.Any(exampleAwsMemorydbSubnetGroup.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.MemoryDb.Cluster("example", new()
        {
            AclName = "open-access",
            Name = "my-cluster",
            NodeType = "db.t4g.small",
            NumShards = 2,
            SecurityGroupIds = new[]
            {
                exampleAwsSecurityGroup.Id,
            },
            SnapshotRetentionLimit = 7,
            SubnetGroupName = exampleAwsMemorydbSubnetGroup.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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 Cluster("example", ClusterArgs.builder()
                .aclName("open-access")
                .name("my-cluster")
                .nodeType("db.t4g.small")
                .numShards(2)
                .securityGroupIds(exampleAwsSecurityGroup.id())
                .snapshotRetentionLimit(7)
                .subnetGroupName(exampleAwsMemorydbSubnetGroup.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:memorydb:Cluster
        properties:
          aclName: open-access
          name: my-cluster
          nodeType: db.t4g.small
          numShards: 2
          securityGroupIds:
            - ${exampleAwsSecurityGroup.id}
          snapshotRetentionLimit: 7
          subnetGroupName: ${exampleAwsMemorydbSubnetGroup.id}
    

    Create Cluster Resource

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

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                node_type: Optional[str] = None,
                acl_name: Optional[str] = None,
                num_shards: Optional[int] = None,
                engine_version: Optional[str] = None,
                parameter_group_name: Optional[str] = None,
                final_snapshot_name: Optional[str] = None,
                kms_key_arn: Optional[str] = None,
                maintenance_window: Optional[str] = None,
                name: Optional[str] = None,
                name_prefix: Optional[str] = None,
                port: Optional[int] = None,
                num_replicas_per_shard: Optional[int] = None,
                tls_enabled: Optional[bool] = None,
                description: Optional[str] = None,
                data_tiering: Optional[bool] = None,
                security_group_ids: Optional[Sequence[str]] = None,
                snapshot_arns: Optional[Sequence[str]] = None,
                snapshot_name: Optional[str] = None,
                snapshot_retention_limit: Optional[int] = None,
                snapshot_window: Optional[str] = None,
                sns_topic_arn: Optional[str] = None,
                subnet_group_name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                auto_minor_version_upgrade: Optional[bool] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: aws:memorydb:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleclusterResourceResourceFromMemorydbcluster = new Aws.MemoryDb.Cluster("exampleclusterResourceResourceFromMemorydbcluster", new()
    {
        NodeType = "string",
        AclName = "string",
        NumShards = 0,
        EngineVersion = "string",
        ParameterGroupName = "string",
        FinalSnapshotName = "string",
        KmsKeyArn = "string",
        MaintenanceWindow = "string",
        Name = "string",
        NamePrefix = "string",
        Port = 0,
        NumReplicasPerShard = 0,
        TlsEnabled = false,
        Description = "string",
        DataTiering = false,
        SecurityGroupIds = new[]
        {
            "string",
        },
        SnapshotArns = new[]
        {
            "string",
        },
        SnapshotName = "string",
        SnapshotRetentionLimit = 0,
        SnapshotWindow = "string",
        SnsTopicArn = "string",
        SubnetGroupName = "string",
        Tags = 
        {
            { "string", "string" },
        },
        AutoMinorVersionUpgrade = false,
    });
    
    example, err := memorydb.NewCluster(ctx, "exampleclusterResourceResourceFromMemorydbcluster", &memorydb.ClusterArgs{
    	NodeType:            pulumi.String("string"),
    	AclName:             pulumi.String("string"),
    	NumShards:           pulumi.Int(0),
    	EngineVersion:       pulumi.String("string"),
    	ParameterGroupName:  pulumi.String("string"),
    	FinalSnapshotName:   pulumi.String("string"),
    	KmsKeyArn:           pulumi.String("string"),
    	MaintenanceWindow:   pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	NamePrefix:          pulumi.String("string"),
    	Port:                pulumi.Int(0),
    	NumReplicasPerShard: pulumi.Int(0),
    	TlsEnabled:          pulumi.Bool(false),
    	Description:         pulumi.String("string"),
    	DataTiering:         pulumi.Bool(false),
    	SecurityGroupIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SnapshotArns: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SnapshotName:           pulumi.String("string"),
    	SnapshotRetentionLimit: pulumi.Int(0),
    	SnapshotWindow:         pulumi.String("string"),
    	SnsTopicArn:            pulumi.String("string"),
    	SubnetGroupName:        pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	AutoMinorVersionUpgrade: pulumi.Bool(false),
    })
    
    var exampleclusterResourceResourceFromMemorydbcluster = new Cluster("exampleclusterResourceResourceFromMemorydbcluster", ClusterArgs.builder()
        .nodeType("string")
        .aclName("string")
        .numShards(0)
        .engineVersion("string")
        .parameterGroupName("string")
        .finalSnapshotName("string")
        .kmsKeyArn("string")
        .maintenanceWindow("string")
        .name("string")
        .namePrefix("string")
        .port(0)
        .numReplicasPerShard(0)
        .tlsEnabled(false)
        .description("string")
        .dataTiering(false)
        .securityGroupIds("string")
        .snapshotArns("string")
        .snapshotName("string")
        .snapshotRetentionLimit(0)
        .snapshotWindow("string")
        .snsTopicArn("string")
        .subnetGroupName("string")
        .tags(Map.of("string", "string"))
        .autoMinorVersionUpgrade(false)
        .build());
    
    examplecluster_resource_resource_from_memorydbcluster = aws.memorydb.Cluster("exampleclusterResourceResourceFromMemorydbcluster",
        node_type="string",
        acl_name="string",
        num_shards=0,
        engine_version="string",
        parameter_group_name="string",
        final_snapshot_name="string",
        kms_key_arn="string",
        maintenance_window="string",
        name="string",
        name_prefix="string",
        port=0,
        num_replicas_per_shard=0,
        tls_enabled=False,
        description="string",
        data_tiering=False,
        security_group_ids=["string"],
        snapshot_arns=["string"],
        snapshot_name="string",
        snapshot_retention_limit=0,
        snapshot_window="string",
        sns_topic_arn="string",
        subnet_group_name="string",
        tags={
            "string": "string",
        },
        auto_minor_version_upgrade=False)
    
    const exampleclusterResourceResourceFromMemorydbcluster = new aws.memorydb.Cluster("exampleclusterResourceResourceFromMemorydbcluster", {
        nodeType: "string",
        aclName: "string",
        numShards: 0,
        engineVersion: "string",
        parameterGroupName: "string",
        finalSnapshotName: "string",
        kmsKeyArn: "string",
        maintenanceWindow: "string",
        name: "string",
        namePrefix: "string",
        port: 0,
        numReplicasPerShard: 0,
        tlsEnabled: false,
        description: "string",
        dataTiering: false,
        securityGroupIds: ["string"],
        snapshotArns: ["string"],
        snapshotName: "string",
        snapshotRetentionLimit: 0,
        snapshotWindow: "string",
        snsTopicArn: "string",
        subnetGroupName: "string",
        tags: {
            string: "string",
        },
        autoMinorVersionUpgrade: false,
    });
    
    type: aws:memorydb:Cluster
    properties:
        aclName: string
        autoMinorVersionUpgrade: false
        dataTiering: false
        description: string
        engineVersion: string
        finalSnapshotName: string
        kmsKeyArn: string
        maintenanceWindow: string
        name: string
        namePrefix: string
        nodeType: string
        numReplicasPerShard: 0
        numShards: 0
        parameterGroupName: string
        port: 0
        securityGroupIds:
            - string
        snapshotArns:
            - string
        snapshotName: string
        snapshotRetentionLimit: 0
        snapshotWindow: string
        snsTopicArn: string
        subnetGroupName: string
        tags:
            string: string
        tlsEnabled: false
    

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

    AclName string
    The name of the Access Control List to associate with the cluster.
    NodeType string

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    AutoMinorVersionUpgrade bool
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    DataTiering bool
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    Description string
    Description for the cluster.
    EngineVersion string
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    FinalSnapshotName string
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    KmsKeyArn string
    ARN of the KMS key used to encrypt the cluster at rest.
    MaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    Name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    NumReplicasPerShard int
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    NumShards int
    The number of shards in the cluster. Defaults to 1.
    ParameterGroupName string
    The name of the parameter group associated with the cluster.
    Port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    SecurityGroupIds List<string>
    Set of VPC Security Group ID-s to associate with this cluster.
    SnapshotArns List<string>
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    SnapshotName string
    The name of a snapshot from which to restore data into the new cluster.
    SnapshotRetentionLimit int
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    SnapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    SnsTopicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    SubnetGroupName string
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.
    TlsEnabled bool
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    AclName string
    The name of the Access Control List to associate with the cluster.
    NodeType string

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    AutoMinorVersionUpgrade bool
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    DataTiering bool
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    Description string
    Description for the cluster.
    EngineVersion string
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    FinalSnapshotName string
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    KmsKeyArn string
    ARN of the KMS key used to encrypt the cluster at rest.
    MaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    Name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    NumReplicasPerShard int
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    NumShards int
    The number of shards in the cluster. Defaults to 1.
    ParameterGroupName string
    The name of the parameter group associated with the cluster.
    Port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    SecurityGroupIds []string
    Set of VPC Security Group ID-s to associate with this cluster.
    SnapshotArns []string
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    SnapshotName string
    The name of a snapshot from which to restore data into the new cluster.
    SnapshotRetentionLimit int
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    SnapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    SnsTopicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    SubnetGroupName string
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.
    TlsEnabled bool
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    aclName String
    The name of the Access Control List to associate with the cluster.
    nodeType String

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    autoMinorVersionUpgrade Boolean
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    dataTiering Boolean
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    description String
    Description for the cluster.
    engineVersion String
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    finalSnapshotName String
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    kmsKeyArn String
    ARN of the KMS key used to encrypt the cluster at rest.
    maintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    name String
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    numReplicasPerShard Integer
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    numShards Integer
    The number of shards in the cluster. Defaults to 1.
    parameterGroupName String
    The name of the parameter group associated with the cluster.
    port Integer
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    securityGroupIds List<String>
    Set of VPC Security Group ID-s to associate with this cluster.
    snapshotArns List<String>
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    snapshotName String
    The name of a snapshot from which to restore data into the new cluster.
    snapshotRetentionLimit Integer
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    snapshotWindow String
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    snsTopicArn String
    ARN of the SNS topic to which cluster notifications are sent.
    subnetGroupName String
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.
    tlsEnabled Boolean
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    aclName string
    The name of the Access Control List to associate with the cluster.
    nodeType string

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    autoMinorVersionUpgrade boolean
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    dataTiering boolean
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    description string
    Description for the cluster.
    engineVersion string
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    finalSnapshotName string
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    kmsKeyArn string
    ARN of the KMS key used to encrypt the cluster at rest.
    maintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    numReplicasPerShard number
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    numShards number
    The number of shards in the cluster. Defaults to 1.
    parameterGroupName string
    The name of the parameter group associated with the cluster.
    port number
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    securityGroupIds string[]
    Set of VPC Security Group ID-s to associate with this cluster.
    snapshotArns string[]
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    snapshotName string
    The name of a snapshot from which to restore data into the new cluster.
    snapshotRetentionLimit number
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    snapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    snsTopicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    subnetGroupName string
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.
    tlsEnabled boolean
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    acl_name str
    The name of the Access Control List to associate with the cluster.
    node_type str

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    auto_minor_version_upgrade bool
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    data_tiering bool
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    description str
    Description for the cluster.
    engine_version str
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    final_snapshot_name str
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    kms_key_arn str
    ARN of the KMS key used to encrypt the cluster at rest.
    maintenance_window str
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    name str
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    num_replicas_per_shard int
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    num_shards int
    The number of shards in the cluster. Defaults to 1.
    parameter_group_name str
    The name of the parameter group associated with the cluster.
    port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    security_group_ids Sequence[str]
    Set of VPC Security Group ID-s to associate with this cluster.
    snapshot_arns Sequence[str]
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    snapshot_name str
    The name of a snapshot from which to restore data into the new cluster.
    snapshot_retention_limit int
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    snapshot_window str
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    sns_topic_arn str
    ARN of the SNS topic to which cluster notifications are sent.
    subnet_group_name str
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.
    tls_enabled bool
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    aclName String
    The name of the Access Control List to associate with the cluster.
    nodeType String

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    autoMinorVersionUpgrade Boolean
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    dataTiering Boolean
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    description String
    Description for the cluster.
    engineVersion String
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    finalSnapshotName String
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    kmsKeyArn String
    ARN of the KMS key used to encrypt the cluster at rest.
    maintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    name String
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    numReplicasPerShard Number
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    numShards Number
    The number of shards in the cluster. Defaults to 1.
    parameterGroupName String
    The name of the parameter group associated with the cluster.
    port Number
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    securityGroupIds List<String>
    Set of VPC Security Group ID-s to associate with this cluster.
    snapshotArns List<String>
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    snapshotName String
    The name of a snapshot from which to restore data into the new cluster.
    snapshotRetentionLimit Number
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    snapshotWindow String
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    snsTopicArn String
    ARN of the SNS topic to which cluster notifications are sent.
    subnetGroupName String
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.
    tlsEnabled Boolean
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.

    Outputs

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

    Arn string
    The ARN of the cluster.
    ClusterEndpoints List<ClusterClusterEndpoint>
    EnginePatchVersion string
    Patch version number of the Redis engine used by the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Shards List<ClusterShard>
    Set of shards in this cluster.
    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 cluster.
    ClusterEndpoints []ClusterClusterEndpoint
    EnginePatchVersion string
    Patch version number of the Redis engine used by the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Shards []ClusterShard
    Set of shards in this cluster.
    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 cluster.
    clusterEndpoints List<ClusterClusterEndpoint>
    enginePatchVersion String
    Patch version number of the Redis engine used by the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    shards List<ClusterShard>
    Set of shards in this cluster.
    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 cluster.
    clusterEndpoints ClusterClusterEndpoint[]
    enginePatchVersion string
    Patch version number of the Redis engine used by the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    shards ClusterShard[]
    Set of shards in this cluster.
    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 cluster.
    cluster_endpoints Sequence[ClusterClusterEndpoint]
    engine_patch_version str
    Patch version number of the Redis engine used by the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    shards Sequence[ClusterShard]
    Set of shards in this cluster.
    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 cluster.
    clusterEndpoints List<Property Map>
    enginePatchVersion String
    Patch version number of the Redis engine used by the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    shards List<Property Map>
    Set of shards in this cluster.
    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 Cluster Resource

    Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            acl_name: Optional[str] = None,
            arn: Optional[str] = None,
            auto_minor_version_upgrade: Optional[bool] = None,
            cluster_endpoints: Optional[Sequence[ClusterClusterEndpointArgs]] = None,
            data_tiering: Optional[bool] = None,
            description: Optional[str] = None,
            engine_patch_version: Optional[str] = None,
            engine_version: Optional[str] = None,
            final_snapshot_name: Optional[str] = None,
            kms_key_arn: Optional[str] = None,
            maintenance_window: Optional[str] = None,
            name: Optional[str] = None,
            name_prefix: Optional[str] = None,
            node_type: Optional[str] = None,
            num_replicas_per_shard: Optional[int] = None,
            num_shards: Optional[int] = None,
            parameter_group_name: Optional[str] = None,
            port: Optional[int] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            shards: Optional[Sequence[ClusterShardArgs]] = None,
            snapshot_arns: Optional[Sequence[str]] = None,
            snapshot_name: Optional[str] = None,
            snapshot_retention_limit: Optional[int] = None,
            snapshot_window: Optional[str] = None,
            sns_topic_arn: Optional[str] = None,
            subnet_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            tls_enabled: Optional[bool] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState 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:
    AclName string
    The name of the Access Control List to associate with the cluster.
    Arn string
    The ARN of the cluster.
    AutoMinorVersionUpgrade bool
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    ClusterEndpoints List<ClusterClusterEndpoint>
    DataTiering bool
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    Description string
    Description for the cluster.
    EnginePatchVersion string
    Patch version number of the Redis engine used by the cluster.
    EngineVersion string
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    FinalSnapshotName string
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    KmsKeyArn string
    ARN of the KMS key used to encrypt the cluster at rest.
    MaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    Name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    NodeType string

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    NumReplicasPerShard int
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    NumShards int
    The number of shards in the cluster. Defaults to 1.
    ParameterGroupName string
    The name of the parameter group associated with the cluster.
    Port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    SecurityGroupIds List<string>
    Set of VPC Security Group ID-s to associate with this cluster.
    Shards List<ClusterShard>
    Set of shards in this cluster.
    SnapshotArns List<string>
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    SnapshotName string
    The name of a snapshot from which to restore data into the new cluster.
    SnapshotRetentionLimit int
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    SnapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    SnsTopicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    SubnetGroupName string
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.

    TlsEnabled bool
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    AclName string
    The name of the Access Control List to associate with the cluster.
    Arn string
    The ARN of the cluster.
    AutoMinorVersionUpgrade bool
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    ClusterEndpoints []ClusterClusterEndpointArgs
    DataTiering bool
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    Description string
    Description for the cluster.
    EnginePatchVersion string
    Patch version number of the Redis engine used by the cluster.
    EngineVersion string
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    FinalSnapshotName string
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    KmsKeyArn string
    ARN of the KMS key used to encrypt the cluster at rest.
    MaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    Name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    NodeType string

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    NumReplicasPerShard int
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    NumShards int
    The number of shards in the cluster. Defaults to 1.
    ParameterGroupName string
    The name of the parameter group associated with the cluster.
    Port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    SecurityGroupIds []string
    Set of VPC Security Group ID-s to associate with this cluster.
    Shards []ClusterShardArgs
    Set of shards in this cluster.
    SnapshotArns []string
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    SnapshotName string
    The name of a snapshot from which to restore data into the new cluster.
    SnapshotRetentionLimit int
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    SnapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    SnsTopicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    SubnetGroupName string
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.

    TlsEnabled bool
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    aclName String
    The name of the Access Control List to associate with the cluster.
    arn String
    The ARN of the cluster.
    autoMinorVersionUpgrade Boolean
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    clusterEndpoints List<ClusterClusterEndpoint>
    dataTiering Boolean
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    description String
    Description for the cluster.
    enginePatchVersion String
    Patch version number of the Redis engine used by the cluster.
    engineVersion String
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    finalSnapshotName String
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    kmsKeyArn String
    ARN of the KMS key used to encrypt the cluster at rest.
    maintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    name String
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    nodeType String

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    numReplicasPerShard Integer
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    numShards Integer
    The number of shards in the cluster. Defaults to 1.
    parameterGroupName String
    The name of the parameter group associated with the cluster.
    port Integer
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    securityGroupIds List<String>
    Set of VPC Security Group ID-s to associate with this cluster.
    shards List<ClusterShard>
    Set of shards in this cluster.
    snapshotArns List<String>
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    snapshotName String
    The name of a snapshot from which to restore data into the new cluster.
    snapshotRetentionLimit Integer
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    snapshotWindow String
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    snsTopicArn String
    ARN of the SNS topic to which cluster notifications are sent.
    subnetGroupName String
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.

    tlsEnabled Boolean
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    aclName string
    The name of the Access Control List to associate with the cluster.
    arn string
    The ARN of the cluster.
    autoMinorVersionUpgrade boolean
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    clusterEndpoints ClusterClusterEndpoint[]
    dataTiering boolean
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    description string
    Description for the cluster.
    enginePatchVersion string
    Patch version number of the Redis engine used by the cluster.
    engineVersion string
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    finalSnapshotName string
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    kmsKeyArn string
    ARN of the KMS key used to encrypt the cluster at rest.
    maintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    nodeType string

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    numReplicasPerShard number
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    numShards number
    The number of shards in the cluster. Defaults to 1.
    parameterGroupName string
    The name of the parameter group associated with the cluster.
    port number
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    securityGroupIds string[]
    Set of VPC Security Group ID-s to associate with this cluster.
    shards ClusterShard[]
    Set of shards in this cluster.
    snapshotArns string[]
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    snapshotName string
    The name of a snapshot from which to restore data into the new cluster.
    snapshotRetentionLimit number
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    snapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    snsTopicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    subnetGroupName string
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.

    tlsEnabled boolean
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    acl_name str
    The name of the Access Control List to associate with the cluster.
    arn str
    The ARN of the cluster.
    auto_minor_version_upgrade bool
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    cluster_endpoints Sequence[ClusterClusterEndpointArgs]
    data_tiering bool
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    description str
    Description for the cluster.
    engine_patch_version str
    Patch version number of the Redis engine used by the cluster.
    engine_version str
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    final_snapshot_name str
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    kms_key_arn str
    ARN of the KMS key used to encrypt the cluster at rest.
    maintenance_window str
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    name str
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    node_type str

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    num_replicas_per_shard int
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    num_shards int
    The number of shards in the cluster. Defaults to 1.
    parameter_group_name str
    The name of the parameter group associated with the cluster.
    port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    security_group_ids Sequence[str]
    Set of VPC Security Group ID-s to associate with this cluster.
    shards Sequence[ClusterShardArgs]
    Set of shards in this cluster.
    snapshot_arns Sequence[str]
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    snapshot_name str
    The name of a snapshot from which to restore data into the new cluster.
    snapshot_retention_limit int
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    snapshot_window str
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    sns_topic_arn str
    ARN of the SNS topic to which cluster notifications are sent.
    subnet_group_name str
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.

    tls_enabled bool
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.
    aclName String
    The name of the Access Control List to associate with the cluster.
    arn String
    The ARN of the cluster.
    autoMinorVersionUpgrade Boolean
    When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
    clusterEndpoints List<Property Map>
    dataTiering Boolean
    Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
    description String
    Description for the cluster.
    enginePatchVersion String
    Patch version number of the Redis engine used by the cluster.
    engineVersion String
    Version number of the Redis engine to be used for the cluster. Downgrades are not supported.
    finalSnapshotName String
    Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
    kmsKeyArn String
    ARN of the KMS key used to encrypt the cluster at rest.
    maintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
    name String
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    nodeType String

    The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.

    The following arguments are optional:

    numReplicasPerShard Number
    The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
    numShards Number
    The number of shards in the cluster. Defaults to 1.
    parameterGroupName String
    The name of the parameter group associated with the cluster.
    port Number
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    securityGroupIds List<String>
    Set of VPC Security Group ID-s to associate with this cluster.
    shards List<Property Map>
    Set of shards in this cluster.
    snapshotArns List<String>
    List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
    snapshotName String
    The name of a snapshot from which to restore data into the new cluster.
    snapshotRetentionLimit Number
    The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
    snapshotWindow String
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
    snsTopicArn String
    ARN of the SNS topic to which cluster notifications are sent.
    subnetGroupName String
    The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
    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.

    tlsEnabled Boolean
    A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.

    Supporting Types

    ClusterClusterEndpoint, ClusterClusterEndpointArgs

    Address string
    DNS hostname of the node.
    Port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    Address string
    DNS hostname of the node.
    Port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    address String
    DNS hostname of the node.
    port Integer
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    address string
    DNS hostname of the node.
    port number
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    address str
    DNS hostname of the node.
    port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    address String
    DNS hostname of the node.
    port Number
    The port number on which each of the nodes accepts connections. Defaults to 6379.

    ClusterShard, ClusterShardArgs

    Name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    Nodes List<ClusterShardNode>
    Set of nodes in this shard.
    NumNodes int
    Number of individual nodes in this shard.
    Slots string
    Keyspace for this shard. Example: 0-16383.
    Name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    Nodes []ClusterShardNode
    Set of nodes in this shard.
    NumNodes int
    Number of individual nodes in this shard.
    Slots string
    Keyspace for this shard. Example: 0-16383.
    name String
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    nodes List<ClusterShardNode>
    Set of nodes in this shard.
    numNodes Integer
    Number of individual nodes in this shard.
    slots String
    Keyspace for this shard. Example: 0-16383.
    name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    nodes ClusterShardNode[]
    Set of nodes in this shard.
    numNodes number
    Number of individual nodes in this shard.
    slots string
    Keyspace for this shard. Example: 0-16383.
    name str
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    nodes Sequence[ClusterShardNode]
    Set of nodes in this shard.
    num_nodes int
    Number of individual nodes in this shard.
    slots str
    Keyspace for this shard. Example: 0-16383.
    name String
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    nodes List<Property Map>
    Set of nodes in this shard.
    numNodes Number
    Number of individual nodes in this shard.
    slots String
    Keyspace for this shard. Example: 0-16383.

    ClusterShardNode, ClusterShardNodeArgs

    AvailabilityZone string
    The Availability Zone in which the node resides.
    CreateTime string
    The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
    Endpoints List<ClusterShardNodeEndpoint>
    Name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    AvailabilityZone string
    The Availability Zone in which the node resides.
    CreateTime string
    The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
    Endpoints []ClusterShardNodeEndpoint
    Name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    availabilityZone String
    The Availability Zone in which the node resides.
    createTime String
    The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
    endpoints List<ClusterShardNodeEndpoint>
    name String
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    availabilityZone string
    The Availability Zone in which the node resides.
    createTime string
    The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
    endpoints ClusterShardNodeEndpoint[]
    name string
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    availability_zone str
    The Availability Zone in which the node resides.
    create_time str
    The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
    endpoints Sequence[ClusterShardNodeEndpoint]
    name str
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    availabilityZone String
    The Availability Zone in which the node resides.
    createTime String
    The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
    endpoints List<Property Map>
    name String
    Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

    ClusterShardNodeEndpoint, ClusterShardNodeEndpointArgs

    Address string
    DNS hostname of the node.
    Port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    Address string
    DNS hostname of the node.
    Port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    address String
    DNS hostname of the node.
    port Integer
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    address string
    DNS hostname of the node.
    port number
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    address str
    DNS hostname of the node.
    port int
    The port number on which each of the nodes accepts connections. Defaults to 6379.
    address String
    DNS hostname of the node.
    port Number
    The port number on which each of the nodes accepts connections. Defaults to 6379.

    Import

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

    $ pulumi import aws:memorydb/cluster:Cluster example my-cluster
    

    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 logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi