com.pulumi.aws.elasticache.Cluster Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.elasticache;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.elasticache.ClusterArgs;
import com.pulumi.aws.elasticache.inputs.ClusterState;
import com.pulumi.aws.elasticache.outputs.ClusterCacheNode;
import com.pulumi.aws.elasticache.outputs.ClusterLogDeliveryConfiguration;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides an ElastiCache Cluster resource, which manages either a
* [Memcached cluster](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/WhatIs.html), a
* [single-node Redis instance](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/WhatIs.html), 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](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/Clusters.Modify.html) or
* [ElastiCache for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Modify.html)
* 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
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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()
* .clusterId("cluster-example")
* .engine("memcached")
* .nodeType("cache.m4.large")
* .numCacheNodes(2)
* .parameterGroupName("default.memcached1.4")
* .port(11211)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Redis Instance
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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()
* .clusterId("cluster-example")
* .engine("redis")
* .nodeType("cache.m4.large")
* .numCacheNodes(1)
* .parameterGroupName("default.redis3.2")
* .engineVersion("3.2.10")
* .port(6379)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Redis Cluster Mode Disabled Read Replica Instance
*
* These inherit their settings from the replication group.
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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()
* .clusterId("cluster-example")
* .replicationGroupId(example.id())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Redis Log Delivery configuration
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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()
* .clusterId("mycluster")
* .engine("redis")
* .nodeType("cache.t3.micro")
* .numCacheNodes(1)
* .port(6379)
* .applyImmediately(true)
* .logDeliveryConfigurations(
* ClusterLogDeliveryConfigurationArgs.builder()
* .destination(example.name())
* .destinationType("cloudwatch-logs")
* .logFormat("text")
* .logType("slow-log")
* .build(),
* ClusterLogDeliveryConfigurationArgs.builder()
* .destination(exampleAwsKinesisFirehoseDeliveryStream.name())
* .destinationType("kinesis-firehose")
* .logFormat("json")
* .logType("engine-log")
* .build())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Elasticache Cluster in Outpost
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.outposts.OutpostsFunctions;
* import com.pulumi.aws.outposts.inputs.GetOutpostsArgs;
* import com.pulumi.aws.outposts.inputs.GetOutpostArgs;
* import com.pulumi.aws.ec2.Vpc;
* import com.pulumi.aws.ec2.VpcArgs;
* import com.pulumi.aws.ec2.Subnet;
* import com.pulumi.aws.ec2.SubnetArgs;
* import com.pulumi.aws.elasticache.SubnetGroup;
* import com.pulumi.aws.elasticache.SubnetGroupArgs;
* 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) {
* final var example = OutpostsFunctions.getOutposts();
*
* final var exampleGetOutpost = OutpostsFunctions.getOutpost(GetOutpostArgs.builder()
* .id(example.applyValue(getOutpostsResult -> getOutpostsResult.ids()[0]))
* .build());
*
* var exampleVpc = new Vpc("exampleVpc", VpcArgs.builder()
* .cidrBlock("10.0.0.0/16")
* .build());
*
* var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
* .vpcId(exampleVpc.id())
* .cidrBlock("10.0.1.0/24")
* .tags(Map.of("Name", "my-subnet"))
* .build());
*
* var exampleSubnetGroup = new SubnetGroup("exampleSubnetGroup", SubnetGroupArgs.builder()
* .name("my-cache-subnet")
* .subnetIds(exampleSubnet.id())
* .build());
*
* var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
* .clusterId("cluster-example")
* .outpostMode("single-outpost")
* .preferredOutpostArn(exampleGetOutpost.applyValue(getOutpostResult -> getOutpostResult.arn()))
* .engine("memcached")
* .nodeType("cache.r5.large")
* .numCacheNodes(2)
* .parameterGroupName("default.memcached1.4")
* .port(11211)
* .subnetGroupName(exampleSubnetGroup.name())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import ElastiCache Clusters using the `cluster_id`. For example:
*
* ```sh
* $ pulumi import aws:elasticache/cluster:Cluster my_cluster my_cluster
* ```
*
*/
@ResourceType(type="aws:elasticache/cluster:Cluster")
public class Cluster extends com.pulumi.resources.CustomResource {
/**
* Whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon ElastiCache Documentation for more information.](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheCluster.html).
*
*/
@Export(name="applyImmediately", refs={Boolean.class}, tree="[0]")
private Output applyImmediately;
/**
* @return Whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon ElastiCache Documentation for more information.](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheCluster.html).
*
*/
public Output applyImmediately() {
return this.applyImmediately;
}
/**
* The ARN of the created ElastiCache Cluster.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return The ARN of the created ElastiCache Cluster.
*
*/
public Output arn() {
return this.arn;
}
/**
* 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`.
*
*/
@Export(name="autoMinorVersionUpgrade", refs={String.class}, tree="[0]")
private Output autoMinorVersionUpgrade;
/**
* @return 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`.
*
*/
public Output> autoMinorVersionUpgrade() {
return Codegen.optional(this.autoMinorVersionUpgrade);
}
/**
* 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.
*
*/
@Export(name="availabilityZone", refs={String.class}, tree="[0]")
private Output availabilityZone;
/**
* @return 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.
*
*/
public Output availabilityZone() {
return this.availabilityZone;
}
/**
* 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`.
*
*/
@Export(name="azMode", refs={String.class}, tree="[0]")
private Output azMode;
/**
* @return 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`.
*
*/
public Output azMode() {
return this.azMode;
}
/**
* List of node objects including `id`, `address`, `port` and `availability_zone`.
*
*/
@Export(name="cacheNodes", refs={List.class,ClusterCacheNode.class}, tree="[0,1]")
private Output> cacheNodes;
/**
* @return List of node objects including `id`, `address`, `port` and `availability_zone`.
*
*/
public Output> cacheNodes() {
return this.cacheNodes;
}
/**
* (Memcached only) DNS name of the cache cluster without the port appended.
*
*/
@Export(name="clusterAddress", refs={String.class}, tree="[0]")
private Output clusterAddress;
/**
* @return (Memcached only) DNS name of the cache cluster without the port appended.
*
*/
public Output clusterAddress() {
return this.clusterAddress;
}
/**
* Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.
*
*/
@Export(name="clusterId", refs={String.class}, tree="[0]")
private Output clusterId;
/**
* @return Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.
*
*/
public Output clusterId() {
return this.clusterId;
}
/**
* (Memcached only) Configuration endpoint to allow host discovery.
*
*/
@Export(name="configurationEndpoint", refs={String.class}, tree="[0]")
private Output configurationEndpoint;
/**
* @return (Memcached only) Configuration endpoint to allow host discovery.
*
*/
public Output configurationEndpoint() {
return this.configurationEndpoint;
}
/**
* Name of the cache engine to be used for this cache cluster. Valid values are `memcached` and `redis`.
*
*/
@Export(name="engine", refs={String.class}, tree="[0]")
private Output engine;
/**
* @return Name of the cache engine to be used for this cache cluster. Valid values are `memcached` and `redis`.
*
*/
public Output engine() {
return this.engine;
}
/**
* Version number of the cache engine to be used.
* If not set, defaults to the latest version.
* See [Describe Cache Engine Versions](https://docs.aws.amazon.com/cli/latest/reference/elasticache/describe-cache-engine-versions.html) in the AWS Documentation for supported versions.
* When `engine` is `redis` and the version is 7 or higher, the major and minor version should be set, e.g., `7.2`.
* When the version is 6, 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 Attribute Reference below. Cannot be provided with `replication_group_id.`
*
*/
@Export(name="engineVersion", refs={String.class}, tree="[0]")
private Output engineVersion;
/**
* @return Version number of the cache engine to be used.
* If not set, defaults to the latest version.
* See [Describe Cache Engine Versions](https://docs.aws.amazon.com/cli/latest/reference/elasticache/describe-cache-engine-versions.html) in the AWS Documentation for supported versions.
* When `engine` is `redis` and the version is 7 or higher, the major and minor version should be set, e.g., `7.2`.
* When the version is 6, 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 Attribute Reference below. Cannot be provided with `replication_group_id.`
*
*/
public Output engineVersion() {
return this.engineVersion;
}
/**
* Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
*
*/
@Export(name="engineVersionActual", refs={String.class}, tree="[0]")
private Output engineVersionActual;
/**
* @return Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine.
*
*/
public Output engineVersionActual() {
return this.engineVersionActual;
}
/**
* Name of your final cluster snapshot. If omitted, no final snapshot will be made.
*
*/
@Export(name="finalSnapshotIdentifier", refs={String.class}, tree="[0]")
private Output finalSnapshotIdentifier;
/**
* @return Name of your final cluster snapshot. If omitted, no final snapshot will be made.
*
*/
public Output> finalSnapshotIdentifier() {
return Codegen.optional(this.finalSnapshotIdentifier);
}
/**
* The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`.
*
*/
@Export(name="ipDiscovery", refs={String.class}, tree="[0]")
private Output ipDiscovery;
/**
* @return The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`.
*
*/
public Output ipDiscovery() {
return this.ipDiscovery;
}
/**
* Specifies the destination and format of Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log). See the documentation on [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html). See Log Delivery Configuration below for more details.
*
*/
@Export(name="logDeliveryConfigurations", refs={List.class,ClusterLogDeliveryConfiguration.class}, tree="[0,1]")
private Output> logDeliveryConfigurations;
/**
* @return Specifies the destination and format of Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log). See the documentation on [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html). See Log Delivery Configuration below for more details.
*
*/
public Output>> logDeliveryConfigurations() {
return Codegen.optional(this.logDeliveryConfigurations);
}
/**
* 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`.
*
*/
@Export(name="maintenanceWindow", refs={String.class}, tree="[0]")
private Output maintenanceWindow;
/**
* @return 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`.
*
*/
public Output maintenanceWindow() {
return this.maintenanceWindow;
}
/**
* 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](https://aws.amazon.com/ec2/nitro/) instances. Valid values are `ipv4`, `ipv6` or `dual_stack`.
*
*/
@Export(name="networkType", refs={String.class}, tree="[0]")
private Output networkType;
/**
* @return 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](https://aws.amazon.com/ec2/nitro/) instances. Valid values are `ipv4`, `ipv6` or `dual_stack`.
*
*/
public Output networkType() {
return this.networkType;
}
/**
* The instance class used.
* See AWS documentation for information on [supported node types for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html).
* See AWS documentation for information on [supported node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/nodes-select-size.html).
* For Memcached, changing this value will re-create the resource.
*
*/
@Export(name="nodeType", refs={String.class}, tree="[0]")
private Output nodeType;
/**
* @return The instance class used.
* See AWS documentation for information on [supported node types for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html).
* See AWS documentation for information on [supported node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/nodes-select-size.html).
* For Memcached, changing this value will re-create the resource.
*
*/
public Output nodeType() {
return this.nodeType;
}
/**
* ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`.
*
*/
@Export(name="notificationTopicArn", refs={String.class}, tree="[0]")
private Output notificationTopicArn;
/**
* @return ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`.
*
*/
public Output> notificationTopicArn() {
return Codegen.optional(this.notificationTopicArn);
}
/**
* 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.
*
*/
@Export(name="numCacheNodes", refs={Integer.class}, tree="[0]")
private Output numCacheNodes;
/**
* @return 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.
*
*/
public Output numCacheNodes() {
return this.numCacheNodes;
}
/**
* 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.
*
*/
@Export(name="outpostMode", refs={String.class}, tree="[0]")
private Output outpostMode;
/**
* @return 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.
*
*/
public Output> outpostMode() {
return Codegen.optional(this.outpostMode);
}
/**
* The name of the parameter group to associate with this cache cluster.
*
* The following arguments are optional:
*
*/
@Export(name="parameterGroupName", refs={String.class}, tree="[0]")
private Output parameterGroupName;
/**
* @return The name of the parameter group to associate with this cache cluster.
*
* The following arguments are optional:
*
*/
public Output parameterGroupName() {
return this.parameterGroupName;
}
/**
* 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.
*
*/
@Export(name="port", refs={Integer.class}, tree="[0]")
private Output port;
/**
* @return 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.
*
*/
public Output port() {
return this.port;
}
/**
* 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.
*
*/
@Export(name="preferredAvailabilityZones", refs={List.class,String.class}, tree="[0,1]")
private Output> preferredAvailabilityZones;
/**
* @return 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.
*
*/
public Output>> preferredAvailabilityZones() {
return Codegen.optional(this.preferredAvailabilityZones);
}
/**
* The outpost ARN in which the cache cluster will be created.
*
*/
@Export(name="preferredOutpostArn", refs={String.class}, tree="[0]")
private Output preferredOutpostArn;
/**
* @return The outpost ARN in which the cache cluster will be created.
*
*/
public Output preferredOutpostArn() {
return this.preferredOutpostArn;
}
/**
* 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.
*
*/
@Export(name="replicationGroupId", refs={String.class}, tree="[0]")
private Output replicationGroupId;
/**
* @return 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.
*
*/
public Output replicationGroupId() {
return this.replicationGroupId;
}
/**
* One or more VPC security groups associated with the cache cluster. Cannot be provided with `replication_group_id.`
*
*/
@Export(name="securityGroupIds", refs={List.class,String.class}, tree="[0,1]")
private Output> securityGroupIds;
/**
* @return One or more VPC security groups associated with the cache cluster. Cannot be provided with `replication_group_id.`
*
*/
public Output> securityGroupIds() {
return this.securityGroupIds;
}
/**
* 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.
*
*/
@Export(name="snapshotArns", refs={String.class}, tree="[0]")
private Output snapshotArns;
/**
* @return 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.
*
*/
public Output> snapshotArns() {
return Codegen.optional(this.snapshotArns);
}
/**
* Name of a snapshot from which to restore data into the new node group. Changing `snapshot_name` forces a new resource.
*
*/
@Export(name="snapshotName", refs={String.class}, tree="[0]")
private Output snapshotName;
/**
* @return Name of a snapshot from which to restore data into the new node group. Changing `snapshot_name` forces a new resource.
*
*/
public Output> snapshotName() {
return Codegen.optional(this.snapshotName);
}
/**
* 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
*
*/
@Export(name="snapshotRetentionLimit", refs={Integer.class}, tree="[0]")
private Output snapshotRetentionLimit;
/**
* @return 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
*
*/
public Output> snapshotRetentionLimit() {
return Codegen.optional(this.snapshotRetentionLimit);
}
/**
* Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00
*
*/
@Export(name="snapshotWindow", refs={String.class}, tree="[0]")
private Output snapshotWindow;
/**
* @return Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00
*
*/
public Output snapshotWindow() {
return this.snapshotWindow;
}
/**
* Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided with `replication_group_id.`
*
*/
@Export(name="subnetGroupName", refs={String.class}, tree="[0]")
private Output subnetGroupName;
/**
* @return Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided with `replication_group_id.`
*
*/
public Output subnetGroupName() {
return this.subnetGroupName;
}
/**
* 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.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return 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.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
* Enable encryption in-transit. Supported only with Memcached versions `1.6.12` and later, running in a VPC. See the [ElastiCache in-transit encryption](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/in-transit-encryption-mc.html) documentation for more details.
*
*/
@Export(name="transitEncryptionEnabled", refs={Boolean.class}, tree="[0]")
private Output transitEncryptionEnabled;
/**
* @return Enable encryption in-transit. Supported only with Memcached versions `1.6.12` and later, running in a VPC. See the [ElastiCache in-transit encryption](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/in-transit-encryption-mc.html) documentation for more details.
*
*/
public Output transitEncryptionEnabled() {
return this.transitEncryptionEnabled;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Cluster(java.lang.String name) {
this(name, ClusterArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Cluster(java.lang.String name, @Nullable ClusterArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Cluster(java.lang.String name, @Nullable ClusterArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:elasticache/cluster:Cluster", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Cluster(java.lang.String name, Output id, @Nullable ClusterState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:elasticache/cluster:Cluster", name, state, makeResourceOptions(options, id), false);
}
private static ClusterArgs makeArgs(@Nullable ClusterArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ClusterArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Cluster get(java.lang.String name, Output id, @Nullable ClusterState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Cluster(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy