AWS Classic v5.41.0, May 15 23

aws.elasticache.Cluster

Explore with Pulumi AI

Provides an ElastiCache Cluster resource, which manages either a Memcached cluster, a single-node Redis instance, or a [read replica in a Redis (Cluster Mode Enabled) replication group].

For working with Redis (Cluster Mode Enabled) replication groups, see the aws.elasticache.ReplicationGroup resource.

Note: When you change an attribute, such as num_cache_nodes, by default it is applied in the next maintenance window. Because of this, this provider may report a difference in its planning phase because the actual modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately. Using apply_immediately can result in a brief downtime as the server reboots. See the AWS Documentation on Modifying an ElastiCache Cache Cluster for ElastiCache for Memcached or ElastiCache for Redis for more information.

Note: Any attribute changes that re-create the resource will be applied immediately, regardless of the value of apply_immediately.

Example Usage

Memcached Cluster

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ElastiCache.Cluster("example", new()
    {
        Engine = "memcached",
        NodeType = "cache.m4.large",
        NumCacheNodes = 2,
        ParameterGroupName = "default.memcached1.4",
        Port = 11211,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/elasticache"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticache.NewCluster(ctx, "example", &elasticache.ClusterArgs{
			Engine:             pulumi.String("memcached"),
			NodeType:           pulumi.String("cache.m4.large"),
			NumCacheNodes:      pulumi.Int(2),
			ParameterGroupName: pulumi.String("default.memcached1.4"),
			Port:               pulumi.Int(11211),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.Cluster;
import com.pulumi.aws.elasticache.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()        
            .engine("memcached")
            .nodeType("cache.m4.large")
            .numCacheNodes(2)
            .parameterGroupName("default.memcached1.4")
            .port(11211)
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.elasticache.Cluster("example",
    engine="memcached",
    node_type="cache.m4.large",
    num_cache_nodes=2,
    parameter_group_name="default.memcached1.4",
    port=11211)

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

const example = new aws.elasticache.Cluster("example", {
    engine: "memcached",
    nodeType: "cache.m4.large",
    numCacheNodes: 2,
    parameterGroupName: "default.memcached1.4",
    port: 11211,
});

resources:
  example:
    type: aws:elasticache:Cluster
    properties:
      engine: memcached
      nodeType: cache.m4.large
      numCacheNodes: 2
      parameterGroupName: default.memcached1.4
      port: 11211

Redis Instance

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ElastiCache.Cluster("example", new()
    {
        Engine = "redis",
        EngineVersion = "3.2.10",
        NodeType = "cache.m4.large",
        NumCacheNodes = 1,
        ParameterGroupName = "default.redis3.2",
        Port = 6379,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/elasticache"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticache.NewCluster(ctx, "example", &elasticache.ClusterArgs{
			Engine:             pulumi.String("redis"),
			EngineVersion:      pulumi.String("3.2.10"),
			NodeType:           pulumi.String("cache.m4.large"),
			NumCacheNodes:      pulumi.Int(1),
			ParameterGroupName: pulumi.String("default.redis3.2"),
			Port:               pulumi.Int(6379),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.Cluster;
import com.pulumi.aws.elasticache.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()        
            .engine("redis")
            .engineVersion("3.2.10")
            .nodeType("cache.m4.large")
            .numCacheNodes(1)
            .parameterGroupName("default.redis3.2")
            .port(6379)
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.elasticache.Cluster("example",
    engine="redis",
    engine_version="3.2.10",
    node_type="cache.m4.large",
    num_cache_nodes=1,
    parameter_group_name="default.redis3.2",
    port=6379)

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

const example = new aws.elasticache.Cluster("example", {
    engine: "redis",
    engineVersion: "3.2.10",
    nodeType: "cache.m4.large",
    numCacheNodes: 1,
    parameterGroupName: "default.redis3.2",
    port: 6379,
});

resources:
  example:
    type: aws:elasticache:Cluster
    properties:
      engine: redis
      engineVersion: 3.2.10
      nodeType: cache.m4.large
      numCacheNodes: 1
      parameterGroupName: default.redis3.2
      port: 6379

Redis Cluster Mode Disabled Read Replica Instance

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

return await Deployment.RunAsync(() => 
{
    var replica = new Aws.ElastiCache.Cluster("replica", new()
    {
        ReplicationGroupId = aws_elasticache_replication_group.Example.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/elasticache"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticache.NewCluster(ctx, "replica", &elasticache.ClusterArgs{
			ReplicationGroupId: pulumi.Any(aws_elasticache_replication_group.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.Cluster;
import com.pulumi.aws.elasticache.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 replica = new Cluster("replica", ClusterArgs.builder()        
            .replicationGroupId(aws_elasticache_replication_group.example().id())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

replica = aws.elasticache.Cluster("replica", replication_group_id=aws_elasticache_replication_group["example"]["id"])

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

const replica = new aws.elasticache.Cluster("replica", {replicationGroupId: aws_elasticache_replication_group.example.id});

resources:
  replica:
    type: aws:elasticache:Cluster
    properties:
      replicationGroupId: ${aws_elasticache_replication_group.example.id}

Redis Log Delivery configuration

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

return await Deployment.RunAsync(() => 
{
    var test = new Aws.ElastiCache.Cluster("test", new()
    {
        Engine = "redis",
        NodeType = "cache.t3.micro",
        NumCacheNodes = 1,
        Port = 6379,
        ApplyImmediately = true,
        LogDeliveryConfigurations = new[]
        {
            new Aws.ElastiCache.Inputs.ClusterLogDeliveryConfigurationArgs
            {
                Destination = aws_cloudwatch_log_group.Example.Name,
                DestinationType = "cloudwatch-logs",
                LogFormat = "text",
                LogType = "slow-log",
            },
            new Aws.ElastiCache.Inputs.ClusterLogDeliveryConfigurationArgs
            {
                Destination = aws_kinesis_firehose_delivery_stream.Example.Name,
                DestinationType = "kinesis-firehose",
                LogFormat = "json",
                LogType = "engine-log",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/elasticache"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticache.NewCluster(ctx, "test", &elasticache.ClusterArgs{
			Engine:           pulumi.String("redis"),
			NodeType:         pulumi.String("cache.t3.micro"),
			NumCacheNodes:    pulumi.Int(1),
			Port:             pulumi.Int(6379),
			ApplyImmediately: pulumi.Bool(true),
			LogDeliveryConfigurations: elasticache.ClusterLogDeliveryConfigurationArray{
				&elasticache.ClusterLogDeliveryConfigurationArgs{
					Destination:     pulumi.Any(aws_cloudwatch_log_group.Example.Name),
					DestinationType: pulumi.String("cloudwatch-logs"),
					LogFormat:       pulumi.String("text"),
					LogType:         pulumi.String("slow-log"),
				},
				&elasticache.ClusterLogDeliveryConfigurationArgs{
					Destination:     pulumi.Any(aws_kinesis_firehose_delivery_stream.Example.Name),
					DestinationType: pulumi.String("kinesis-firehose"),
					LogFormat:       pulumi.String("json"),
					LogType:         pulumi.String("engine-log"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.Cluster;
import com.pulumi.aws.elasticache.ClusterArgs;
import com.pulumi.aws.elasticache.inputs.ClusterLogDeliveryConfigurationArgs;
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 test = new Cluster("test", ClusterArgs.builder()        
            .engine("redis")
            .nodeType("cache.t3.micro")
            .numCacheNodes(1)
            .port(6379)
            .applyImmediately(true)
            .logDeliveryConfigurations(            
                ClusterLogDeliveryConfigurationArgs.builder()
                    .destination(aws_cloudwatch_log_group.example().name())
                    .destinationType("cloudwatch-logs")
                    .logFormat("text")
                    .logType("slow-log")
                    .build(),
                ClusterLogDeliveryConfigurationArgs.builder()
                    .destination(aws_kinesis_firehose_delivery_stream.example().name())
                    .destinationType("kinesis-firehose")
                    .logFormat("json")
                    .logType("engine-log")
                    .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test = aws.elasticache.Cluster("test",
    engine="redis",
    node_type="cache.t3.micro",
    num_cache_nodes=1,
    port=6379,
    apply_immediately=True,
    log_delivery_configurations=[
        aws.elasticache.ClusterLogDeliveryConfigurationArgs(
            destination=aws_cloudwatch_log_group["example"]["name"],
            destination_type="cloudwatch-logs",
            log_format="text",
            log_type="slow-log",
        ),
        aws.elasticache.ClusterLogDeliveryConfigurationArgs(
            destination=aws_kinesis_firehose_delivery_stream["example"]["name"],
            destination_type="kinesis-firehose",
            log_format="json",
            log_type="engine-log",
        ),
    ])

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

const test = new aws.elasticache.Cluster("test", {
    engine: "redis",
    nodeType: "cache.t3.micro",
    numCacheNodes: 1,
    port: 6379,
    applyImmediately: true,
    logDeliveryConfigurations: [
        {
            destination: aws_cloudwatch_log_group.example.name,
            destinationType: "cloudwatch-logs",
            logFormat: "text",
            logType: "slow-log",
        },
        {
            destination: aws_kinesis_firehose_delivery_stream.example.name,
            destinationType: "kinesis-firehose",
            logFormat: "json",
            logType: "engine-log",
        },
    ],
});

resources:
  test:
    type: aws:elasticache:Cluster
    properties:
      engine: redis
      nodeType: cache.t3.micro
      numCacheNodes: 1
      port: 6379
      applyImmediately: true
      logDeliveryConfigurations:
        - destination: ${aws_cloudwatch_log_group.example.name}
          destinationType: cloudwatch-logs
          logFormat: text
          logType: slow-log
        - destination: ${aws_kinesis_firehose_delivery_stream.example.name}
          destinationType: kinesis-firehose
          logFormat: json
          logType: engine-log

Create Cluster Resource

new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            apply_immediately: Optional[bool] = None,
            auto_minor_version_upgrade: Optional[str] = None,
            availability_zone: Optional[str] = None,
            az_mode: Optional[str] = None,
            cluster_id: Optional[str] = None,
            engine: Optional[str] = None,
            engine_version: Optional[str] = None,
            final_snapshot_identifier: Optional[str] = None,
            ip_discovery: Optional[str] = None,
            log_delivery_configurations: Optional[Sequence[ClusterLogDeliveryConfigurationArgs]] = None,
            maintenance_window: Optional[str] = None,
            network_type: Optional[str] = None,
            node_type: Optional[str] = None,
            notification_topic_arn: Optional[str] = None,
            num_cache_nodes: Optional[int] = None,
            outpost_mode: Optional[str] = None,
            parameter_group_name: Optional[str] = None,
            port: Optional[int] = None,
            preferred_availability_zones: Optional[Sequence[str]] = None,
            preferred_outpost_arn: Optional[str] = None,
            replication_group_id: Optional[str] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            security_group_names: Optional[Sequence[str]] = None,
            snapshot_arns: Optional[str] = None,
            snapshot_name: Optional[str] = None,
            snapshot_retention_limit: Optional[int] = None,
            snapshot_window: Optional[str] = None,
            subnet_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
@overload
def Cluster(resource_name: str,
            args: Optional[ClusterArgs] = None,
            opts: Optional[ResourceOptions] = None)

func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)

public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: aws:elasticache:Cluster
properties: # The arguments to resource properties.
options: # 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.

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.

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:

ApplyImmediately bool

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

AutoMinorVersionUpgrade string

Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Only supported for engine type "redis" and if the engine version is 6 or higher. Defaults to true.

AvailabilityZone string

Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.

AzMode string

Whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter are single-az or cross-az, default is single-az. If you want to choose cross-az, num_cache_nodes must be greater than 1.

ClusterId string

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

Engine string

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

EngineVersion string

Version number of the cache engine to be used. If not set, defaults to the latest version. See Describe Cache Engine Versions in the AWS Documentation for supported versions. When engine is redis and the version is 6 or higher, the major and minor version can be set, e.g., 6.2, or the minor version can be unspecified which will use the latest version at creation time, e.g., 6.x. Otherwise, specify the full version desired, e.g., 5.0.6. The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below.

FinalSnapshotIdentifier string

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

IpDiscovery string

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

LogDeliveryConfigurations List<ClusterLogDeliveryConfigurationArgs>

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

MaintenanceWindow string

Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:05:00-sun:09:00.

NetworkType string

The IP versions for cache cluster connections. IPv6 is supported with Redis engine 6.2 onword or Memcached version 1.6.6 for all Nitro system instances. Valid values are ipv4, ipv6 or dual_stack.

NodeType string

The instance class used. See AWS documentation for information on supported node types for Redis and guidance on selecting node types for Redis. See AWS documentation for information on supported node types for Memcached and guidance on selecting node types for Memcached. For Memcached, changing this value will re-create the resource.

NotificationTopicArn string

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

NumCacheNodes int

The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed.

OutpostMode string

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

ParameterGroupName string

The name of the parameter group to associate with this cache cluster.

Port int

The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id. Changing this value will re-create the resource.

PreferredAvailabilityZones List<string>

List of the Availability Zones in which cache nodes are created. If you are creating your cluster in an Amazon VPC you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of num_cache_nodes. If you want all the nodes in the same Availability Zone, use availability_zone instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones. Detecting drift of existing node availability zone is not currently supported. Updating this argument by itself to migrate existing node availability zones is not currently supported and will show a perpetual difference.

PreferredOutpostArn string

The outpost ARN in which the cache cluster will be created.

ReplicationGroupId string

ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

SecurityGroupIds List<string>

One or more VPC security groups associated with the cache cluster

SecurityGroupNames List<string>

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

SnapshotArns string

Single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. The object name cannot contain any commas. Changing snapshot_arns forces a new resource.

SnapshotName string

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

SnapshotRetentionLimit int

Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a snapshot_retention_limit is not supported on cache.t1.micro cache nodes

SnapshotWindow string

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

SubnetGroupName string

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

Tags Dictionary<string, string>

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.

ApplyImmediately bool

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

AutoMinorVersionUpgrade string

AvailabilityZone string

AzMode string

ClusterId string

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

Engine string

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

EngineVersion string

FinalSnapshotIdentifier string

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

IpDiscovery string

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

LogDeliveryConfigurations []ClusterLogDeliveryConfigurationArgs

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

MaintenanceWindow string

NetworkType string

NodeType string

NotificationTopicArn string

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

NumCacheNodes int

OutpostMode string

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

ParameterGroupName string

The name of the parameter group to associate with this cache cluster.

Port int

PreferredAvailabilityZones []string

PreferredOutpostArn string

The outpost ARN in which the cache cluster will be created.

ReplicationGroupId string

SecurityGroupIds []string

One or more VPC security groups associated with the cache cluster

SecurityGroupNames []string

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

SnapshotArns string

SnapshotName string

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

SnapshotRetentionLimit int

SnapshotWindow string

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

SubnetGroupName string

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

Tags map[string]string

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.

applyImmediately Boolean

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

autoMinorVersionUpgrade String

availabilityZone String

azMode String

clusterId String

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

engine String

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

engineVersion String

finalSnapshotIdentifier String

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

ipDiscovery String

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

logDeliveryConfigurations List<ClusterLogDeliveryConfigurationArgs>

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

maintenanceWindow String

networkType String

nodeType String

notificationTopicArn String

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

numCacheNodes Integer

outpostMode String

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

parameterGroupName String

The name of the parameter group to associate with this cache cluster.

port Integer

preferredAvailabilityZones List<String>

preferredOutpostArn String

The outpost ARN in which the cache cluster will be created.

replicationGroupId String

securityGroupIds List<String>

One or more VPC security groups associated with the cache cluster

securityGroupNames List<String>

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

snapshotArns String

snapshotName String

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

snapshotRetentionLimit Integer

snapshotWindow String

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

subnetGroupName String

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

tags Map<String,String>

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.

applyImmediately boolean

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

autoMinorVersionUpgrade string

availabilityZone string

azMode string

clusterId string

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

engine string

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

engineVersion string

finalSnapshotIdentifier string

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

ipDiscovery string

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

logDeliveryConfigurations ClusterLogDeliveryConfigurationArgs[]

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

maintenanceWindow string

networkType string

nodeType string

notificationTopicArn string

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

numCacheNodes number

outpostMode string

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

parameterGroupName string

The name of the parameter group to associate with this cache cluster.

port number

preferredAvailabilityZones string[]

preferredOutpostArn string

The outpost ARN in which the cache cluster will be created.

replicationGroupId string

securityGroupIds string[]

One or more VPC security groups associated with the cache cluster

securityGroupNames string[]

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

snapshotArns string

snapshotName string

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

snapshotRetentionLimit number

snapshotWindow string

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

subnetGroupName string

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

tags {[key: string]: string}

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.

apply_immediately bool

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

auto_minor_version_upgrade str

availability_zone str

az_mode str

cluster_id str

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

engine str

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

engine_version str

final_snapshot_identifier str

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

ip_discovery str

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

log_delivery_configurations Sequence[ClusterLogDeliveryConfigurationArgs]

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

maintenance_window str

network_type str

node_type str

notification_topic_arn str

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

num_cache_nodes int

outpost_mode str

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

parameter_group_name str

The name of the parameter group to associate with this cache cluster.

port int

preferred_availability_zones Sequence[str]

preferred_outpost_arn str

The outpost ARN in which the cache cluster will be created.

replication_group_id str

security_group_ids Sequence[str]

One or more VPC security groups associated with the cache cluster

security_group_names Sequence[str]

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

snapshot_arns str

snapshot_name str

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

snapshot_retention_limit int

snapshot_window str

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

subnet_group_name str

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

tags Mapping[str, str]

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.

applyImmediately Boolean

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

autoMinorVersionUpgrade String

availabilityZone String

azMode String

clusterId String

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

engine String

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

engineVersion String

finalSnapshotIdentifier String

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

ipDiscovery String

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

logDeliveryConfigurations List<Property Map>

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

maintenanceWindow String

networkType String

nodeType String

notificationTopicArn String

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

numCacheNodes Number

outpostMode String

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

parameterGroupName String

The name of the parameter group to associate with this cache cluster.

port Number

preferredAvailabilityZones List<String>

preferredOutpostArn String

The outpost ARN in which the cache cluster will be created.

replicationGroupId String

securityGroupIds List<String>

One or more VPC security groups associated with the cache cluster

securityGroupNames List<String>

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

snapshotArns String

snapshotName String

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

snapshotRetentionLimit Number

snapshotWindow String

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

subnetGroupName String

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

tags Map<String>

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.

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 created ElastiCache Cluster.
CacheNodes List<ClusterCacheNode>: List of node objects including id, address, port and availability_zone.
ClusterAddress string: (Memcached only) DNS name of the cache cluster without the port appended.
ConfigurationEndpoint string: (Memcached only) Configuration endpoint to allow host discovery.
EngineVersionActual string: Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
Id string: The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: The ARN of the created ElastiCache Cluster.
CacheNodes []ClusterCacheNode: List of node objects including id, address, port and availability_zone.
ClusterAddress string: (Memcached only) DNS name of the cache cluster without the port appended.
ConfigurationEndpoint string: (Memcached only) Configuration endpoint to allow host discovery.
EngineVersionActual string: Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
Id string: The provider-assigned unique ID for this managed resource.
TagsAll map[string]string: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The ARN of the created ElastiCache Cluster.
cacheNodes List<ClusterCacheNode>: List of node objects including id, address, port and availability_zone.
clusterAddress String: (Memcached only) DNS name of the cache cluster without the port appended.
configurationEndpoint String: (Memcached only) Configuration endpoint to allow host discovery.
engineVersionActual String: Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: The ARN of the created ElastiCache Cluster.
cacheNodes ClusterCacheNode[]: List of node objects including id, address, port and availability_zone.
clusterAddress string: (Memcached only) DNS name of the cache cluster without the port appended.
configurationEndpoint string: (Memcached only) Configuration endpoint to allow host discovery.
engineVersionActual string: Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
id string: The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: The ARN of the created ElastiCache Cluster.
cache_nodes Sequence[ClusterCacheNode]: List of node objects including id, address, port and availability_zone.
cluster_address str: (Memcached only) DNS name of the cache cluster without the port appended.
configuration_endpoint str: (Memcached only) Configuration endpoint to allow host discovery.
engine_version_actual str: Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
id str: The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The ARN of the created ElastiCache Cluster.
cacheNodes List<Property Map>: List of node objects including id, address, port and availability_zone.
clusterAddress String: (Memcached only) DNS name of the cache cluster without the port appended.
configurationEndpoint String: (Memcached only) Configuration endpoint to allow host discovery.
engineVersionActual String: Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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,
        apply_immediately: Optional[bool] = None,
        arn: Optional[str] = None,
        auto_minor_version_upgrade: Optional[str] = None,
        availability_zone: Optional[str] = None,
        az_mode: Optional[str] = None,
        cache_nodes: Optional[Sequence[ClusterCacheNodeArgs]] = None,
        cluster_address: Optional[str] = None,
        cluster_id: Optional[str] = None,
        configuration_endpoint: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        engine_version_actual: Optional[str] = None,
        final_snapshot_identifier: Optional[str] = None,
        ip_discovery: Optional[str] = None,
        log_delivery_configurations: Optional[Sequence[ClusterLogDeliveryConfigurationArgs]] = None,
        maintenance_window: Optional[str] = None,
        network_type: Optional[str] = None,
        node_type: Optional[str] = None,
        notification_topic_arn: Optional[str] = None,
        num_cache_nodes: Optional[int] = None,
        outpost_mode: Optional[str] = None,
        parameter_group_name: Optional[str] = None,
        port: Optional[int] = None,
        preferred_availability_zones: Optional[Sequence[str]] = None,
        preferred_outpost_arn: Optional[str] = None,
        replication_group_id: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        security_group_names: Optional[Sequence[str]] = None,
        snapshot_arns: Optional[str] = None,
        snapshot_name: Optional[str] = None,
        snapshot_retention_limit: Optional[int] = None,
        snapshot_window: Optional[str] = None,
        subnet_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = 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:

ApplyImmediately bool

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

Arn string

The ARN of the created ElastiCache Cluster.

AutoMinorVersionUpgrade string

AvailabilityZone string

AzMode string

CacheNodes List<ClusterCacheNodeArgs>

List of node objects including id, address, port and availability_zone.

ClusterAddress string

(Memcached only) DNS name of the cache cluster without the port appended.

ClusterId string

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

ConfigurationEndpoint string

(Memcached only) Configuration endpoint to allow host discovery.

Engine string

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

EngineVersion string

EngineVersionActual string

Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.

FinalSnapshotIdentifier string

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

IpDiscovery string

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

LogDeliveryConfigurations List<ClusterLogDeliveryConfigurationArgs>

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

MaintenanceWindow string

NetworkType string

NodeType string

NotificationTopicArn string

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

NumCacheNodes int

OutpostMode string

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

ParameterGroupName string

The name of the parameter group to associate with this cache cluster.

Port int

PreferredAvailabilityZones List<string>

PreferredOutpostArn string

The outpost ARN in which the cache cluster will be created.

ReplicationGroupId string

SecurityGroupIds List<string>

One or more VPC security groups associated with the cache cluster

SecurityGroupNames List<string>

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

SnapshotArns string

SnapshotName string

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

SnapshotRetentionLimit int

SnapshotWindow string

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

SubnetGroupName string

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

Tags Dictionary<string, string>

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>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

ApplyImmediately bool

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

Arn string

The ARN of the created ElastiCache Cluster.

AutoMinorVersionUpgrade string

AvailabilityZone string

AzMode string

CacheNodes []ClusterCacheNodeArgs

List of node objects including id, address, port and availability_zone.

ClusterAddress string

(Memcached only) DNS name of the cache cluster without the port appended.

ClusterId string

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

ConfigurationEndpoint string

(Memcached only) Configuration endpoint to allow host discovery.

Engine string

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

EngineVersion string

EngineVersionActual string

Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.

FinalSnapshotIdentifier string

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

IpDiscovery string

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

LogDeliveryConfigurations []ClusterLogDeliveryConfigurationArgs

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

MaintenanceWindow string

NetworkType string

NodeType string

NotificationTopicArn string

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

NumCacheNodes int

OutpostMode string

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

ParameterGroupName string

The name of the parameter group to associate with this cache cluster.

Port int

PreferredAvailabilityZones []string

PreferredOutpostArn string

The outpost ARN in which the cache cluster will be created.

ReplicationGroupId string

SecurityGroupIds []string

One or more VPC security groups associated with the cache cluster

SecurityGroupNames []string

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

SnapshotArns string

SnapshotName string

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

SnapshotRetentionLimit int

SnapshotWindow string

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

SubnetGroupName string

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

Tags map[string]string

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

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

applyImmediately Boolean

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

arn String

The ARN of the created ElastiCache Cluster.

autoMinorVersionUpgrade String

availabilityZone String

azMode String

cacheNodes List<ClusterCacheNodeArgs>

List of node objects including id, address, port and availability_zone.

clusterAddress String

(Memcached only) DNS name of the cache cluster without the port appended.

clusterId String

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

configurationEndpoint String

(Memcached only) Configuration endpoint to allow host discovery.

engine String

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

engineVersion String

engineVersionActual String

Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.

finalSnapshotIdentifier String

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

ipDiscovery String

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

logDeliveryConfigurations List<ClusterLogDeliveryConfigurationArgs>

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

maintenanceWindow String

networkType String

nodeType String

notificationTopicArn String

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

numCacheNodes Integer

outpostMode String

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

parameterGroupName String

The name of the parameter group to associate with this cache cluster.

port Integer

preferredAvailabilityZones List<String>

preferredOutpostArn String

The outpost ARN in which the cache cluster will be created.

replicationGroupId String

securityGroupIds List<String>

One or more VPC security groups associated with the cache cluster

securityGroupNames List<String>

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

snapshotArns String

snapshotName String

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

snapshotRetentionLimit Integer

snapshotWindow String

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

subnetGroupName String

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

tags Map<String,String>

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>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

applyImmediately boolean

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

arn string

The ARN of the created ElastiCache Cluster.

autoMinorVersionUpgrade string

availabilityZone string

azMode string

cacheNodes ClusterCacheNodeArgs[]

List of node objects including id, address, port and availability_zone.

clusterAddress string

(Memcached only) DNS name of the cache cluster without the port appended.

clusterId string

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

configurationEndpoint string

(Memcached only) Configuration endpoint to allow host discovery.

engine string

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

engineVersion string

engineVersionActual string

Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.

finalSnapshotIdentifier string

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

ipDiscovery string

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

logDeliveryConfigurations ClusterLogDeliveryConfigurationArgs[]

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

maintenanceWindow string

networkType string

nodeType string

notificationTopicArn string

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

numCacheNodes number

outpostMode string

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

parameterGroupName string

The name of the parameter group to associate with this cache cluster.

port number

preferredAvailabilityZones string[]

preferredOutpostArn string

The outpost ARN in which the cache cluster will be created.

replicationGroupId string

securityGroupIds string[]

One or more VPC security groups associated with the cache cluster

securityGroupNames string[]

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

snapshotArns string

snapshotName string

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

snapshotRetentionLimit number

snapshotWindow string

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

subnetGroupName string

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

tags {[key: string]: string}

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}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

apply_immediately bool

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

arn str

The ARN of the created ElastiCache Cluster.

auto_minor_version_upgrade str

availability_zone str

az_mode str

cache_nodes Sequence[ClusterCacheNodeArgs]

List of node objects including id, address, port and availability_zone.

cluster_address str

(Memcached only) DNS name of the cache cluster without the port appended.

cluster_id str

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

configuration_endpoint str

(Memcached only) Configuration endpoint to allow host discovery.

engine str

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

engine_version str

engine_version_actual str

Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.

final_snapshot_identifier str

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

ip_discovery str

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

log_delivery_configurations Sequence[ClusterLogDeliveryConfigurationArgs]

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

maintenance_window str

network_type str

node_type str

notification_topic_arn str

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

num_cache_nodes int

outpost_mode str

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

parameter_group_name str

The name of the parameter group to associate with this cache cluster.

port int

preferred_availability_zones Sequence[str]

preferred_outpost_arn str

The outpost ARN in which the cache cluster will be created.

replication_group_id str

security_group_ids Sequence[str]

One or more VPC security groups associated with the cache cluster

security_group_names Sequence[str]

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

snapshot_arns str

snapshot_name str

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

snapshot_retention_limit int

snapshot_window str

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

subnet_group_name str

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

tags Mapping[str, str]

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]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

applyImmediately Boolean

Whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon ElastiCache Documentation for more information..

arn String

The ARN of the created ElastiCache Cluster.

autoMinorVersionUpgrade String

availabilityZone String

azMode String

cacheNodes List<Property Map>

List of node objects including id, address, port and availability_zone.

clusterAddress String

(Memcached only) DNS name of the cache cluster without the port appended.

clusterId String

Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

configurationEndpoint String

(Memcached only) Configuration endpoint to allow host discovery.

engine String

Name of the cache engine to be used for this cache cluster. Valid values are memcached or redis.

engineVersion String

engineVersionActual String

Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.

finalSnapshotIdentifier String

Name of your final cluster snapshot. If omitted, no final snapshot will be made.

ipDiscovery String

The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6.

logDeliveryConfigurations List<Property Map>

Specifies the destination and format of Redis SLOWLOG or Redis Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details.

maintenanceWindow String

networkType String

nodeType String

notificationTopicArn String

ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic.

numCacheNodes Number

outpostMode String

Specify the outpost mode that will apply to the cache cluster creation. Valid values are "single-outpost" and "cross-outpost", however AWS currently only supports "single-outpost" mode.

parameterGroupName String

The name of the parameter group to associate with this cache cluster.

port Number

preferredAvailabilityZones List<String>

preferredOutpostArn String

The outpost ARN in which the cache cluster will be created.

replicationGroupId String

securityGroupIds List<String>

One or more VPC security groups associated with the cache cluster

securityGroupNames List<String>

List of security group names to associate with this cache cluster. Changing this value will re-create the resource.

Deprecated:

With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.

snapshotArns String

snapshotName String

Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource.

snapshotRetentionLimit Number

snapshotWindow String

Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00

subnetGroupName String

Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource.

tags Map<String>

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>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Supporting Types

ClusterCacheNode

Address string
AvailabilityZone string: Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.
Id string
OutpostArn string
Port int: The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id. Changing this value will re-create the resource.

Address string
AvailabilityZone string: Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.
Id string
OutpostArn string
Port int: The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id. Changing this value will re-create the resource.

address String
availabilityZone String: Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.
id String
outpostArn String
port Integer: The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id. Changing this value will re-create the resource.

address string
availabilityZone string: Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.
id string
outpostArn string
port number: The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id. Changing this value will re-create the resource.

address str
availability_zone str: Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.
id str
outpost_arn str
port int: The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id. Changing this value will re-create the resource.

address String
availabilityZone String: Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.
id String
outpostArn String
port Number: The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id. Changing this value will re-create the resource.

ClusterLogDeliveryConfiguration

Destination string: Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource.
DestinationType string: For CloudWatch Logs use cloudwatch-logs or for Kinesis Data Firehose use kinesis-firehose.
LogFormat string: Valid values are json or text
LogType string: Valid values are slow-log or engine-log. Max 1 of each.

Destination string: Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource.
DestinationType string: For CloudWatch Logs use cloudwatch-logs or for Kinesis Data Firehose use kinesis-firehose.
LogFormat string: Valid values are json or text
LogType string: Valid values are slow-log or engine-log. Max 1 of each.

destination String: Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource.
destinationType String: For CloudWatch Logs use cloudwatch-logs or for Kinesis Data Firehose use kinesis-firehose.
logFormat String: Valid values are json or text
logType String: Valid values are slow-log or engine-log. Max 1 of each.

destination string: Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource.
destinationType string: For CloudWatch Logs use cloudwatch-logs or for Kinesis Data Firehose use kinesis-firehose.
logFormat string: Valid values are json or text
logType string: Valid values are slow-log or engine-log. Max 1 of each.

destination str: Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource.
destination_type str: For CloudWatch Logs use cloudwatch-logs or for Kinesis Data Firehose use kinesis-firehose.
log_format str: Valid values are json or text
log_type str: Valid values are slow-log or engine-log. Max 1 of each.

destination String: Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource.
destinationType String: For CloudWatch Logs use cloudwatch-logs or for Kinesis Data Firehose use kinesis-firehose.
logFormat String: Valid values are json or text
logType String: Valid values are slow-log or engine-log. Max 1 of each.

Import

ElastiCache Clusters can be imported using the cluster_id, e.g.,

 $ pulumi import aws:elasticache/cluster:Cluster my_cluster my_cluster

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

aws.elasticache.Cluster

Example Usage

Memcached Cluster

Redis Instance

Redis Cluster Mode Disabled Read Replica Instance

Redis Log Delivery configuration

Create Cluster Resource

Cluster Resource Properties

Inputs

Outputs

Look up Existing Cluster Resource

Supporting Types

ClusterCacheNode

ClusterLogDeliveryConfiguration

Import

Package Details

On this page

On this page