pulumi-azure-kotlin/com.pulumi.azure.redis.kotlin/CacheArgs

CacheArgs

data class CacheArgs(val capacity: Output<Int>? = null, val enableNonSslPort: Output<Boolean>? = null, val family: Output<String>? = null, val identity: Output<CacheIdentityArgs>? = null, val location: Output<String>? = null, val minimumTlsVersion: Output<String>? = null, val name: Output<String>? = null, val patchSchedules: Output<List<CachePatchScheduleArgs>>? = null, val privateStaticIpAddress: Output<String>? = null, val publicNetworkAccessEnabled: Output<Boolean>? = null, val redisConfiguration: Output<CacheRedisConfigurationArgs>? = null, val redisVersion: Output<String>? = null, val replicasPerMaster: Output<Int>? = null, val replicasPerPrimary: Output<Int>? = null, val resourceGroupName: Output<String>? = null, val shardCount: Output<Int>? = null, val skuName: Output<String>? = null, val subnetId: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val tenantSettings: Output<Map<String, String>>? = null, val zones: Output<List<String>>? = null) : ConvertibleToJava<CacheArgs>

Manages a Redis Cache.

Note: Redis version 4 is being retired and no longer supports creating new instances. Version 4 will be removed in a future release. Redis Version 4 Retirement

Example Usage

This example provisions a Standard Redis Cache.

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.redis.Cache;
import com.pulumi.azure.redis.CacheArgs;
import com.pulumi.azure.redis.inputs.CacheRedisConfigurationArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleCache = new Cache("exampleCache", CacheArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .capacity(2)
            .family("C")
            .skuName("Standard")
            .enableNonSslPort(false)
            .minimumTlsVersion("1.2")
            .redisConfiguration()
            .build());
    }
}

Relevant Links

Import

Redis Cache's can be imported using the resource id, e.g.

$ pulumi import azure:redis/cache:Cache cache1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Cache/redis/cache1

Constructors

CacheArgs

fun CacheArgs(capacity: Output<Int>? = null, enableNonSslPort: Output<Boolean>? = null, family: Output<String>? = null, identity: Output<CacheIdentityArgs>? = null, location: Output<String>? = null, minimumTlsVersion: Output<String>? = null, name: Output<String>? = null, patchSchedules: Output<List<CachePatchScheduleArgs>>? = null, privateStaticIpAddress: Output<String>? = null, publicNetworkAccessEnabled: Output<Boolean>? = null, redisConfiguration: Output<CacheRedisConfigurationArgs>? = null, redisVersion: Output<String>? = null, replicasPerMaster: Output<Int>? = null, replicasPerPrimary: Output<Int>? = null, resourceGroupName: Output<String>? = null, shardCount: Output<Int>? = null, skuName: Output<String>? = null, subnetId: Output<String>? = null, tags: Output<Map<String, String>>? = null, tenantSettings: Output<Map<String, String>>? = null, zones: Output<List<String>>? = null)

Functions

toJava

open override fun toJava(): CacheArgs

Properties

capacity

val capacity: Output<Int>? = null

The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4, 5.

enableNonSslPort

val enableNonSslPort: Output<Boolean>? = null

Enable the non-SSL port (6379) - disabled by default.

family

val family: Output<String>? = null

The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)

identity

val identity: Output<CacheIdentityArgs>? = null

An identity block as defined below.

location

val location: Output<String>? = null

The location of the resource group. Changing this forces a new resource to be created.

minimumTlsVersion

val minimumTlsVersion: Output<String>? = null

The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.

name

val name: Output<String>? = null

The name of the Redis instance. Changing this forces a new resource to be created.

patchSchedules

val patchSchedules: Output<List<CachePatchScheduleArgs>>? = null

A list of patch_schedule blocks as defined below.

privateStaticIpAddress

val privateStaticIpAddress: Output<String>? = null

The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. This argument implies the use of subnet_id. Changing this forces a new resource to be created.

publicNetworkAccessEnabled

val publicNetworkAccessEnabled: Output<Boolean>? = null

Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.

redisConfiguration

val redisConfiguration: Output<CacheRedisConfigurationArgs>? = null

A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.

redisVersion

val redisVersion: Output<String>? = null

Redis version. Only major version needed. Valid values: 4, 6.

replicasPerMaster

val replicasPerMaster: Output<Int>? = null

Amount of replicas to create per master for this Redis Cache.

replicasPerPrimary

val replicasPerPrimary: Output<Int>? = null

Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

resourceGroupName

val resourceGroupName: Output<String>? = null

The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.

shardCount

val shardCount: Output<Int>? = null

Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.

skuName

val skuName: Output<String>? = null

The SKU of Redis to use. Possible values are Basic, Standard and Premium.

subnetId

val subnetId: Output<String>? = null

Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.