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

Cache

class Cache : KotlinCustomResource

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

Properties

capacity

val capacity: Output<Int>

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>?

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

family

val family: Output<String>

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

hostname

val hostname: Output<String>

The Hostname of the Redis Instance

val id: Output<String>

identity

val identity: Output<CacheIdentity>?

An identity block as defined below.

location

val location: Output<String>

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

minimumTlsVersion

val minimumTlsVersion: Output<String>?

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

name

val name: Output<String>

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

patchSchedules

val patchSchedules: Output<List<CachePatchSchedule>>?

A list of patch_schedule blocks as defined below.

port

val port: Output<Int>

The non-SSL Port of the Redis Instance

primaryAccessKey

val primaryAccessKey: Output<String>

The Primary Access Key for the Redis Instance

primaryConnectionString

val primaryConnectionString: Output<String>

The primary connection string of the Redis Instance.

privateStaticIpAddress

val privateStaticIpAddress: Output<String>

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>?

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.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

redisConfiguration

val redisConfiguration: Output<CacheRedisConfiguration>

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

redisVersion

val redisVersion: Output<String>

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

replicasPerMaster

val replicasPerMaster: Output<Int>

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

replicasPerPrimary

val replicasPerPrimary: Output<Int>

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>

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

secondaryAccessKey

val secondaryAccessKey: Output<String>

The Secondary Access Key for the Redis Instance

secondaryConnectionString

val secondaryConnectionString: Output<String>

The secondary connection string of the Redis Instance.

shardCount

val shardCount: Output<Int>?

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

skuName

val skuName: Output<String>

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

sslPort

val sslPort: Output<Int>

The SSL Port of the Redis Instance

subnetId

val subnetId: Output<String>?

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.