com.pulumi.aws.elasticache.kotlin.ReplicationGroupArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.elasticache.kotlin
import com.pulumi.aws.elasticache.ReplicationGroupArgs.builder
import com.pulumi.aws.elasticache.kotlin.inputs.ReplicationGroupLogDeliveryConfigurationArgs
import com.pulumi.aws.elasticache.kotlin.inputs.ReplicationGroupLogDeliveryConfigurationArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Int
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Provides an ElastiCache Replication Group resource.
* For working with a [Memcached cluster](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/WhatIs.html) or a
* [single-node Redis instance (Cluster Mode Disabled)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/WhatIs.html),
* see the `aws.elasticache.Cluster` resource.
* > **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.
* See the AWS Documentation on
* [Modifying an ElastiCache Cache Cluster](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`.
* > **Note:** Be aware of the terminology collision around "cluster" for `aws.elasticache.ReplicationGroup`. For example, it is possible to create a ["Cluster Mode Disabled [Redis] Cluster"](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Create.CON.Redis.html). With "Cluster Mode Enabled", the data will be stored in shards (called "node groups"). See [Redis Cluster Configuration](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/cluster-create-determine-requirements.html#redis-cluster-configuration) for a diagram of the differences. To enable cluster mode, use a parameter group that has cluster mode enabled. The default parameter groups provided by AWS end with ".cluster.on", for example `default.redis6.x.cluster.on`.
* ## Example Usage
* ### Redis OSS/Valkey Cluster Mode Disabled
* To create a single shard primary with single read replica:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.elasticache.ReplicationGroup("example", {
* automaticFailoverEnabled: true,
* preferredCacheClusterAzs: [
* "us-west-2a",
* "us-west-2b",
* ],
* replicationGroupId: "tf-rep-group-1",
* description: "example description",
* nodeType: "cache.m4.large",
* numCacheClusters: 2,
* parameterGroupName: "default.redis3.2",
* port: 6379,
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.elasticache.ReplicationGroup("example",
* automatic_failover_enabled=True,
* preferred_cache_cluster_azs=[
* "us-west-2a",
* "us-west-2b",
* ],
* replication_group_id="tf-rep-group-1",
* description="example description",
* node_type="cache.m4.large",
* num_cache_clusters=2,
* parameter_group_name="default.redis3.2",
* port=6379)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.ElastiCache.ReplicationGroup("example", new()
* {
* AutomaticFailoverEnabled = true,
* PreferredCacheClusterAzs = new[]
* {
* "us-west-2a",
* "us-west-2b",
* },
* ReplicationGroupId = "tf-rep-group-1",
* Description = "example description",
* NodeType = "cache.m4.large",
* NumCacheClusters = 2,
* ParameterGroupName = "default.redis3.2",
* Port = 6379,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticache"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := elasticache.NewReplicationGroup(ctx, "example", &elasticache.ReplicationGroupArgs{
* AutomaticFailoverEnabled: pulumi.Bool(true),
* PreferredCacheClusterAzs: pulumi.StringArray{
* pulumi.String("us-west-2a"),
* pulumi.String("us-west-2b"),
* },
* ReplicationGroupId: pulumi.String("tf-rep-group-1"),
* Description: pulumi.String("example description"),
* NodeType: pulumi.String("cache.m4.large"),
* NumCacheClusters: pulumi.Int(2),
* ParameterGroupName: pulumi.String("default.redis3.2"),
* Port: pulumi.Int(6379),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.elasticache.ReplicationGroup;
* import com.pulumi.aws.elasticache.ReplicationGroupArgs;
* 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 ReplicationGroup("example", ReplicationGroupArgs.builder()
* .automaticFailoverEnabled(true)
* .preferredCacheClusterAzs(
* "us-west-2a",
* "us-west-2b")
* .replicationGroupId("tf-rep-group-1")
* .description("example description")
* .nodeType("cache.m4.large")
* .numCacheClusters(2)
* .parameterGroupName("default.redis3.2")
* .port(6379)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:elasticache:ReplicationGroup
* properties:
* automaticFailoverEnabled: true
* preferredCacheClusterAzs:
* - us-west-2a
* - us-west-2b
* replicationGroupId: tf-rep-group-1
* description: example description
* nodeType: cache.m4.large
* numCacheClusters: 2
* parameterGroupName: default.redis3.2
* port: 6379
* ```
*
* You have two options for adjusting the number of replicas:
* * Adjusting `num_cache_clusters` directly. This will attempt to automatically add or remove replicas, but provides no granular control (e.g., preferred availability zone, cache cluster ID) for the added or removed replicas. This also currently expects cache cluster IDs in the form of `replication_group_id-00#`.
* * Otherwise for fine grained control of the underlying cache clusters, they can be added or removed with the `aws.elasticache.Cluster` resource and its `replication_group_id` attribute. In this situation, you will need to utilize [`ignoreChanges`](https://www.pulumi.com/docs/intro/concepts/programming-model/#ignorechanges) to prevent perpetual differences with the `number_cache_cluster` attribute.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.elasticache.ReplicationGroup("example", {
* automaticFailoverEnabled: true,
* preferredCacheClusterAzs: [
* "us-west-2a",
* "us-west-2b",
* ],
* replicationGroupId: "tf-rep-group-1",
* description: "example description",
* nodeType: "cache.m4.large",
* numCacheClusters: 2,
* parameterGroupName: "default.redis3.2",
* port: 6379,
* });
* const replica: aws.elasticache.Cluster[] = [];
* for (const range = {value: 0}; range.value < 1; range.value++) {
* replica.push(new aws.elasticache.Cluster(`replica-${range.value}`, {
* clusterId: `tf-rep-group-1-${range.value}`,
* replicationGroupId: example.id,
* }));
* }
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.elasticache.ReplicationGroup("example",
* automatic_failover_enabled=True,
* preferred_cache_cluster_azs=[
* "us-west-2a",
* "us-west-2b",
* ],
* replication_group_id="tf-rep-group-1",
* description="example description",
* node_type="cache.m4.large",
* num_cache_clusters=2,
* parameter_group_name="default.redis3.2",
* port=6379)
* replica = []
* for range in [{"value": i} for i in range(0, 1)]:
* replica.append(aws.elasticache.Cluster(f"replica-{range['value']}",
* cluster_id=f"tf-rep-group-1-{range['value']}",
* replication_group_id=example.id))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.ElastiCache.ReplicationGroup("example", new()
* {
* AutomaticFailoverEnabled = true,
* PreferredCacheClusterAzs = new[]
* {
* "us-west-2a",
* "us-west-2b",
* },
* ReplicationGroupId = "tf-rep-group-1",
* Description = "example description",
* NodeType = "cache.m4.large",
* NumCacheClusters = 2,
* ParameterGroupName = "default.redis3.2",
* Port = 6379,
* });
* var replica = new List();
* for (var rangeIndex = 0; rangeIndex < 1; rangeIndex++)
* {
* var range = new { Value = rangeIndex };
* replica.Add(new Aws.ElastiCache.Cluster($"replica-{range.Value}", new()
* {
* ClusterId = $"tf-rep-group-1-{range.Value}",
* ReplicationGroupId = example.Id,
* }));
* }
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticache"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := elasticache.NewReplicationGroup(ctx, "example", &elasticache.ReplicationGroupArgs{
* AutomaticFailoverEnabled: pulumi.Bool(true),
* PreferredCacheClusterAzs: pulumi.StringArray{
* pulumi.String("us-west-2a"),
* pulumi.String("us-west-2b"),
* },
* ReplicationGroupId: pulumi.String("tf-rep-group-1"),
* Description: pulumi.String("example description"),
* NodeType: pulumi.String("cache.m4.large"),
* NumCacheClusters: pulumi.Int(2),
* ParameterGroupName: pulumi.String("default.redis3.2"),
* Port: pulumi.Int(6379),
* })
* if err != nil {
* return err
* }
* var replica []*elasticache.Cluster
* for index := 0; index < 1; index++ {
* key0 := index
* val0 := index
* __res, err := elasticache.NewCluster(ctx, fmt.Sprintf("replica-%v", key0), &elasticache.ClusterArgs{
* ClusterId: pulumi.Sprintf("tf-rep-group-1-%v", val0),
* ReplicationGroupId: example.ID(),
* })
* if err != nil {
* return err
* }
* replica = append(replica, __res)
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.elasticache.ReplicationGroup;
* import com.pulumi.aws.elasticache.ReplicationGroupArgs;
* import com.pulumi.aws.elasticache.Cluster;
* import com.pulumi.aws.elasticache.ClusterArgs;
* import com.pulumi.codegen.internal.KeyedValue;
* 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 ReplicationGroup("example", ReplicationGroupArgs.builder()
* .automaticFailoverEnabled(true)
* .preferredCacheClusterAzs(
* "us-west-2a",
* "us-west-2b")
* .replicationGroupId("tf-rep-group-1")
* .description("example description")
* .nodeType("cache.m4.large")
* .numCacheClusters(2)
* .parameterGroupName("default.redis3.2")
* .port(6379)
* .build());
* for (var i = 0; i < 1; i++) {
* new Cluster("replica-" + i, ClusterArgs.builder()
* .clusterId(String.format("tf-rep-group-1-%s", range.value()))
* .replicationGroupId(example.id())
* .build());
* }
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:elasticache:ReplicationGroup
* properties:
* automaticFailoverEnabled: true
* preferredCacheClusterAzs:
* - us-west-2a
* - us-west-2b
* replicationGroupId: tf-rep-group-1
* description: example description
* nodeType: cache.m4.large
* numCacheClusters: 2
* parameterGroupName: default.redis3.2
* port: 6379
* replica:
* type: aws:elasticache:Cluster
* properties:
* clusterId: tf-rep-group-1-${range.value}
* replicationGroupId: ${example.id}
* options: {}
* ```
*
* ### Redis OSS/Valkey Cluster Mode Enabled
* To create two shards with a primary and a single read replica each:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const baz = new aws.elasticache.ReplicationGroup("baz", {
* replicationGroupId: "tf-redis-cluster",
* description: "example description",
* nodeType: "cache.t2.small",
* port: 6379,
* parameterGroupName: "default.redis3.2.cluster.on",
* automaticFailoverEnabled: true,
* numNodeGroups: 2,
* replicasPerNodeGroup: 1,
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* baz = aws.elasticache.ReplicationGroup("baz",
* replication_group_id="tf-redis-cluster",
* description="example description",
* node_type="cache.t2.small",
* port=6379,
* parameter_group_name="default.redis3.2.cluster.on",
* automatic_failover_enabled=True,
* num_node_groups=2,
* replicas_per_node_group=1)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var baz = new Aws.ElastiCache.ReplicationGroup("baz", new()
* {
* ReplicationGroupId = "tf-redis-cluster",
* Description = "example description",
* NodeType = "cache.t2.small",
* Port = 6379,
* ParameterGroupName = "default.redis3.2.cluster.on",
* AutomaticFailoverEnabled = true,
* NumNodeGroups = 2,
* ReplicasPerNodeGroup = 1,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticache"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := elasticache.NewReplicationGroup(ctx, "baz", &elasticache.ReplicationGroupArgs{
* ReplicationGroupId: pulumi.String("tf-redis-cluster"),
* Description: pulumi.String("example description"),
* NodeType: pulumi.String("cache.t2.small"),
* Port: pulumi.Int(6379),
* ParameterGroupName: pulumi.String("default.redis3.2.cluster.on"),
* AutomaticFailoverEnabled: pulumi.Bool(true),
* NumNodeGroups: pulumi.Int(2),
* ReplicasPerNodeGroup: pulumi.Int(1),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.elasticache.ReplicationGroup;
* import com.pulumi.aws.elasticache.ReplicationGroupArgs;
* 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 baz = new ReplicationGroup("baz", ReplicationGroupArgs.builder()
* .replicationGroupId("tf-redis-cluster")
* .description("example description")
* .nodeType("cache.t2.small")
* .port(6379)
* .parameterGroupName("default.redis3.2.cluster.on")
* .automaticFailoverEnabled(true)
* .numNodeGroups(2)
* .replicasPerNodeGroup(1)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* baz:
* type: aws:elasticache:ReplicationGroup
* properties:
* replicationGroupId: tf-redis-cluster
* description: example description
* nodeType: cache.t2.small
* port: 6379
* parameterGroupName: default.redis3.2.cluster.on
* automaticFailoverEnabled: true
* numNodeGroups: 2
* replicasPerNodeGroup: 1
* ```
*
* ### Redis Log Delivery configuration
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const test = new aws.elasticache.ReplicationGroup("test", {
* replicationGroupId: "myreplicaciongroup",
* description: "test description",
* nodeType: "cache.t3.small",
* port: 6379,
* applyImmediately: true,
* autoMinorVersionUpgrade: false,
* maintenanceWindow: "tue:06:30-tue:07:30",
* snapshotWindow: "01:00-02:00",
* logDeliveryConfigurations: [
* {
* destination: example.name,
* destinationType: "cloudwatch-logs",
* logFormat: "text",
* logType: "slow-log",
* },
* {
* destination: exampleAwsKinesisFirehoseDeliveryStream.name,
* destinationType: "kinesis-firehose",
* logFormat: "json",
* logType: "engine-log",
* },
* ],
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* test = aws.elasticache.ReplicationGroup("test",
* replication_group_id="myreplicaciongroup",
* description="test description",
* node_type="cache.t3.small",
* port=6379,
* apply_immediately=True,
* auto_minor_version_upgrade=False,
* maintenance_window="tue:06:30-tue:07:30",
* snapshot_window="01:00-02:00",
* log_delivery_configurations=[
* {
* "destination": example["name"],
* "destination_type": "cloudwatch-logs",
* "log_format": "text",
* "log_type": "slow-log",
* },
* {
* "destination": example_aws_kinesis_firehose_delivery_stream["name"],
* "destination_type": "kinesis-firehose",
* "log_format": "json",
* "log_type": "engine-log",
* },
* ])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var test = new Aws.ElastiCache.ReplicationGroup("test", new()
* {
* ReplicationGroupId = "myreplicaciongroup",
* Description = "test description",
* NodeType = "cache.t3.small",
* Port = 6379,
* ApplyImmediately = true,
* AutoMinorVersionUpgrade = false,
* MaintenanceWindow = "tue:06:30-tue:07:30",
* SnapshotWindow = "01:00-02:00",
* LogDeliveryConfigurations = new[]
* {
* new Aws.ElastiCache.Inputs.ReplicationGroupLogDeliveryConfigurationArgs
* {
* Destination = example.Name,
* DestinationType = "cloudwatch-logs",
* LogFormat = "text",
* LogType = "slow-log",
* },
* new Aws.ElastiCache.Inputs.ReplicationGroupLogDeliveryConfigurationArgs
* {
* Destination = exampleAwsKinesisFirehoseDeliveryStream.Name,
* DestinationType = "kinesis-firehose",
* LogFormat = "json",
* LogType = "engine-log",
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticache"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := elasticache.NewReplicationGroup(ctx, "test", &elasticache.ReplicationGroupArgs{
* ReplicationGroupId: pulumi.String("myreplicaciongroup"),
* Description: pulumi.String("test description"),
* NodeType: pulumi.String("cache.t3.small"),
* Port: pulumi.Int(6379),
* ApplyImmediately: pulumi.Bool(true),
* AutoMinorVersionUpgrade: pulumi.Bool(false),
* MaintenanceWindow: pulumi.String("tue:06:30-tue:07:30"),
* SnapshotWindow: pulumi.String("01:00-02:00"),
* LogDeliveryConfigurations: elasticache.ReplicationGroupLogDeliveryConfigurationArray{
* &elasticache.ReplicationGroupLogDeliveryConfigurationArgs{
* Destination: pulumi.Any(example.Name),
* DestinationType: pulumi.String("cloudwatch-logs"),
* LogFormat: pulumi.String("text"),
* LogType: pulumi.String("slow-log"),
* },
* &elasticache.ReplicationGroupLogDeliveryConfigurationArgs{
* Destination: pulumi.Any(exampleAwsKinesisFirehoseDeliveryStream.Name),
* DestinationType: pulumi.String("kinesis-firehose"),
* LogFormat: pulumi.String("json"),
* LogType: pulumi.String("engine-log"),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.elasticache.ReplicationGroup;
* import com.pulumi.aws.elasticache.ReplicationGroupArgs;
* import com.pulumi.aws.elasticache.inputs.ReplicationGroupLogDeliveryConfigurationArgs;
* 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 ReplicationGroup("test", ReplicationGroupArgs.builder()
* .replicationGroupId("myreplicaciongroup")
* .description("test description")
* .nodeType("cache.t3.small")
* .port(6379)
* .applyImmediately(true)
* .autoMinorVersionUpgrade(false)
* .maintenanceWindow("tue:06:30-tue:07:30")
* .snapshotWindow("01:00-02:00")
* .logDeliveryConfigurations(
* ReplicationGroupLogDeliveryConfigurationArgs.builder()
* .destination(example.name())
* .destinationType("cloudwatch-logs")
* .logFormat("text")
* .logType("slow-log")
* .build(),
* ReplicationGroupLogDeliveryConfigurationArgs.builder()
* .destination(exampleAwsKinesisFirehoseDeliveryStream.name())
* .destinationType("kinesis-firehose")
* .logFormat("json")
* .logType("engine-log")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* test:
* type: aws:elasticache:ReplicationGroup
* properties:
* replicationGroupId: myreplicaciongroup
* description: test description
* nodeType: cache.t3.small
* port: 6379
* applyImmediately: true
* autoMinorVersionUpgrade: false
* maintenanceWindow: tue:06:30-tue:07:30
* snapshotWindow: 01:00-02:00
* logDeliveryConfigurations:
* - destination: ${example.name}
* destinationType: cloudwatch-logs
* logFormat: text
* logType: slow-log
* - destination: ${exampleAwsKinesisFirehoseDeliveryStream.name}
* destinationType: kinesis-firehose
* logFormat: json
* logType: engine-log
* ```
*
* > **Note:** We currently do not support passing a `primary_cluster_id` in order to create the Replication Group.
* > **Note:** Automatic Failover is unavailable for Redis versions earlier than 2.8.6,
* and unavailable on T1 node types. For T2 node types, it is only available on Redis version 3.2.4 or later with cluster mode enabled. See the [High Availability Using Replication Groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Replication.html) guide
* for full details on using Replication Groups.
* ### Creating a secondary replication group for a global replication group
* A Global Replication Group can have up to two secondary Replication Groups in different regions. These are added to an existing Global Replication Group.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const primary = new aws.elasticache.ReplicationGroup("primary", {
* replicationGroupId: "example-primary",
* description: "primary replication group",
* engine: "redis",
* engineVersion: "5.0.6",
* nodeType: "cache.m5.large",
* numCacheClusters: 1,
* });
* const example = new aws.elasticache.GlobalReplicationGroup("example", {
* globalReplicationGroupIdSuffix: "example",
* primaryReplicationGroupId: primary.id,
* });
* const secondary = new aws.elasticache.ReplicationGroup("secondary", {
* replicationGroupId: "example-secondary",
* description: "secondary replication group",
* globalReplicationGroupId: example.globalReplicationGroupId,
* numCacheClusters: 1,
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* primary = aws.elasticache.ReplicationGroup("primary",
* replication_group_id="example-primary",
* description="primary replication group",
* engine="redis",
* engine_version="5.0.6",
* node_type="cache.m5.large",
* num_cache_clusters=1)
* example = aws.elasticache.GlobalReplicationGroup("example",
* global_replication_group_id_suffix="example",
* primary_replication_group_id=primary.id)
* secondary = aws.elasticache.ReplicationGroup("secondary",
* replication_group_id="example-secondary",
* description="secondary replication group",
* global_replication_group_id=example.global_replication_group_id,
* num_cache_clusters=1)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var primary = new Aws.ElastiCache.ReplicationGroup("primary", new()
* {
* ReplicationGroupId = "example-primary",
* Description = "primary replication group",
* Engine = "redis",
* EngineVersion = "5.0.6",
* NodeType = "cache.m5.large",
* NumCacheClusters = 1,
* });
* var example = new Aws.ElastiCache.GlobalReplicationGroup("example", new()
* {
* GlobalReplicationGroupIdSuffix = "example",
* PrimaryReplicationGroupId = primary.Id,
* });
* var secondary = new Aws.ElastiCache.ReplicationGroup("secondary", new()
* {
* ReplicationGroupId = "example-secondary",
* Description = "secondary replication group",
* GlobalReplicationGroupId = example.GlobalReplicationGroupId,
* NumCacheClusters = 1,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticache"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* primary, err := elasticache.NewReplicationGroup(ctx, "primary", &elasticache.ReplicationGroupArgs{
* ReplicationGroupId: pulumi.String("example-primary"),
* Description: pulumi.String("primary replication group"),
* Engine: pulumi.String("redis"),
* EngineVersion: pulumi.String("5.0.6"),
* NodeType: pulumi.String("cache.m5.large"),
* NumCacheClusters: pulumi.Int(1),
* })
* if err != nil {
* return err
* }
* example, err := elasticache.NewGlobalReplicationGroup(ctx, "example", &elasticache.GlobalReplicationGroupArgs{
* GlobalReplicationGroupIdSuffix: pulumi.String("example"),
* PrimaryReplicationGroupId: primary.ID(),
* })
* if err != nil {
* return err
* }
* _, err = elasticache.NewReplicationGroup(ctx, "secondary", &elasticache.ReplicationGroupArgs{
* ReplicationGroupId: pulumi.String("example-secondary"),
* Description: pulumi.String("secondary replication group"),
* GlobalReplicationGroupId: example.GlobalReplicationGroupId,
* NumCacheClusters: pulumi.Int(1),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.elasticache.ReplicationGroup;
* import com.pulumi.aws.elasticache.ReplicationGroupArgs;
* import com.pulumi.aws.elasticache.GlobalReplicationGroup;
* import com.pulumi.aws.elasticache.GlobalReplicationGroupArgs;
* 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 primary = new ReplicationGroup("primary", ReplicationGroupArgs.builder()
* .replicationGroupId("example-primary")
* .description("primary replication group")
* .engine("redis")
* .engineVersion("5.0.6")
* .nodeType("cache.m5.large")
* .numCacheClusters(1)
* .build());
* var example = new GlobalReplicationGroup("example", GlobalReplicationGroupArgs.builder()
* .globalReplicationGroupIdSuffix("example")
* .primaryReplicationGroupId(primary.id())
* .build());
* var secondary = new ReplicationGroup("secondary", ReplicationGroupArgs.builder()
* .replicationGroupId("example-secondary")
* .description("secondary replication group")
* .globalReplicationGroupId(example.globalReplicationGroupId())
* .numCacheClusters(1)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* secondary:
* type: aws:elasticache:ReplicationGroup
* properties:
* replicationGroupId: example-secondary
* description: secondary replication group
* globalReplicationGroupId: ${example.globalReplicationGroupId}
* numCacheClusters: 1
* example:
* type: aws:elasticache:GlobalReplicationGroup
* properties:
* globalReplicationGroupIdSuffix: example
* primaryReplicationGroupId: ${primary.id}
* primary:
* type: aws:elasticache:ReplicationGroup
* properties:
* replicationGroupId: example-primary
* description: primary replication group
* engine: redis
* engineVersion: 5.0.6
* nodeType: cache.m5.large
* numCacheClusters: 1
* ```
*
* ### Redis AUTH and In-Transit Encryption Enabled
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.elasticache.ReplicationGroup("example", {
* replicationGroupId: "example",
* description: "example with authentication",
* nodeType: "cache.t2.micro",
* numCacheClusters: 1,
* port: 6379,
* subnetGroupName: exampleAwsElasticacheSubnetGroup.name,
* securityGroupIds: [exampleAwsSecurityGroup.id],
* parameterGroupName: "default.redis5.0",
* engineVersion: "5.0.6",
* transitEncryptionEnabled: true,
* authToken: "abcdefgh1234567890",
* authTokenUpdateStrategy: "ROTATE",
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.elasticache.ReplicationGroup("example",
* replication_group_id="example",
* description="example with authentication",
* node_type="cache.t2.micro",
* num_cache_clusters=1,
* port=6379,
* subnet_group_name=example_aws_elasticache_subnet_group["name"],
* security_group_ids=[example_aws_security_group["id"]],
* parameter_group_name="default.redis5.0",
* engine_version="5.0.6",
* transit_encryption_enabled=True,
* auth_token="abcdefgh1234567890",
* auth_token_update_strategy="ROTATE")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.ElastiCache.ReplicationGroup("example", new()
* {
* ReplicationGroupId = "example",
* Description = "example with authentication",
* NodeType = "cache.t2.micro",
* NumCacheClusters = 1,
* Port = 6379,
* SubnetGroupName = exampleAwsElasticacheSubnetGroup.Name,
* SecurityGroupIds = new[]
* {
* exampleAwsSecurityGroup.Id,
* },
* ParameterGroupName = "default.redis5.0",
* EngineVersion = "5.0.6",
* TransitEncryptionEnabled = true,
* AuthToken = "abcdefgh1234567890",
* AuthTokenUpdateStrategy = "ROTATE",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticache"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := elasticache.NewReplicationGroup(ctx, "example", &elasticache.ReplicationGroupArgs{
* ReplicationGroupId: pulumi.String("example"),
* Description: pulumi.String("example with authentication"),
* NodeType: pulumi.String("cache.t2.micro"),
* NumCacheClusters: pulumi.Int(1),
* Port: pulumi.Int(6379),
* SubnetGroupName: pulumi.Any(exampleAwsElasticacheSubnetGroup.Name),
* SecurityGroupIds: pulumi.StringArray{
* exampleAwsSecurityGroup.Id,
* },
* ParameterGroupName: pulumi.String("default.redis5.0"),
* EngineVersion: pulumi.String("5.0.6"),
* TransitEncryptionEnabled: pulumi.Bool(true),
* AuthToken: pulumi.String("abcdefgh1234567890"),
* AuthTokenUpdateStrategy: pulumi.String("ROTATE"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.elasticache.ReplicationGroup;
* import com.pulumi.aws.elasticache.ReplicationGroupArgs;
* 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 ReplicationGroup("example", ReplicationGroupArgs.builder()
* .replicationGroupId("example")
* .description("example with authentication")
* .nodeType("cache.t2.micro")
* .numCacheClusters(1)
* .port(6379)
* .subnetGroupName(exampleAwsElasticacheSubnetGroup.name())
* .securityGroupIds(exampleAwsSecurityGroup.id())
* .parameterGroupName("default.redis5.0")
* .engineVersion("5.0.6")
* .transitEncryptionEnabled(true)
* .authToken("abcdefgh1234567890")
* .authTokenUpdateStrategy("ROTATE")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:elasticache:ReplicationGroup
* properties:
* replicationGroupId: example
* description: example with authentication
* nodeType: cache.t2.micro
* numCacheClusters: 1
* port: 6379
* subnetGroupName: ${exampleAwsElasticacheSubnetGroup.name}
* securityGroupIds:
* - ${exampleAwsSecurityGroup.id}
* parameterGroupName: default.redis5.0
* engineVersion: 5.0.6
* transitEncryptionEnabled: true
* authToken: abcdefgh1234567890
* authTokenUpdateStrategy: ROTATE
* ```
*
* > When adding a new `auth_token` to a previously passwordless replication group, using the `ROTATE` update strategy will result in support for **both** the new token and passwordless authentication. To immediately require authorization when adding the initial token, use the `SET` strategy instead. See the [Authenticating with the Redis AUTH command](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) guide for additional details.
* ## Import
* Using `pulumi import`, import ElastiCache Replication Groups using the `replication_group_id`. For example:
* ```sh
* $ pulumi import aws:elasticache/replicationGroup:ReplicationGroup my_replication_group replication-group-1
* ```
* @property applyImmediately Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is `false`.
* @property atRestEncryptionEnabled Whether to enable encryption at rest.
* @property authToken Password used to access a password protected server. Can be specified only if `transit_encryption_enabled = true`.
* @property authTokenUpdateStrategy Strategy to use when updating the `auth_token`. Valid values are `SET`, `ROTATE`, and `DELETE`. Defaults to `ROTATE`.
* @property autoMinorVersionUpgrade Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window.
* Only supported for engine types `"redis"` and `"valkey"` and if the engine version is 6 or higher.
* Defaults to `true`.
* @property automaticFailoverEnabled Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If enabled, `num_cache_clusters` must be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to `false`.
* @property clusterMode Specifies whether cluster mode is enabled or disabled. Valid values are `enabled` or `disabled` or `compatible`
* @property dataTieringEnabled Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to `true` when using r6gd nodes.
* @property description User-created description for the replication group. Must not be empty.
* @property engine Name of the cache engine to be used for the clusters in this replication group. Valid values are `redis` or `valkey`.
* @property engineVersion Version number of the cache engine to be used for the cache clusters in this replication group.
* If the version is 7 or higher, the major and minor version should be set, e.g., `7.2`.
* If 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.
* @property finalSnapshotIdentifier The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made.
* @property globalReplicationGroupId The ID of the global replication group to which this replication group should belong. If this parameter is specified, the replication group is added to the specified global replication group as a secondary replication group; otherwise, the replication group is not part of any global replication group. If `global_replication_group_id` is set, the `num_node_groups` parameter cannot be set.
* @property ipDiscovery The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`.
* @property kmsKeyId The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `at_rest_encryption_enabled = true`.
* @property logDeliveryConfigurations Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [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#Log_contents-engine-log). See Log Delivery Configuration below for more details.
* @property maintenanceWindow 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`
* @property multiAzEnabled Specifies whether to enable Multi-AZ Support for the replication group.
* If `true`, `automatic_failover_enabled` must also be enabled.
* Defaults to `false`.
* @property networkType The IP versions for cache cluster connections. Valid values are `ipv4`, `ipv6` or `dual_stack`.
* @property nodeType Instance class to be used.
* See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html).
* Required unless `global_replication_group_id` is set.
* Cannot be set if `global_replication_group_id` is set.
* @property notificationTopicArn ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`
* @property numCacheClusters Number of cache clusters (primary and replicas) this replication group will have.
* If `automatic_failover_enabled` or `multi_az_enabled` are `true`, must be at least 2.
* Updates will occur before other modifications.
* Conflicts with `num_node_groups` and `replicas_per_node_group`.
* Defaults to `1`.
* @property numNodeGroups Number of node groups (shards) for this Redis replication group.
* Changing this number will trigger a resizing operation before other settings modifications.
* Conflicts with `num_cache_clusters`.
* @property parameterGroupName 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. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter `cluster-enabled` set to true.
* @property port 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.
* @property preferredCacheClusterAzs 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 considered. The first item in the list will be the primary node. Ignored when updating.
* @property replicasPerNodeGroup Number of replica nodes in each node group.
* Changing this number will trigger a resizing operation before other settings modifications.
* Valid values are 0 to 5.
* Conflicts with `num_cache_clusters`.
* Can only be set if `num_node_groups` is set.
* @property replicationGroupId Replication group identifier. This parameter is stored as a lowercase string.
* The following arguments are optional:
* @property securityGroupIds IDs of 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.
* @property securityGroupNames Names of 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.
* @property snapshotArns List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas.
* @property snapshotName Name of a snapshot from which to restore data into the new node group. Changing the `snapshot_name` forces a new resource.
* @property snapshotRetentionLimit 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 `snapshot_retention_limit` 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
* @property snapshotWindow 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`
* @property subnetGroupName Name of the cache subnet group to be used for the replication group.
* @property tags Map of tags to assign to the resource. Adding tags to this resource will add or overwrite any existing tags on the clusters in the replication group and not to the group itself. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
* @property transitEncryptionEnabled Whether to enable encryption in transit.
* Changing this argument with an `engine_version` < `7.0.5` will force a replacement.
* Engine versions prior to `7.0.5` only allow this transit encryption to be configured during creation of the replication group.
* @property transitEncryptionMode A setting that enables clients to migrate to in-transit encryption with no downtime.
* Valid values are `preferred` and `required`.
* When enabling encryption on an existing replication group, this must first be set to `preferred` before setting it to `required` in a subsequent apply.
* See the `TransitEncryptionMode` field in the [`CreateReplicationGroup` API documentation](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) for additional details.
* @property userGroupIds User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. **NOTE:** This argument _is_ a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.
*/
public data class ReplicationGroupArgs(
public val applyImmediately: Output? = null,
public val atRestEncryptionEnabled: Output? = null,
public val authToken: Output? = null,
public val authTokenUpdateStrategy: Output? = null,
public val autoMinorVersionUpgrade: Output? = null,
public val automaticFailoverEnabled: Output? = null,
public val clusterMode: Output? = null,
public val dataTieringEnabled: Output? = null,
public val description: Output? = null,
public val engine: Output? = null,
public val engineVersion: Output? = null,
public val finalSnapshotIdentifier: Output? = null,
public val globalReplicationGroupId: Output? = null,
public val ipDiscovery: Output? = null,
public val kmsKeyId: Output? = null,
public val logDeliveryConfigurations: Output>? =
null,
public val maintenanceWindow: Output? = null,
public val multiAzEnabled: Output? = null,
public val networkType: Output? = null,
public val nodeType: Output? = null,
public val notificationTopicArn: Output? = null,
public val numCacheClusters: Output? = null,
public val numNodeGroups: Output? = null,
public val parameterGroupName: Output? = null,
public val port: Output? = null,
public val preferredCacheClusterAzs: Output>? = null,
public val replicasPerNodeGroup: Output? = null,
public val replicationGroupId: Output? = null,
public val securityGroupIds: Output>? = null,
public val securityGroupNames: Output>? = null,
public val snapshotArns: Output>? = null,
public val snapshotName: Output? = null,
public val snapshotRetentionLimit: Output? = null,
public val snapshotWindow: Output? = null,
public val subnetGroupName: Output? = null,
public val tags: Output>? = null,
public val transitEncryptionEnabled: Output? = null,
public val transitEncryptionMode: Output? = null,
public val userGroupIds: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.aws.elasticache.ReplicationGroupArgs =
com.pulumi.aws.elasticache.ReplicationGroupArgs.builder()
.applyImmediately(applyImmediately?.applyValue({ args0 -> args0 }))
.atRestEncryptionEnabled(atRestEncryptionEnabled?.applyValue({ args0 -> args0 }))
.authToken(authToken?.applyValue({ args0 -> args0 }))
.authTokenUpdateStrategy(authTokenUpdateStrategy?.applyValue({ args0 -> args0 }))
.autoMinorVersionUpgrade(autoMinorVersionUpgrade?.applyValue({ args0 -> args0 }))
.automaticFailoverEnabled(automaticFailoverEnabled?.applyValue({ args0 -> args0 }))
.clusterMode(clusterMode?.applyValue({ args0 -> args0 }))
.dataTieringEnabled(dataTieringEnabled?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.engine(engine?.applyValue({ args0 -> args0 }))
.engineVersion(engineVersion?.applyValue({ args0 -> args0 }))
.finalSnapshotIdentifier(finalSnapshotIdentifier?.applyValue({ args0 -> args0 }))
.globalReplicationGroupId(globalReplicationGroupId?.applyValue({ args0 -> args0 }))
.ipDiscovery(ipDiscovery?.applyValue({ args0 -> args0 }))
.kmsKeyId(kmsKeyId?.applyValue({ args0 -> args0 }))
.logDeliveryConfigurations(
logDeliveryConfigurations?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
)
.maintenanceWindow(maintenanceWindow?.applyValue({ args0 -> args0 }))
.multiAzEnabled(multiAzEnabled?.applyValue({ args0 -> args0 }))
.networkType(networkType?.applyValue({ args0 -> args0 }))
.nodeType(nodeType?.applyValue({ args0 -> args0 }))
.notificationTopicArn(notificationTopicArn?.applyValue({ args0 -> args0 }))
.numCacheClusters(numCacheClusters?.applyValue({ args0 -> args0 }))
.numNodeGroups(numNodeGroups?.applyValue({ args0 -> args0 }))
.parameterGroupName(parameterGroupName?.applyValue({ args0 -> args0 }))
.port(port?.applyValue({ args0 -> args0 }))
.preferredCacheClusterAzs(
preferredCacheClusterAzs?.applyValue({ args0 ->
args0.map({ args0 ->
args0
})
}),
)
.replicasPerNodeGroup(replicasPerNodeGroup?.applyValue({ args0 -> args0 }))
.replicationGroupId(replicationGroupId?.applyValue({ args0 -> args0 }))
.securityGroupIds(securityGroupIds?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.securityGroupNames(securityGroupNames?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.snapshotArns(snapshotArns?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.snapshotName(snapshotName?.applyValue({ args0 -> args0 }))
.snapshotRetentionLimit(snapshotRetentionLimit?.applyValue({ args0 -> args0 }))
.snapshotWindow(snapshotWindow?.applyValue({ args0 -> args0 }))
.subnetGroupName(subnetGroupName?.applyValue({ args0 -> args0 }))
.tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.transitEncryptionEnabled(transitEncryptionEnabled?.applyValue({ args0 -> args0 }))
.transitEncryptionMode(transitEncryptionMode?.applyValue({ args0 -> args0 }))
.userGroupIds(userGroupIds?.applyValue({ args0 -> args0.map({ args0 -> args0 }) })).build()
}
/**
* Builder for [ReplicationGroupArgs].
*/
@PulumiTagMarker
public class ReplicationGroupArgsBuilder internal constructor() {
private var applyImmediately: Output? = null
private var atRestEncryptionEnabled: Output? = null
private var authToken: Output? = null
private var authTokenUpdateStrategy: Output? = null
private var autoMinorVersionUpgrade: Output? = null
private var automaticFailoverEnabled: Output? = null
private var clusterMode: Output? = null
private var dataTieringEnabled: Output? = null
private var description: Output? = null
private var engine: Output? = null
private var engineVersion: Output? = null
private var finalSnapshotIdentifier: Output? = null
private var globalReplicationGroupId: Output? = null
private var ipDiscovery: Output? = null
private var kmsKeyId: Output? = null
private var logDeliveryConfigurations: Output>? =
null
private var maintenanceWindow: Output? = null
private var multiAzEnabled: Output? = null
private var networkType: Output? = null
private var nodeType: Output? = null
private var notificationTopicArn: Output? = null
private var numCacheClusters: Output? = null
private var numNodeGroups: Output? = null
private var parameterGroupName: Output? = null
private var port: Output? = null
private var preferredCacheClusterAzs: Output>? = null
private var replicasPerNodeGroup: Output? = null
private var replicationGroupId: Output? = null
private var securityGroupIds: Output>? = null
private var securityGroupNames: Output>? = null
private var snapshotArns: Output>? = null
private var snapshotName: Output? = null
private var snapshotRetentionLimit: Output? = null
private var snapshotWindow: Output? = null
private var subnetGroupName: Output? = null
private var tags: Output>? = null
private var transitEncryptionEnabled: Output? = null
private var transitEncryptionMode: Output? = null
private var userGroupIds: Output>? = null
/**
* @param value Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is `false`.
*/
@JvmName("potroqxaugxygwde")
public suspend fun applyImmediately(`value`: Output) {
this.applyImmediately = value
}
/**
* @param value Whether to enable encryption at rest.
*/
@JvmName("mbiuvheicthilnpg")
public suspend fun atRestEncryptionEnabled(`value`: Output) {
this.atRestEncryptionEnabled = value
}
/**
* @param value Password used to access a password protected server. Can be specified only if `transit_encryption_enabled = true`.
*/
@JvmName("qauudaqyljxnfwkh")
public suspend fun authToken(`value`: Output) {
this.authToken = value
}
/**
* @param value Strategy to use when updating the `auth_token`. Valid values are `SET`, `ROTATE`, and `DELETE`. Defaults to `ROTATE`.
*/
@JvmName("hhuftjlxshnfcvyy")
public suspend fun authTokenUpdateStrategy(`value`: Output) {
this.authTokenUpdateStrategy = value
}
/**
* @param value Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window.
* Only supported for engine types `"redis"` and `"valkey"` and if the engine version is 6 or higher.
* Defaults to `true`.
*/
@JvmName("gqqnpdrjlgjqhcpt")
public suspend fun autoMinorVersionUpgrade(`value`: Output) {
this.autoMinorVersionUpgrade = value
}
/**
* @param value Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If enabled, `num_cache_clusters` must be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to `false`.
*/
@JvmName("qdpptgyhbywtlnqq")
public suspend fun automaticFailoverEnabled(`value`: Output) {
this.automaticFailoverEnabled = value
}
/**
* @param value Specifies whether cluster mode is enabled or disabled. Valid values are `enabled` or `disabled` or `compatible`
*/
@JvmName("dfkhuqyrvfuevixt")
public suspend fun clusterMode(`value`: Output) {
this.clusterMode = value
}
/**
* @param value Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to `true` when using r6gd nodes.
*/
@JvmName("muyulcmyedtxhnvm")
public suspend fun dataTieringEnabled(`value`: Output) {
this.dataTieringEnabled = value
}
/**
* @param value User-created description for the replication group. Must not be empty.
*/
@JvmName("asebnyarxwnyyrtg")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Name of the cache engine to be used for the clusters in this replication group. Valid values are `redis` or `valkey`.
*/
@JvmName("axuypmicqeibqgfx")
public suspend fun engine(`value`: Output) {
this.engine = value
}
/**
* @param value Version number of the cache engine to be used for the cache clusters in this replication group.
* If the version is 7 or higher, the major and minor version should be set, e.g., `7.2`.
* If 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.
*/
@JvmName("lnfbbrvahpjxicgp")
public suspend fun engineVersion(`value`: Output) {
this.engineVersion = value
}
/**
* @param value The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made.
*/
@JvmName("mbuytqllqhbkupqm")
public suspend fun finalSnapshotIdentifier(`value`: Output) {
this.finalSnapshotIdentifier = value
}
/**
* @param value The ID of the global replication group to which this replication group should belong. If this parameter is specified, the replication group is added to the specified global replication group as a secondary replication group; otherwise, the replication group is not part of any global replication group. If `global_replication_group_id` is set, the `num_node_groups` parameter cannot be set.
*/
@JvmName("kenlqvsdjbceqnsq")
public suspend fun globalReplicationGroupId(`value`: Output) {
this.globalReplicationGroupId = value
}
/**
* @param value The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`.
*/
@JvmName("gwewvlrsjcerrnsb")
public suspend fun ipDiscovery(`value`: Output) {
this.ipDiscovery = value
}
/**
* @param value The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `at_rest_encryption_enabled = true`.
*/
@JvmName("gtxbgvlbtjjonouo")
public suspend fun kmsKeyId(`value`: Output) {
this.kmsKeyId = value
}
/**
* @param value Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [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#Log_contents-engine-log). See Log Delivery Configuration below for more details.
*/
@JvmName("yhwrfrxfiryeqloq")
public suspend fun logDeliveryConfigurations(`value`: Output>) {
this.logDeliveryConfigurations = value
}
@JvmName("acuvajvbngogwamr")
public suspend fun logDeliveryConfigurations(vararg values: Output) {
this.logDeliveryConfigurations = Output.all(values.asList())
}
/**
* @param values Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [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#Log_contents-engine-log). See Log Delivery Configuration below for more details.
*/
@JvmName("epkebryrlqvmuifg")
public suspend fun logDeliveryConfigurations(values: List>) {
this.logDeliveryConfigurations = Output.all(values)
}
/**
* @param value 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`
*/
@JvmName("gohlssppxjlqxciv")
public suspend fun maintenanceWindow(`value`: Output) {
this.maintenanceWindow = value
}
/**
* @param value Specifies whether to enable Multi-AZ Support for the replication group.
* If `true`, `automatic_failover_enabled` must also be enabled.
* Defaults to `false`.
*/
@JvmName("hngfwfrxamhbscqj")
public suspend fun multiAzEnabled(`value`: Output) {
this.multiAzEnabled = value
}
/**
* @param value The IP versions for cache cluster connections. Valid values are `ipv4`, `ipv6` or `dual_stack`.
*/
@JvmName("ioihyxnacdgoylkx")
public suspend fun networkType(`value`: Output) {
this.networkType = value
}
/**
* @param value Instance class to be used.
* See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html).
* Required unless `global_replication_group_id` is set.
* Cannot be set if `global_replication_group_id` is set.
*/
@JvmName("iskgwkgbpwxxthxn")
public suspend fun nodeType(`value`: Output) {
this.nodeType = value
}
/**
* @param value ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`
*/
@JvmName("lsbipkofriocfgen")
public suspend fun notificationTopicArn(`value`: Output) {
this.notificationTopicArn = value
}
/**
* @param value Number of cache clusters (primary and replicas) this replication group will have.
* If `automatic_failover_enabled` or `multi_az_enabled` are `true`, must be at least 2.
* Updates will occur before other modifications.
* Conflicts with `num_node_groups` and `replicas_per_node_group`.
* Defaults to `1`.
*/
@JvmName("akvfopxougoyqxls")
public suspend fun numCacheClusters(`value`: Output) {
this.numCacheClusters = value
}
/**
* @param value Number of node groups (shards) for this Redis replication group.
* Changing this number will trigger a resizing operation before other settings modifications.
* Conflicts with `num_cache_clusters`.
*/
@JvmName("ryttlmewhlnrahkv")
public suspend fun numNodeGroups(`value`: Output) {
this.numNodeGroups = value
}
/**
* @param value 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. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter `cluster-enabled` set to true.
*/
@JvmName("qhdoxyawsscwtdhc")
public suspend fun parameterGroupName(`value`: Output) {
this.parameterGroupName = value
}
/**
* @param value 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.
*/
@JvmName("suxvtkcleumkttgf")
public suspend fun port(`value`: Output) {
this.port = value
}
/**
* @param value 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 considered. The first item in the list will be the primary node. Ignored when updating.
*/
@JvmName("dgaskegpjonnscxv")
public suspend fun preferredCacheClusterAzs(`value`: Output>) {
this.preferredCacheClusterAzs = value
}
@JvmName("eadnfvxakeenhetm")
public suspend fun preferredCacheClusterAzs(vararg values: Output) {
this.preferredCacheClusterAzs = Output.all(values.asList())
}
/**
* @param values 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 considered. The first item in the list will be the primary node. Ignored when updating.
*/
@JvmName("rensepwpwlkawily")
public suspend fun preferredCacheClusterAzs(values: List>) {
this.preferredCacheClusterAzs = Output.all(values)
}
/**
* @param value Number of replica nodes in each node group.
* Changing this number will trigger a resizing operation before other settings modifications.
* Valid values are 0 to 5.
* Conflicts with `num_cache_clusters`.
* Can only be set if `num_node_groups` is set.
*/
@JvmName("rdgxdsmmjftlhwlc")
public suspend fun replicasPerNodeGroup(`value`: Output) {
this.replicasPerNodeGroup = value
}
/**
* @param value Replication group identifier. This parameter is stored as a lowercase string.
* The following arguments are optional:
*/
@JvmName("kruoqtpkxcjkkgxe")
public suspend fun replicationGroupId(`value`: Output) {
this.replicationGroupId = value
}
/**
* @param value IDs of 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.
*/
@JvmName("ouksfssioofbtsxi")
public suspend fun securityGroupIds(`value`: Output>) {
this.securityGroupIds = value
}
@JvmName("xhrcpfamoyfhnapt")
public suspend fun securityGroupIds(vararg values: Output) {
this.securityGroupIds = Output.all(values.asList())
}
/**
* @param values IDs of 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.
*/
@JvmName("etujlkncdvkpljgh")
public suspend fun securityGroupIds(values: List>) {
this.securityGroupIds = Output.all(values)
}
/**
* @param value Names of 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.
*/
@JvmName("vvuxbbvvjgioxyrb")
public suspend fun securityGroupNames(`value`: Output>) {
this.securityGroupNames = value
}
@JvmName("lkwhbprvuccvkcpa")
public suspend fun securityGroupNames(vararg values: Output) {
this.securityGroupNames = Output.all(values.asList())
}
/**
* @param values Names of 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.
*/
@JvmName("hfvgroplbewqfrii")
public suspend fun securityGroupNames(values: List>) {
this.securityGroupNames = Output.all(values)
}
/**
* @param value List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas.
*/
@JvmName("jjmxkjoyshwjbwyn")
public suspend fun snapshotArns(`value`: Output>) {
this.snapshotArns = value
}
@JvmName("lfmvbeutugcomqov")
public suspend fun snapshotArns(vararg values: Output) {
this.snapshotArns = Output.all(values.asList())
}
/**
* @param values List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas.
*/
@JvmName("sxjhownckdjrpuyb")
public suspend fun snapshotArns(values: List>) {
this.snapshotArns = Output.all(values)
}
/**
* @param value Name of a snapshot from which to restore data into the new node group. Changing the `snapshot_name` forces a new resource.
*/
@JvmName("xwgageunybioulko")
public suspend fun snapshotName(`value`: Output) {
this.snapshotName = value
}
/**
* @param value 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 `snapshot_retention_limit` 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
*/
@JvmName("jokcojlqarrxrrhk")
public suspend fun snapshotRetentionLimit(`value`: Output) {
this.snapshotRetentionLimit = value
}
/**
* @param value 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`
*/
@JvmName("ekbleqfwtcbrxyye")
public suspend fun snapshotWindow(`value`: Output) {
this.snapshotWindow = value
}
/**
* @param value Name of the cache subnet group to be used for the replication group.
*/
@JvmName("tjuxcwbucavajbsq")
public suspend fun subnetGroupName(`value`: Output) {
this.subnetGroupName = value
}
/**
* @param value Map of tags to assign to the resource. Adding tags to this resource will add or overwrite any existing tags on the clusters in the replication group and not to the group itself. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("mvhensgassljklet")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value Whether to enable encryption in transit.
* Changing this argument with an `engine_version` < `7.0.5` will force a replacement.
* Engine versions prior to `7.0.5` only allow this transit encryption to be configured during creation of the replication group.
*/
@JvmName("wcnyvuagissbepwg")
public suspend fun transitEncryptionEnabled(`value`: Output) {
this.transitEncryptionEnabled = value
}
/**
* @param value A setting that enables clients to migrate to in-transit encryption with no downtime.
* Valid values are `preferred` and `required`.
* When enabling encryption on an existing replication group, this must first be set to `preferred` before setting it to `required` in a subsequent apply.
* See the `TransitEncryptionMode` field in the [`CreateReplicationGroup` API documentation](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) for additional details.
*/
@JvmName("dwkhpuoqgffqxjng")
public suspend fun transitEncryptionMode(`value`: Output) {
this.transitEncryptionMode = value
}
/**
* @param value User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. **NOTE:** This argument _is_ a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.
*/
@JvmName("hrfpopghokuynoik")
public suspend fun userGroupIds(`value`: Output>) {
this.userGroupIds = value
}
@JvmName("nrwqcovxgwrkoxtj")
public suspend fun userGroupIds(vararg values: Output) {
this.userGroupIds = Output.all(values.asList())
}
/**
* @param values User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. **NOTE:** This argument _is_ a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.
*/
@JvmName("rgxufocdqdomrdtv")
public suspend fun userGroupIds(values: List>) {
this.userGroupIds = Output.all(values)
}
/**
* @param value Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is `false`.
*/
@JvmName("lraeewhanfuvivks")
public suspend fun applyImmediately(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.applyImmediately = mapped
}
/**
* @param value Whether to enable encryption at rest.
*/
@JvmName("eyxdomdfcubrwbns")
public suspend fun atRestEncryptionEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.atRestEncryptionEnabled = mapped
}
/**
* @param value Password used to access a password protected server. Can be specified only if `transit_encryption_enabled = true`.
*/
@JvmName("mbnllkpnaxqnqbbp")
public suspend fun authToken(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authToken = mapped
}
/**
* @param value Strategy to use when updating the `auth_token`. Valid values are `SET`, `ROTATE`, and `DELETE`. Defaults to `ROTATE`.
*/
@JvmName("jyvutmkujllxcyka")
public suspend fun authTokenUpdateStrategy(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authTokenUpdateStrategy = mapped
}
/**
* @param value Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window.
* Only supported for engine types `"redis"` and `"valkey"` and if the engine version is 6 or higher.
* Defaults to `true`.
*/
@JvmName("rqfpffwpldbvalev")
public suspend fun autoMinorVersionUpgrade(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.autoMinorVersionUpgrade = mapped
}
/**
* @param value Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If enabled, `num_cache_clusters` must be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to `false`.
*/
@JvmName("yiqljywnvlddjfjb")
public suspend fun automaticFailoverEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.automaticFailoverEnabled = mapped
}
/**
* @param value Specifies whether cluster mode is enabled or disabled. Valid values are `enabled` or `disabled` or `compatible`
*/
@JvmName("bphhnlbankqtgxjl")
public suspend fun clusterMode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.clusterMode = mapped
}
/**
* @param value Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to `true` when using r6gd nodes.
*/
@JvmName("uhhvfiwbjlxsajlf")
public suspend fun dataTieringEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataTieringEnabled = mapped
}
/**
* @param value User-created description for the replication group. Must not be empty.
*/
@JvmName("gdqlpubxscuwfmjd")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Name of the cache engine to be used for the clusters in this replication group. Valid values are `redis` or `valkey`.
*/
@JvmName("nddaneoddgnwmtld")
public suspend fun engine(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.engine = mapped
}
/**
* @param value Version number of the cache engine to be used for the cache clusters in this replication group.
* If the version is 7 or higher, the major and minor version should be set, e.g., `7.2`.
* If 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.
*/
@JvmName("pndkqdympqrdgbbe")
public suspend fun engineVersion(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.engineVersion = mapped
}
/**
* @param value The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made.
*/
@JvmName("rwpxuhdmyydxcjvk")
public suspend fun finalSnapshotIdentifier(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.finalSnapshotIdentifier = mapped
}
/**
* @param value The ID of the global replication group to which this replication group should belong. If this parameter is specified, the replication group is added to the specified global replication group as a secondary replication group; otherwise, the replication group is not part of any global replication group. If `global_replication_group_id` is set, the `num_node_groups` parameter cannot be set.
*/
@JvmName("fvtbvcumnyvgoguq")
public suspend fun globalReplicationGroupId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.globalReplicationGroupId = mapped
}
/**
* @param value The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`.
*/
@JvmName("mwmpxamlnlpwicjb")
public suspend fun ipDiscovery(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.ipDiscovery = mapped
}
/**
* @param value The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `at_rest_encryption_enabled = true`.
*/
@JvmName("stvgdiqpvnwilnhi")
public suspend fun kmsKeyId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.kmsKeyId = mapped
}
/**
* @param value Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [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#Log_contents-engine-log). See Log Delivery Configuration below for more details.
*/
@JvmName("gtbehshcobsoygil")
public suspend fun logDeliveryConfigurations(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.logDeliveryConfigurations = mapped
}
/**
* @param argument Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [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#Log_contents-engine-log). See Log Delivery Configuration below for more details.
*/
@JvmName("alxkshabcrkkargc")
public suspend fun logDeliveryConfigurations(argument: List Unit>) {
val toBeMapped = argument.toList().map {
ReplicationGroupLogDeliveryConfigurationArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.logDeliveryConfigurations = mapped
}
/**
* @param argument Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [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#Log_contents-engine-log). See Log Delivery Configuration below for more details.
*/
@JvmName("bhxpgedaqnitqlbx")
public suspend fun logDeliveryConfigurations(vararg argument: suspend ReplicationGroupLogDeliveryConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
ReplicationGroupLogDeliveryConfigurationArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.logDeliveryConfigurations = mapped
}
/**
* @param argument Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [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#Log_contents-engine-log). See Log Delivery Configuration below for more details.
*/
@JvmName("vphypqqygomeiebx")
public suspend fun logDeliveryConfigurations(argument: suspend ReplicationGroupLogDeliveryConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
ReplicationGroupLogDeliveryConfigurationArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.logDeliveryConfigurations = mapped
}
/**
* @param values Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [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#Log_contents-engine-log). See Log Delivery Configuration below for more details.
*/
@JvmName("adfghvisdytumuhk")
public suspend fun logDeliveryConfigurations(vararg values: ReplicationGroupLogDeliveryConfigurationArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.logDeliveryConfigurations = mapped
}
/**
* @param value 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`
*/
@JvmName("vlgkltapcwecgdpw")
public suspend fun maintenanceWindow(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maintenanceWindow = mapped
}
/**
* @param value Specifies whether to enable Multi-AZ Support for the replication group.
* If `true`, `automatic_failover_enabled` must also be enabled.
* Defaults to `false`.
*/
@JvmName("jmbrclcuapohdmxp")
public suspend fun multiAzEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.multiAzEnabled = mapped
}
/**
* @param value The IP versions for cache cluster connections. Valid values are `ipv4`, `ipv6` or `dual_stack`.
*/
@JvmName("eycnbywqhvrsdwwp")
public suspend fun networkType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.networkType = mapped
}
/**
* @param value Instance class to be used.
* See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html).
* Required unless `global_replication_group_id` is set.
* Cannot be set if `global_replication_group_id` is set.
*/
@JvmName("ncylbirteaovgkkj")
public suspend fun nodeType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.nodeType = mapped
}
/**
* @param value ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`
*/
@JvmName("iwjfemchpjhjvlre")
public suspend fun notificationTopicArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.notificationTopicArn = mapped
}
/**
* @param value Number of cache clusters (primary and replicas) this replication group will have.
* If `automatic_failover_enabled` or `multi_az_enabled` are `true`, must be at least 2.
* Updates will occur before other modifications.
* Conflicts with `num_node_groups` and `replicas_per_node_group`.
* Defaults to `1`.
*/
@JvmName("pcpyepcrukbfybbk")
public suspend fun numCacheClusters(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.numCacheClusters = mapped
}
/**
* @param value Number of node groups (shards) for this Redis replication group.
* Changing this number will trigger a resizing operation before other settings modifications.
* Conflicts with `num_cache_clusters`.
*/
@JvmName("fdumdwmwyaaiuffk")
public suspend fun numNodeGroups(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.numNodeGroups = mapped
}
/**
* @param value 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. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter `cluster-enabled` set to true.
*/
@JvmName("pdupffblvaaxypke")
public suspend fun parameterGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.parameterGroupName = mapped
}
/**
* @param value 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.
*/
@JvmName("bokxgmapgsvbmmyf")
public suspend fun port(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.port = mapped
}
/**
* @param value 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 considered. The first item in the list will be the primary node. Ignored when updating.
*/
@JvmName("wymskupyxrxuygxw")
public suspend fun preferredCacheClusterAzs(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.preferredCacheClusterAzs = mapped
}
/**
* @param values 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 considered. The first item in the list will be the primary node. Ignored when updating.
*/
@JvmName("uivotxsvqtlbkbvp")
public suspend fun preferredCacheClusterAzs(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.preferredCacheClusterAzs = mapped
}
/**
* @param value Number of replica nodes in each node group.
* Changing this number will trigger a resizing operation before other settings modifications.
* Valid values are 0 to 5.
* Conflicts with `num_cache_clusters`.
* Can only be set if `num_node_groups` is set.
*/
@JvmName("foughqrwtapteuin")
public suspend fun replicasPerNodeGroup(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.replicasPerNodeGroup = mapped
}
/**
* @param value Replication group identifier. This parameter is stored as a lowercase string.
* The following arguments are optional:
*/
@JvmName("qdhoswauefpsepqv")
public suspend fun replicationGroupId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.replicationGroupId = mapped
}
/**
* @param value IDs of 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.
*/
@JvmName("tqfutmlububuelmi")
public suspend fun securityGroupIds(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.securityGroupIds = mapped
}
/**
* @param values IDs of 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.
*/
@JvmName("wmnhvtdcxvrmmtno")
public suspend fun securityGroupIds(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.securityGroupIds = mapped
}
/**
* @param value Names of 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.
*/
@JvmName("genqknbcgykftspt")
public suspend fun securityGroupNames(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.securityGroupNames = mapped
}
/**
* @param values Names of 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.
*/
@JvmName("bxtbpefuuvjyhwcw")
public suspend fun securityGroupNames(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.securityGroupNames = mapped
}
/**
* @param value List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas.
*/
@JvmName("sgvqdmpxkwwfqhem")
public suspend fun snapshotArns(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.snapshotArns = mapped
}
/**
* @param values List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas.
*/
@JvmName("hjmsqumgeayunycc")
public suspend fun snapshotArns(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.snapshotArns = mapped
}
/**
* @param value Name of a snapshot from which to restore data into the new node group. Changing the `snapshot_name` forces a new resource.
*/
@JvmName("bqfowjarwtedljgc")
public suspend fun snapshotName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.snapshotName = mapped
}
/**
* @param value 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 `snapshot_retention_limit` 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
*/
@JvmName("yxabqjhmaeagsrgb")
public suspend fun snapshotRetentionLimit(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.snapshotRetentionLimit = mapped
}
/**
* @param value 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`
*/
@JvmName("daxoihqwfjycwoll")
public suspend fun snapshotWindow(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.snapshotWindow = mapped
}
/**
* @param value Name of the cache subnet group to be used for the replication group.
*/
@JvmName("oybibuthrhafuxcc")
public suspend fun subnetGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.subnetGroupName = mapped
}
/**
* @param value Map of tags to assign to the resource. Adding tags to this resource will add or overwrite any existing tags on the clusters in the replication group and not to the group itself. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("fokmvmdubvtkkebd")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values Map of tags to assign to the resource. Adding tags to this resource will add or overwrite any existing tags on the clusters in the replication group and not to the group itself. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("cyedjbufctkwaeto")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value Whether to enable encryption in transit.
* Changing this argument with an `engine_version` < `7.0.5` will force a replacement.
* Engine versions prior to `7.0.5` only allow this transit encryption to be configured during creation of the replication group.
*/
@JvmName("klpyxmnhrgxhtexy")
public suspend fun transitEncryptionEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.transitEncryptionEnabled = mapped
}
/**
* @param value A setting that enables clients to migrate to in-transit encryption with no downtime.
* Valid values are `preferred` and `required`.
* When enabling encryption on an existing replication group, this must first be set to `preferred` before setting it to `required` in a subsequent apply.
* See the `TransitEncryptionMode` field in the [`CreateReplicationGroup` API documentation](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) for additional details.
*/
@JvmName("gnrxmiianwumyctj")
public suspend fun transitEncryptionMode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.transitEncryptionMode = mapped
}
/**
* @param value User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. **NOTE:** This argument _is_ a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.
*/
@JvmName("fakpdcpsddacoxfu")
public suspend fun userGroupIds(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.userGroupIds = mapped
}
/**
* @param values User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. **NOTE:** This argument _is_ a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.
*/
@JvmName("tnhxrqleyajnrwql")
public suspend fun userGroupIds(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.userGroupIds = mapped
}
internal fun build(): ReplicationGroupArgs = ReplicationGroupArgs(
applyImmediately = applyImmediately,
atRestEncryptionEnabled = atRestEncryptionEnabled,
authToken = authToken,
authTokenUpdateStrategy = authTokenUpdateStrategy,
autoMinorVersionUpgrade = autoMinorVersionUpgrade,
automaticFailoverEnabled = automaticFailoverEnabled,
clusterMode = clusterMode,
dataTieringEnabled = dataTieringEnabled,
description = description,
engine = engine,
engineVersion = engineVersion,
finalSnapshotIdentifier = finalSnapshotIdentifier,
globalReplicationGroupId = globalReplicationGroupId,
ipDiscovery = ipDiscovery,
kmsKeyId = kmsKeyId,
logDeliveryConfigurations = logDeliveryConfigurations,
maintenanceWindow = maintenanceWindow,
multiAzEnabled = multiAzEnabled,
networkType = networkType,
nodeType = nodeType,
notificationTopicArn = notificationTopicArn,
numCacheClusters = numCacheClusters,
numNodeGroups = numNodeGroups,
parameterGroupName = parameterGroupName,
port = port,
preferredCacheClusterAzs = preferredCacheClusterAzs,
replicasPerNodeGroup = replicasPerNodeGroup,
replicationGroupId = replicationGroupId,
securityGroupIds = securityGroupIds,
securityGroupNames = securityGroupNames,
snapshotArns = snapshotArns,
snapshotName = snapshotName,
snapshotRetentionLimit = snapshotRetentionLimit,
snapshotWindow = snapshotWindow,
subnetGroupName = subnetGroupName,
tags = tags,
transitEncryptionEnabled = transitEncryptionEnabled,
transitEncryptionMode = transitEncryptionMode,
userGroupIds = userGroupIds,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy