Module elasticache

elasticache

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
class pulumi_aws.elasticache.AwaitableGetClusterResult(arn=None, availability_zone=None, cache_nodes=None, cluster_address=None, cluster_id=None, configuration_endpoint=None, engine=None, engine_version=None, maintenance_window=None, node_type=None, notification_topic_arn=None, num_cache_nodes=None, parameter_group_name=None, port=None, replication_group_id=None, security_group_ids=None, security_group_names=None, snapshot_retention_limit=None, snapshot_window=None, subnet_group_name=None, tags=None, id=None)
class pulumi_aws.elasticache.AwaitableGetReplicationGroupResult(auth_token_enabled=None, automatic_failover_enabled=None, configuration_endpoint_address=None, member_clusters=None, node_type=None, number_cache_clusters=None, port=None, primary_endpoint_address=None, replication_group_description=None, replication_group_id=None, snapshot_retention_limit=None, snapshot_window=None, id=None)
class pulumi_aws.elasticache.Cluster(resource_name, opts=None, apply_immediately=None, availability_zone=None, az_mode=None, cluster_id=None, engine=None, engine_version=None, maintenance_window=None, node_type=None, notification_topic_arn=None, num_cache_nodes=None, parameter_group_name=None, port=None, preferred_availability_zones=None, replication_group_id=None, security_group_ids=None, security_group_names=None, snapshot_arns=None, snapshot_name=None, snapshot_retention_limit=None, snapshot_window=None, subnet_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides an ElastiCache Cluster resource, which manages a Memcached cluster or Redis instance. For working with Redis (Cluster Mode Enabled) replication groups, see the ``elasticache.ReplicationGroup` resource <https://www.terraform.io/docs/providers/aws/r/elasticache_replication_group.html>`_.

Note: When you change an attribute, such as node_type, 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 Docs on [Modifying an ElastiCache Cache Cluster][2] for more information.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • apply_immediately (pulumi.Input[bool]) – Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See [Amazon ElastiCache Documentation for more information.][1] (Available since v0.6.0)
  • availability_zone (pulumi.Input[str]) – The 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.
  • az_mode (pulumi.Input[str]) – Specifies 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
  • cluster_id (pulumi.Input[str]) – Group identifier. ElastiCache converts this name to lowercase
  • engine (pulumi.Input[str]) – Name of the cache engine to be used for this cache cluster. Valid values for this parameter are memcached or redis
  • engine_version (pulumi.Input[str]) – Version number of the cache engine to be used. See Describe Cache Engine Versions in the AWS Documentation center for supported versions
  • maintenance_window (pulumi.Input[str]) – 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
  • node_type (pulumi.Input[str]) – The compute and memory capacity of the nodes. See Available Cache Node Types for supported node types
  • notification_topic_arn (pulumi.Input[str]) – An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic
  • num_cache_nodes (pulumi.Input[float]) – The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcache, this value must be between 1 and 20. If this number is reduced on subsequent runs, the highest numbered nodes will be removed.
  • parameter_group_name (pulumi.Input[str]) – Name of the parameter group to associate with this cache cluster
  • port (pulumi.Input[float]) – The port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id.
  • preferred_availability_zones (pulumi.Input[list]) – A 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.
  • replication_group_id (pulumi.Input[str]) – The 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.
  • security_group_ids (pulumi.Input[list]) – One or more VPC security groups associated with the cache cluster
  • security_group_names (pulumi.Input[list]) – List of security group names to associate with this cache cluster
  • snapshot_arns (pulumi.Input[list]) – A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. Example: arn:aws:s3:::my_bucket/snapshot1.rdb
  • snapshot_name (pulumi.Input[str]) – The name of a snapshot from which to restore data into the new node group. Changing the snapshot_name forces a new resource.
  • snapshot_retention_limit (pulumi.Input[float]) – The 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 or cache.t2.* cache nodes
  • snapshot_window (pulumi.Input[str]) – The 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 (pulumi.Input[str]) – Name of the subnet group to be used for the cache cluster.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource
apply_immediately = None

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See [Amazon ElastiCache Documentation for more information.][1] (Available since v0.6.0)

availability_zone = None

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

az_mode = None

Specifies 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

cache_nodes = None

List of node objects including id, address, port and availability_zone. Referenceable e.g. as ${aws_elasticache_cluster.bar.cache_nodes.0.address}

cluster_address = None

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

cluster_id = None

Group identifier. ElastiCache converts this name to lowercase

configuration_endpoint = None

(Memcached only) The configuration endpoint to allow host discovery.

engine = None

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

engine_version = None

Version number of the cache engine to be used. See Describe Cache Engine Versions in the AWS Documentation center for supported versions

maintenance_window = None

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

node_type = None

The compute and memory capacity of the nodes. See Available Cache Node Types for supported node types

notification_topic_arn = None

An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic

num_cache_nodes = None

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

parameter_group_name = None

Name of the parameter group to associate with this cache cluster

port = None

The port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id.

preferred_availability_zones = None

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

replication_group_id = None

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

security_group_ids = None

One or more VPC security groups associated with the cache cluster

security_group_names = None

List of security group names to associate with this cache cluster

snapshot_arns = None

A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. Example: arn:aws:s3:::my_bucket/snapshot1.rdb

snapshot_name = None

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

snapshot_retention_limit = None

The 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 or cache.t2.* cache nodes

snapshot_window = None

The 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 = None

Name of the subnet group to be used for the cache cluster.

tags = None

A mapping of tags to assign to the resource

static get(resource_name, id, opts=None, apply_immediately=None, availability_zone=None, az_mode=None, cache_nodes=None, cluster_address=None, cluster_id=None, configuration_endpoint=None, engine=None, engine_version=None, maintenance_window=None, node_type=None, notification_topic_arn=None, num_cache_nodes=None, parameter_group_name=None, port=None, preferred_availability_zones=None, replication_group_id=None, security_group_ids=None, security_group_names=None, snapshot_arns=None, snapshot_name=None, snapshot_retention_limit=None, snapshot_window=None, subnet_group_name=None, tags=None)

Get an existing Cluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] apply_immediately: Specifies whether any database modifications

are applied immediately, or during the next maintenance window. Default is false. See [Amazon ElastiCache Documentation for more information.][1] (Available since v0.6.0)
Parameters:
  • availability_zone (pulumi.Input[str]) – The 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.
  • az_mode (pulumi.Input[str]) – Specifies 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
  • cache_nodes (pulumi.Input[list]) – List of node objects including id, address, port and availability_zone. Referenceable e.g. as ${aws_elasticache_cluster.bar.cache_nodes.0.address}
  • cluster_address (pulumi.Input[str]) – (Memcached only) The DNS name of the cache cluster without the port appended.
  • cluster_id (pulumi.Input[str]) – Group identifier. ElastiCache converts this name to lowercase
  • configuration_endpoint (pulumi.Input[str]) – (Memcached only) The configuration endpoint to allow host discovery.
  • engine (pulumi.Input[str]) – Name of the cache engine to be used for this cache cluster. Valid values for this parameter are memcached or redis
  • engine_version (pulumi.Input[str]) –

    Version number of the cache engine to be used. See Describe Cache Engine Versions in the AWS Documentation center for supported versions

  • maintenance_window (pulumi.Input[str]) – 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
  • node_type (pulumi.Input[str]) –

    The compute and memory capacity of the nodes. See Available Cache Node Types for supported node types

  • notification_topic_arn (pulumi.Input[str]) – An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic
  • num_cache_nodes (pulumi.Input[float]) – The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcache, this value must be between 1 and 20. If this number is reduced on subsequent runs, the highest numbered nodes will be removed.
  • parameter_group_name (pulumi.Input[str]) – Name of the parameter group to associate with this cache cluster
  • port (pulumi.Input[float]) – The port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id.
  • preferred_availability_zones (pulumi.Input[list]) – A 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.
  • replication_group_id (pulumi.Input[str]) – The 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.
  • security_group_ids (pulumi.Input[list]) – One or more VPC security groups associated with the cache cluster
  • security_group_names (pulumi.Input[list]) – List of security group names to associate with this cache cluster
  • snapshot_arns (pulumi.Input[list]) – A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. Example: arn:aws:s3:::my_bucket/snapshot1.rdb
  • snapshot_name (pulumi.Input[str]) – The name of a snapshot from which to restore data into the new node group. Changing the snapshot_name forces a new resource.
  • snapshot_retention_limit (pulumi.Input[float]) – The 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 or cache.t2.* cache nodes
  • snapshot_window (pulumi.Input[str]) – The 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 (pulumi.Input[str]) – Name of the subnet group to be used for the cache cluster.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.elasticache.GetClusterResult(arn=None, availability_zone=None, cache_nodes=None, cluster_address=None, cluster_id=None, configuration_endpoint=None, engine=None, engine_version=None, maintenance_window=None, node_type=None, notification_topic_arn=None, num_cache_nodes=None, parameter_group_name=None, port=None, replication_group_id=None, security_group_ids=None, security_group_names=None, snapshot_retention_limit=None, snapshot_window=None, subnet_group_name=None, tags=None, id=None)

A collection of values returned by getCluster.

availability_zone = None

The Availability Zone for the cache cluster.

cache_nodes = None

List of node objects including id, address, port and availability_zone. Referenceable e.g. as ${data.aws_elasticache_cluster.bar.cache_nodes.0.address}

cluster_address = None

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

configuration_endpoint = None

(Memcached only) The configuration endpoint to allow host discovery.

engine = None

Name of the cache engine.

engine_version = None

Version number of the cache engine.

maintenance_window = None

Specifies the weekly time range for when maintenance on the cache cluster is performed.

node_type = None

The cluster node type.

notification_topic_arn = None

An Amazon Resource Name (ARN) of an SNS topic that ElastiCache notifications get sent to.

num_cache_nodes = None

The number of cache nodes that the cache cluster has.

parameter_group_name = None

Name of the parameter group associated with this cache cluster.

port = None

The port number on which each of the cache nodes will accept connections.

replication_group_id = None

The replication group to which this cache cluster belongs.

security_group_ids = None

List VPC security groups associated with the cache cluster.

security_group_names = None

List of security group names associated with this cache cluster.

snapshot_retention_limit = None

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.

snapshot_window = None

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster.

subnet_group_name = None

Name of the subnet group associated to the cache cluster.

tags = None

The tags assigned to the resource

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.elasticache.GetReplicationGroupResult(auth_token_enabled=None, automatic_failover_enabled=None, configuration_endpoint_address=None, member_clusters=None, node_type=None, number_cache_clusters=None, port=None, primary_endpoint_address=None, replication_group_description=None, replication_group_id=None, snapshot_retention_limit=None, snapshot_window=None, id=None)

A collection of values returned by getReplicationGroup.

auth_token_enabled = None

A flag that enables using an AuthToken (password) when issuing Redis commands.

automatic_failover_enabled = None

A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.

configuration_endpoint_address = None

The configuration endpoint address to allow host discovery.

member_clusters = None

The identifiers of all the nodes that are part of this replication group.

node_type = None

The cluster node type.

number_cache_clusters = None

The number of cache clusters that the replication group has.

port = None

The port number on which the configuration endpoint will accept connections.

primary_endpoint_address = None

The endpoint of the primary node in this node group (shard).

replication_group_description = None

The description of the replication group.

replication_group_id = None

The identifier for the replication group.

snapshot_retention_limit = None

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.

snapshot_window = None

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.elasticache.ParameterGroup(resource_name, opts=None, description=None, family=None, name=None, parameters=None, __props__=None, __name__=None, __opts__=None)

Provides an ElastiCache parameter group resource.

NOTE: Attempting to remove the reserved-memory parameter when family is set to redis2.6 or redis2.8 may show a perpetual difference in this provider due to an Elasticache API limitation. Leave that parameter configured with any value to workaround the issue.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
  • family (pulumi.Input[str]) – The family of the ElastiCache parameter group.
  • name (pulumi.Input[str]) – The name of the ElastiCache parameter.
  • parameters (pulumi.Input[list]) – A list of ElastiCache parameters to apply.
description = None

The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.

family = None

The family of the ElastiCache parameter group.

name = None

The name of the ElastiCache parameter.

parameters = None

A list of ElastiCache parameters to apply.

static get(resource_name, id, opts=None, description=None, family=None, name=None, parameters=None)

Get an existing ParameterGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”. :param pulumi.Input[str] family: The family of the ElastiCache parameter group. :param pulumi.Input[str] name: The name of the ElastiCache parameter. :param pulumi.Input[list] parameters: A list of ElastiCache parameters to apply.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.elasticache.ReplicationGroup(resource_name, opts=None, apply_immediately=None, at_rest_encryption_enabled=None, auth_token=None, auto_minor_version_upgrade=None, automatic_failover_enabled=None, availability_zones=None, cluster_mode=None, engine=None, engine_version=None, maintenance_window=None, node_type=None, notification_topic_arn=None, number_cache_clusters=None, parameter_group_name=None, port=None, replication_group_description=None, replication_group_id=None, security_group_ids=None, security_group_names=None, snapshot_arns=None, snapshot_name=None, snapshot_retention_limit=None, snapshot_window=None, subnet_group_name=None, tags=None, transit_encryption_enabled=None, __props__=None, __name__=None, __opts__=None)

Provides an ElastiCache Replication Group resource. For working with Memcached or single primary Redis instances (Cluster Mode Disabled), see the ``elasticache.Cluster` resource <https://www.terraform.io/docs/providers/aws/r/elasticache_cluster.html>`_.

Note: When you change an attribute, such as engine_version, by default the ElastiCache API applies it 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 servers reboots.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • apply_immediately (pulumi.Input[bool]) – Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false.
  • at_rest_encryption_enabled (pulumi.Input[bool]) – Whether to enable encryption at rest.
  • auth_token (pulumi.Input[str]) – The password used to access a password protected server. Can be specified only if transit_encryption_enabled = true.
  • auto_minor_version_upgrade (pulumi.Input[bool]) – Specifies whether a minor engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Defaults to true.
  • automatic_failover_enabled (pulumi.Input[bool]) – Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to false.
  • availability_zones (pulumi.Input[list]) – A list of EC2 availability zones in which the replication group’s cache clusters will be created. The order of the availability zones in the list is not important.
  • cluster_mode (pulumi.Input[dict]) – Create a native redis cluster. automatic_failover_enabled must be set to true. Cluster Mode documented below. Only 1 cluster_mode block is allowed.
  • engine (pulumi.Input[str]) – The name of the cache engine to be used for the clusters in this replication group. e.g. redis
  • engine_version (pulumi.Input[str]) – The version number of the cache engine to be used for the cache clusters in this replication group.
  • maintenance_window (pulumi.Input[str]) – 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
  • node_type (pulumi.Input[str]) – The compute and memory capacity of the nodes in the node group.
  • notification_topic_arn (pulumi.Input[str]) – An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic
  • number_cache_clusters (pulumi.Input[float]) – The number of cache clusters (primary and replicas) this replication group will have. If Multi-AZ is enabled, the value of this parameter must be at least 2. Updates will occur before other modifications.
  • parameter_group_name (pulumi.Input[str]) – The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
  • port (pulumi.Input[float]) – The port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379.
  • replication_group_description (pulumi.Input[str]) – A user-created description for the replication group.
  • replication_group_id (pulumi.Input[str]) – The replication group identifier. This parameter is stored as a lowercase string.
  • security_group_ids (pulumi.Input[list]) – One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud
  • security_group_names (pulumi.Input[list]) – A list of cache security group names to associate with this replication group.
  • snapshot_arns (pulumi.Input[list]) – A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. Example: arn:aws:s3:::my_bucket/snapshot1.rdb
  • snapshot_name (pulumi.Input[str]) – The name of a snapshot from which to restore data into the new node group. Changing the snapshot_name forces a new resource.
  • snapshot_retention_limit (pulumi.Input[float]) – The 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 or cache.t2.* cache nodes
  • snapshot_window (pulumi.Input[str]) – The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: 05:00-09:00
  • subnet_group_name (pulumi.Input[str]) – The name of the cache subnet group to be used for the replication group.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource
  • transit_encryption_enabled (pulumi.Input[bool]) – Whether to enable encryption in transit.
apply_immediately = None

Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false.

at_rest_encryption_enabled = None

Whether to enable encryption at rest.

auth_token = None

The password used to access a password protected server. Can be specified only if transit_encryption_enabled = true.

auto_minor_version_upgrade = None

Specifies whether a minor engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Defaults to true.

automatic_failover_enabled = None

Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to false.

availability_zones = None

A list of EC2 availability zones in which the replication group’s cache clusters will be created. The order of the availability zones in the list is not important.

cluster_mode = None

Create a native redis cluster. automatic_failover_enabled must be set to true. Cluster Mode documented below. Only 1 cluster_mode block is allowed.

configuration_endpoint_address = None

The address of the replication group configuration endpoint when cluster mode is enabled.

engine = None

The name of the cache engine to be used for the clusters in this replication group. e.g. redis

engine_version = None

The version number of the cache engine to be used for the cache clusters in this replication group.

maintenance_window = None

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

member_clusters = None

The identifiers of all the nodes that are part of this replication group.

node_type = None

The compute and memory capacity of the nodes in the node group.

notification_topic_arn = None

An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic

number_cache_clusters = None

The number of cache clusters (primary and replicas) this replication group will have. If Multi-AZ is enabled, the value of this parameter must be at least 2. Updates will occur before other modifications.

parameter_group_name = None

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

port = None

The port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379.

primary_endpoint_address = None

(Redis only) The address of the endpoint for the primary node in the replication group, if the cluster mode is disabled.

replication_group_description = None

A user-created description for the replication group.

replication_group_id = None

The replication group identifier. This parameter is stored as a lowercase string.

security_group_ids = None

One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud

security_group_names = None

A list of cache security group names to associate with this replication group.

snapshot_arns = None

A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. Example: arn:aws:s3:::my_bucket/snapshot1.rdb

snapshot_name = None

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

snapshot_retention_limit = None

The 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 or cache.t2.* cache nodes

snapshot_window = None

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: 05:00-09:00

subnet_group_name = None

The name of the cache subnet group to be used for the replication group.

tags = None

A mapping of tags to assign to the resource

transit_encryption_enabled = None

Whether to enable encryption in transit.

static get(resource_name, id, opts=None, apply_immediately=None, at_rest_encryption_enabled=None, auth_token=None, auto_minor_version_upgrade=None, automatic_failover_enabled=None, availability_zones=None, cluster_mode=None, configuration_endpoint_address=None, engine=None, engine_version=None, maintenance_window=None, member_clusters=None, node_type=None, notification_topic_arn=None, number_cache_clusters=None, parameter_group_name=None, port=None, primary_endpoint_address=None, replication_group_description=None, replication_group_id=None, security_group_ids=None, security_group_names=None, snapshot_arns=None, snapshot_name=None, snapshot_retention_limit=None, snapshot_window=None, subnet_group_name=None, tags=None, transit_encryption_enabled=None)

Get an existing ReplicationGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] apply_immediately: Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. :param pulumi.Input[bool] at_rest_encryption_enabled: Whether to enable encryption at rest. :param pulumi.Input[str] auth_token: The password used to access a password protected server. Can be specified only if transit_encryption_enabled = true. :param pulumi.Input[bool] auto_minor_version_upgrade: Specifies whether a minor engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Defaults to true. :param pulumi.Input[bool] automatic_failover_enabled: Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to false. :param pulumi.Input[list] availability_zones: A list of EC2 availability zones in which the replication group’s cache clusters will be created. The order of the availability zones in the list is not important. :param pulumi.Input[dict] cluster_mode: Create a native redis cluster. automatic_failover_enabled must be set to true. Cluster Mode documented below. Only 1 cluster_mode block is allowed. :param pulumi.Input[str] configuration_endpoint_address: The address of the replication group configuration endpoint when cluster mode is enabled. :param pulumi.Input[str] engine: The name of the cache engine to be used for the clusters in this replication group. e.g. redis :param pulumi.Input[str] engine_version: The version number of the cache engine to be used for the cache clusters in this replication group. :param pulumi.Input[str] maintenance_window: 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
Parameters:
  • member_clusters (pulumi.Input[list]) – The identifiers of all the nodes that are part of this replication group.
  • node_type (pulumi.Input[str]) – The compute and memory capacity of the nodes in the node group.
  • notification_topic_arn (pulumi.Input[str]) – An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic
  • number_cache_clusters (pulumi.Input[float]) – The number of cache clusters (primary and replicas) this replication group will have. If Multi-AZ is enabled, the value of this parameter must be at least 2. Updates will occur before other modifications.
  • parameter_group_name (pulumi.Input[str]) – The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
  • port (pulumi.Input[float]) – The port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379.
  • primary_endpoint_address (pulumi.Input[str]) – (Redis only) The address of the endpoint for the primary node in the replication group, if the cluster mode is disabled.
  • replication_group_description (pulumi.Input[str]) – A user-created description for the replication group.
  • replication_group_id (pulumi.Input[str]) – The replication group identifier. This parameter is stored as a lowercase string.
  • security_group_ids (pulumi.Input[list]) – One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud
  • security_group_names (pulumi.Input[list]) – A list of cache security group names to associate with this replication group.
  • snapshot_arns (pulumi.Input[list]) – A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. Example: arn:aws:s3:::my_bucket/snapshot1.rdb
  • snapshot_name (pulumi.Input[str]) – The name of a snapshot from which to restore data into the new node group. Changing the snapshot_name forces a new resource.
  • snapshot_retention_limit (pulumi.Input[float]) – The 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 or cache.t2.* cache nodes
  • snapshot_window (pulumi.Input[str]) – The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: 05:00-09:00
  • subnet_group_name (pulumi.Input[str]) – The name of the cache subnet group to be used for the replication group.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource
  • transit_encryption_enabled (pulumi.Input[bool]) – Whether to enable encryption in transit.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.elasticache.SecurityGroup(resource_name, opts=None, description=None, name=None, security_group_names=None, __props__=None, __name__=None, __opts__=None)

Provides an ElastiCache Security Group to control access to one or more cache clusters.

NOTE: ElastiCache Security Groups are for use only when working with an ElastiCache cluster outside of a VPC. If you are using a VPC, see the ElastiCache Subnet Group resource.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – description for the cache security group. Defaults to “Managed by Pulumi”.
  • name (pulumi.Input[str]) – Name for the cache security group. This value is stored as a lowercase string.
  • security_group_names (pulumi.Input[list]) – List of EC2 security group names to be authorized for ingress to the cache security group
description = None

description for the cache security group. Defaults to “Managed by Pulumi”.

name = None

Name for the cache security group. This value is stored as a lowercase string.

security_group_names = None

List of EC2 security group names to be authorized for ingress to the cache security group

static get(resource_name, id, opts=None, description=None, name=None, security_group_names=None)

Get an existing SecurityGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: description for the cache security group. Defaults to “Managed by Pulumi”. :param pulumi.Input[str] name: Name for the cache security group. This value is stored as a lowercase string. :param pulumi.Input[list] security_group_names: List of EC2 security group names to be

authorized for ingress to the cache security group
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.elasticache.SubnetGroup(resource_name, opts=None, description=None, name=None, subnet_ids=None, __props__=None, __name__=None, __opts__=None)

Provides an ElastiCache Subnet Group resource.

NOTE: ElastiCache Subnet Groups are only for use when working with an ElastiCache cluster inside of a VPC. If you are on EC2 Classic, see the ElastiCache Security Group resource.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – Description for the cache subnet group. Defaults to “Managed by Pulumi”.
  • name (pulumi.Input[str]) – Name for the cache subnet group. Elasticache converts this name to lowercase.
  • subnet_ids (pulumi.Input[list]) – List of VPC Subnet IDs for the cache subnet group
description = None

Description for the cache subnet group. Defaults to “Managed by Pulumi”.

name = None

Name for the cache subnet group. Elasticache converts this name to lowercase.

subnet_ids = None

List of VPC Subnet IDs for the cache subnet group

static get(resource_name, id, opts=None, description=None, name=None, subnet_ids=None)

Get an existing SubnetGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: Description for the cache subnet group. Defaults to “Managed by Pulumi”. :param pulumi.Input[str] name: Name for the cache subnet group. Elasticache converts this name to lowercase. :param pulumi.Input[list] subnet_ids: List of VPC Subnet IDs for the cache subnet group

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.elasticache.get_cluster(cluster_id=None, tags=None, opts=None)

Use this data source to get information about an Elasticache Cluster

pulumi_aws.elasticache.get_replication_group(replication_group_id=None, opts=None)

Use this data source to get information about an Elasticache Replication Group.