We recommend using Azure Native.
azure.redis.Cache
Explore with Pulumi AI
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
Relevant Links
Example Usage
This example provisions a Standard Redis Cache.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
// NOTE: the Name used for Redis needs to be globally unique
var exampleCache = new Azure.Redis.Cache("exampleCache", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
Capacity = 2,
Family = "C",
SkuName = "Standard",
EnableNonSslPort = false,
MinimumTlsVersion = "1.2",
RedisConfiguration = null,
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/redis"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = redis.NewCache(ctx, "exampleCache", &redis.CacheArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
Capacity: pulumi.Int(2),
Family: pulumi.String("C"),
SkuName: pulumi.String("Standard"),
EnableNonSslPort: pulumi.Bool(false),
MinimumTlsVersion: pulumi.String("1.2"),
RedisConfiguration: nil,
})
if err != nil {
return err
}
return nil
})
}
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());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
# NOTE: the Name used for Redis needs to be globally unique
example_cache = azure.redis.Cache("exampleCache",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
capacity=2,
family="C",
sku_name="Standard",
enable_non_ssl_port=False,
minimum_tls_version="1.2",
redis_configuration=azure.redis.CacheRedisConfigurationArgs())
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
// NOTE: the Name used for Redis needs to be globally unique
const exampleCache = new azure.redis.Cache("exampleCache", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
capacity: 2,
family: "C",
skuName: "Standard",
enableNonSslPort: false,
minimumTlsVersion: "1.2",
redisConfiguration: {},
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
# NOTE: the Name used for Redis needs to be globally unique
exampleCache:
type: azure:redis:Cache
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
capacity: 2
family: C
skuName: Standard
enableNonSslPort: false
minimumTlsVersion: '1.2'
redisConfiguration: {}
Create Cache Resource
new Cache(name: string, args: CacheArgs, opts?: CustomResourceOptions);
@overload
def Cache(resource_name: str,
opts: Optional[ResourceOptions] = None,
capacity: Optional[int] = None,
enable_non_ssl_port: Optional[bool] = None,
family: Optional[str] = None,
identity: Optional[CacheIdentityArgs] = None,
location: Optional[str] = None,
minimum_tls_version: Optional[str] = None,
name: Optional[str] = None,
patch_schedules: Optional[Sequence[CachePatchScheduleArgs]] = None,
private_static_ip_address: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
redis_configuration: Optional[CacheRedisConfigurationArgs] = None,
redis_version: Optional[str] = None,
replicas_per_master: Optional[int] = None,
replicas_per_primary: Optional[int] = None,
resource_group_name: Optional[str] = None,
shard_count: Optional[int] = None,
sku_name: Optional[str] = None,
subnet_id: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tenant_settings: Optional[Mapping[str, str]] = None,
zones: Optional[Sequence[str]] = None)
@overload
def Cache(resource_name: str,
args: CacheArgs,
opts: Optional[ResourceOptions] = None)
func NewCache(ctx *Context, name string, args CacheArgs, opts ...ResourceOption) (*Cache, error)
public Cache(string name, CacheArgs args, CustomResourceOptions? opts = null)
type: azure:redis:Cache
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Cache Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Cache resource accepts the following input properties:
- Capacity int
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- Family string
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- Resource
Group stringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- Sku
Name string The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- Enable
Non boolSsl Port Enable the non-SSL port (6379) - disabled by default.
- Identity
Cache
Identity An
identity
block as defined below.- Location string
The location of the resource group. Changing this forces a new resource to be created.
- Minimum
Tls stringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- Name string
The name of the Redis instance. Changing this forces a new resource to be created.
- Patch
Schedules List<CachePatch Schedule> A list of
patch_schedule
blocks as defined below.- Private
Static stringIp Address 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.- Public
Network boolAccess Enabled 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 totrue
.- Redis
Configuration CacheRedis Configuration A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- Redis
Version string Redis version. Only major version needed. Valid values:
4
,6
.- Replicas
Per intMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- Replicas
Per intPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- int
Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- Subnet
Id 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.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Tenant
Settings Dictionary<string, string> A mapping of tenant settings to assign to the resource.
- Zones List<string>
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- Capacity int
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- Family string
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- Resource
Group stringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- Sku
Name string The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- Enable
Non boolSsl Port Enable the non-SSL port (6379) - disabled by default.
- Identity
Cache
Identity Args An
identity
block as defined below.- Location string
The location of the resource group. Changing this forces a new resource to be created.
- Minimum
Tls stringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- Name string
The name of the Redis instance. Changing this forces a new resource to be created.
- Patch
Schedules []CachePatch Schedule Args A list of
patch_schedule
blocks as defined below.- Private
Static stringIp Address 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.- Public
Network boolAccess Enabled 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 totrue
.- Redis
Configuration CacheRedis Configuration Args A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- Redis
Version string Redis version. Only major version needed. Valid values:
4
,6
.- Replicas
Per intMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- Replicas
Per intPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- int
Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- Subnet
Id 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.
- map[string]string
A mapping of tags to assign to the resource.
- Tenant
Settings map[string]string A mapping of tenant settings to assign to the resource.
- Zones []string
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- capacity Integer
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- family String
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- resource
Group StringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- sku
Name String The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- enable
Non BooleanSsl Port Enable the non-SSL port (6379) - disabled by default.
- identity
Cache
Identity An
identity
block as defined below.- location String
The location of the resource group. Changing this forces a new resource to be created.
- minimum
Tls StringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- name String
The name of the Redis instance. Changing this forces a new resource to be created.
- patch
Schedules List<CachePatch Schedule> A list of
patch_schedule
blocks as defined below.- private
Static StringIp Address 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.- public
Network BooleanAccess Enabled 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 totrue
.- redis
Configuration CacheRedis Configuration A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- redis
Version String Redis version. Only major version needed. Valid values:
4
,6
.- replicas
Per IntegerMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- replicas
Per IntegerPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- Integer
Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- subnet
Id 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.
- Map<String,String>
A mapping of tags to assign to the resource.
- tenant
Settings Map<String,String> A mapping of tenant settings to assign to the resource.
- zones List<String>
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- capacity number
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- family string
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- resource
Group stringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- sku
Name string The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- enable
Non booleanSsl Port Enable the non-SSL port (6379) - disabled by default.
- identity
Cache
Identity An
identity
block as defined below.- location string
The location of the resource group. Changing this forces a new resource to be created.
- minimum
Tls stringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- name string
The name of the Redis instance. Changing this forces a new resource to be created.
- patch
Schedules CachePatch Schedule[] A list of
patch_schedule
blocks as defined below.- private
Static stringIp Address 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.- public
Network booleanAccess Enabled 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 totrue
.- redis
Configuration CacheRedis Configuration A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- redis
Version string Redis version. Only major version needed. Valid values:
4
,6
.- replicas
Per numberMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- replicas
Per numberPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- number
Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- subnet
Id 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.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- tenant
Settings {[key: string]: string} A mapping of tenant settings to assign to the resource.
- zones string[]
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- capacity int
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- family str
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- resource_
group_ strname The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- sku_
name str The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- enable_
non_ boolssl_ port Enable the non-SSL port (6379) - disabled by default.
- identity
Cache
Identity Args An
identity
block as defined below.- location str
The location of the resource group. Changing this forces a new resource to be created.
- minimum_
tls_ strversion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- name str
The name of the Redis instance. Changing this forces a new resource to be created.
- patch_
schedules Sequence[CachePatch Schedule Args] A list of
patch_schedule
blocks as defined below.- private_
static_ strip_ address 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.- public_
network_ boolaccess_ enabled 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 totrue
.- redis_
configuration CacheRedis Configuration Args A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- redis_
version str Redis version. Only major version needed. Valid values:
4
,6
.- replicas_
per_ intmaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- replicas_
per_ intprimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- int
Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- subnet_
id str 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.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- tenant_
settings Mapping[str, str] A mapping of tenant settings to assign to the resource.
- zones Sequence[str]
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- capacity Number
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- family String
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- resource
Group StringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- sku
Name String The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- enable
Non BooleanSsl Port Enable the non-SSL port (6379) - disabled by default.
- identity Property Map
An
identity
block as defined below.- location String
The location of the resource group. Changing this forces a new resource to be created.
- minimum
Tls StringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- name String
The name of the Redis instance. Changing this forces a new resource to be created.
- patch
Schedules List<Property Map> A list of
patch_schedule
blocks as defined below.- private
Static StringIp Address 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.- public
Network BooleanAccess Enabled 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 totrue
.- redis
Configuration Property Map A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- redis
Version String Redis version. Only major version needed. Valid values:
4
,6
.- replicas
Per NumberMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- replicas
Per NumberPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- Number
Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- subnet
Id 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.
- Map<String>
A mapping of tags to assign to the resource.
- tenant
Settings Map<String> A mapping of tenant settings to assign to the resource.
- zones List<String>
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cache resource produces the following output properties:
- Hostname string
The Hostname of the Redis Instance
- Id string
The provider-assigned unique ID for this managed resource.
- Port int
The non-SSL Port of the Redis Instance
- Primary
Access stringKey The Primary Access Key for the Redis Instance
- Primary
Connection stringString The primary connection string of the Redis Instance.
- Secondary
Access stringKey The Secondary Access Key for the Redis Instance
- Secondary
Connection stringString The secondary connection string of the Redis Instance.
- Ssl
Port int The SSL Port of the Redis Instance
- Hostname string
The Hostname of the Redis Instance
- Id string
The provider-assigned unique ID for this managed resource.
- Port int
The non-SSL Port of the Redis Instance
- Primary
Access stringKey The Primary Access Key for the Redis Instance
- Primary
Connection stringString The primary connection string of the Redis Instance.
- Secondary
Access stringKey The Secondary Access Key for the Redis Instance
- Secondary
Connection stringString The secondary connection string of the Redis Instance.
- Ssl
Port int The SSL Port of the Redis Instance
- hostname String
The Hostname of the Redis Instance
- id String
The provider-assigned unique ID for this managed resource.
- port Integer
The non-SSL Port of the Redis Instance
- primary
Access StringKey The Primary Access Key for the Redis Instance
- primary
Connection StringString The primary connection string of the Redis Instance.
- secondary
Access StringKey The Secondary Access Key for the Redis Instance
- secondary
Connection StringString The secondary connection string of the Redis Instance.
- ssl
Port Integer The SSL Port of the Redis Instance
- hostname string
The Hostname of the Redis Instance
- id string
The provider-assigned unique ID for this managed resource.
- port number
The non-SSL Port of the Redis Instance
- primary
Access stringKey The Primary Access Key for the Redis Instance
- primary
Connection stringString The primary connection string of the Redis Instance.
- secondary
Access stringKey The Secondary Access Key for the Redis Instance
- secondary
Connection stringString The secondary connection string of the Redis Instance.
- ssl
Port number The SSL Port of the Redis Instance
- hostname str
The Hostname of the Redis Instance
- id str
The provider-assigned unique ID for this managed resource.
- port int
The non-SSL Port of the Redis Instance
- primary_
access_ strkey The Primary Access Key for the Redis Instance
- primary_
connection_ strstring The primary connection string of the Redis Instance.
- secondary_
access_ strkey The Secondary Access Key for the Redis Instance
- secondary_
connection_ strstring The secondary connection string of the Redis Instance.
- ssl_
port int The SSL Port of the Redis Instance
- hostname String
The Hostname of the Redis Instance
- id String
The provider-assigned unique ID for this managed resource.
- port Number
The non-SSL Port of the Redis Instance
- primary
Access StringKey The Primary Access Key for the Redis Instance
- primary
Connection StringString The primary connection string of the Redis Instance.
- secondary
Access StringKey The Secondary Access Key for the Redis Instance
- secondary
Connection StringString The secondary connection string of the Redis Instance.
- ssl
Port Number The SSL Port of the Redis Instance
Look up Existing Cache Resource
Get an existing Cache resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CacheState, opts?: CustomResourceOptions): Cache
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
capacity: Optional[int] = None,
enable_non_ssl_port: Optional[bool] = None,
family: Optional[str] = None,
hostname: Optional[str] = None,
identity: Optional[CacheIdentityArgs] = None,
location: Optional[str] = None,
minimum_tls_version: Optional[str] = None,
name: Optional[str] = None,
patch_schedules: Optional[Sequence[CachePatchScheduleArgs]] = None,
port: Optional[int] = None,
primary_access_key: Optional[str] = None,
primary_connection_string: Optional[str] = None,
private_static_ip_address: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
redis_configuration: Optional[CacheRedisConfigurationArgs] = None,
redis_version: Optional[str] = None,
replicas_per_master: Optional[int] = None,
replicas_per_primary: Optional[int] = None,
resource_group_name: Optional[str] = None,
secondary_access_key: Optional[str] = None,
secondary_connection_string: Optional[str] = None,
shard_count: Optional[int] = None,
sku_name: Optional[str] = None,
ssl_port: Optional[int] = None,
subnet_id: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tenant_settings: Optional[Mapping[str, str]] = None,
zones: Optional[Sequence[str]] = None) -> Cache
func GetCache(ctx *Context, name string, id IDInput, state *CacheState, opts ...ResourceOption) (*Cache, error)
public static Cache Get(string name, Input<string> id, CacheState? state, CustomResourceOptions? opts = null)
public static Cache get(String name, Output<String> id, CacheState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Capacity int
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- Enable
Non boolSsl Port Enable the non-SSL port (6379) - disabled by default.
- Family string
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- Hostname string
The Hostname of the Redis Instance
- Identity
Cache
Identity An
identity
block as defined below.- Location string
The location of the resource group. Changing this forces a new resource to be created.
- Minimum
Tls stringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- Name string
The name of the Redis instance. Changing this forces a new resource to be created.
- Patch
Schedules List<CachePatch Schedule> A list of
patch_schedule
blocks as defined below.- Port int
The non-SSL Port of the Redis Instance
- Primary
Access stringKey The Primary Access Key for the Redis Instance
- Primary
Connection stringString The primary connection string of the Redis Instance.
- Private
Static stringIp Address 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.- Public
Network boolAccess Enabled 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 totrue
.- Redis
Configuration CacheRedis Configuration A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- Redis
Version string Redis version. Only major version needed. Valid values:
4
,6
.- Replicas
Per intMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- Replicas
Per intPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- Resource
Group stringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- Secondary
Access stringKey The Secondary Access Key for the Redis Instance
- Secondary
Connection stringString The secondary connection string of the Redis Instance.
- Shard
Count int Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- Sku
Name string The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- Ssl
Port int The SSL Port of the Redis Instance
- Subnet
Id 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.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Tenant
Settings Dictionary<string, string> A mapping of tenant settings to assign to the resource.
- Zones List<string>
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- Capacity int
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- Enable
Non boolSsl Port Enable the non-SSL port (6379) - disabled by default.
- Family string
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- Hostname string
The Hostname of the Redis Instance
- Identity
Cache
Identity Args An
identity
block as defined below.- Location string
The location of the resource group. Changing this forces a new resource to be created.
- Minimum
Tls stringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- Name string
The name of the Redis instance. Changing this forces a new resource to be created.
- Patch
Schedules []CachePatch Schedule Args A list of
patch_schedule
blocks as defined below.- Port int
The non-SSL Port of the Redis Instance
- Primary
Access stringKey The Primary Access Key for the Redis Instance
- Primary
Connection stringString The primary connection string of the Redis Instance.
- Private
Static stringIp Address 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.- Public
Network boolAccess Enabled 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 totrue
.- Redis
Configuration CacheRedis Configuration Args A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- Redis
Version string Redis version. Only major version needed. Valid values:
4
,6
.- Replicas
Per intMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- Replicas
Per intPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- Resource
Group stringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- Secondary
Access stringKey The Secondary Access Key for the Redis Instance
- Secondary
Connection stringString The secondary connection string of the Redis Instance.
- Shard
Count int Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- Sku
Name string The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- Ssl
Port int The SSL Port of the Redis Instance
- Subnet
Id 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.
- map[string]string
A mapping of tags to assign to the resource.
- Tenant
Settings map[string]string A mapping of tenant settings to assign to the resource.
- Zones []string
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- capacity Integer
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- enable
Non BooleanSsl Port Enable the non-SSL port (6379) - disabled by default.
- family String
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- hostname String
The Hostname of the Redis Instance
- identity
Cache
Identity An
identity
block as defined below.- location String
The location of the resource group. Changing this forces a new resource to be created.
- minimum
Tls StringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- name String
The name of the Redis instance. Changing this forces a new resource to be created.
- patch
Schedules List<CachePatch Schedule> A list of
patch_schedule
blocks as defined below.- port Integer
The non-SSL Port of the Redis Instance
- primary
Access StringKey The Primary Access Key for the Redis Instance
- primary
Connection StringString The primary connection string of the Redis Instance.
- private
Static StringIp Address 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.- public
Network BooleanAccess Enabled 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 totrue
.- redis
Configuration CacheRedis Configuration A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- redis
Version String Redis version. Only major version needed. Valid values:
4
,6
.- replicas
Per IntegerMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- replicas
Per IntegerPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- resource
Group StringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- secondary
Access StringKey The Secondary Access Key for the Redis Instance
- secondary
Connection StringString The secondary connection string of the Redis Instance.
- shard
Count Integer Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- sku
Name String The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- ssl
Port Integer The SSL Port of the Redis Instance
- subnet
Id 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.
- Map<String,String>
A mapping of tags to assign to the resource.
- tenant
Settings Map<String,String> A mapping of tenant settings to assign to the resource.
- zones List<String>
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- capacity number
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- enable
Non booleanSsl Port Enable the non-SSL port (6379) - disabled by default.
- family string
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- hostname string
The Hostname of the Redis Instance
- identity
Cache
Identity An
identity
block as defined below.- location string
The location of the resource group. Changing this forces a new resource to be created.
- minimum
Tls stringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- name string
The name of the Redis instance. Changing this forces a new resource to be created.
- patch
Schedules CachePatch Schedule[] A list of
patch_schedule
blocks as defined below.- port number
The non-SSL Port of the Redis Instance
- primary
Access stringKey The Primary Access Key for the Redis Instance
- primary
Connection stringString The primary connection string of the Redis Instance.
- private
Static stringIp Address 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.- public
Network booleanAccess Enabled 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 totrue
.- redis
Configuration CacheRedis Configuration A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- redis
Version string Redis version. Only major version needed. Valid values:
4
,6
.- replicas
Per numberMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- replicas
Per numberPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- resource
Group stringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- secondary
Access stringKey The Secondary Access Key for the Redis Instance
- secondary
Connection stringString The secondary connection string of the Redis Instance.
- shard
Count number Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- sku
Name string The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- ssl
Port number The SSL Port of the Redis Instance
- subnet
Id 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.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- tenant
Settings {[key: string]: string} A mapping of tenant settings to assign to the resource.
- zones string[]
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- capacity int
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- enable_
non_ boolssl_ port Enable the non-SSL port (6379) - disabled by default.
- family str
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- hostname str
The Hostname of the Redis Instance
- identity
Cache
Identity Args An
identity
block as defined below.- location str
The location of the resource group. Changing this forces a new resource to be created.
- minimum_
tls_ strversion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- name str
The name of the Redis instance. Changing this forces a new resource to be created.
- patch_
schedules Sequence[CachePatch Schedule Args] A list of
patch_schedule
blocks as defined below.- port int
The non-SSL Port of the Redis Instance
- primary_
access_ strkey The Primary Access Key for the Redis Instance
- primary_
connection_ strstring The primary connection string of the Redis Instance.
- private_
static_ strip_ address 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.- public_
network_ boolaccess_ enabled 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 totrue
.- redis_
configuration CacheRedis Configuration Args A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- redis_
version str Redis version. Only major version needed. Valid values:
4
,6
.- replicas_
per_ intmaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- replicas_
per_ intprimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- resource_
group_ strname The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- secondary_
access_ strkey The Secondary Access Key for the Redis Instance
- secondary_
connection_ strstring The secondary connection string of the Redis Instance.
- shard_
count int Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- sku_
name str The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- ssl_
port int The SSL Port of the Redis Instance
- subnet_
id str 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.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- tenant_
settings Mapping[str, str] A mapping of tenant settings to assign to the resource.
- zones Sequence[str]
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
- capacity Number
The size of the Redis cache to deploy. Valid values for a SKU
family
of C (Basic/Standard) are0, 1, 2, 3, 4, 5, 6
, and for P (Premium)family
are1, 2, 3, 4, 5
.- enable
Non BooleanSsl Port Enable the non-SSL port (6379) - disabled by default.
- family String
The SKU family/pricing group to use. Valid values are
C
(for Basic/Standard SKU family) andP
(forPremium
)- hostname String
The Hostname of the Redis Instance
- identity Property Map
An
identity
block as defined below.- location String
The location of the resource group. Changing this forces a new resource to be created.
- minimum
Tls StringVersion The minimum TLS version. Possible values are
1.0
,1.1
and1.2
. Defaults to1.0
.- name String
The name of the Redis instance. Changing this forces a new resource to be created.
- patch
Schedules List<Property Map> A list of
patch_schedule
blocks as defined below.- port Number
The non-SSL Port of the Redis Instance
- primary
Access StringKey The Primary Access Key for the Redis Instance
- primary
Connection StringString The primary connection string of the Redis Instance.
- private
Static StringIp Address 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.- public
Network BooleanAccess Enabled 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 totrue
.- redis
Configuration Property Map A
redis_configuration
block as defined below - with some limitations by SKU - defaults/details are shown below.- redis
Version String Redis version. Only major version needed. Valid values:
4
,6
.- replicas
Per NumberMaster Amount of replicas to create per master for this Redis Cache.
Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.
- replicas
Per NumberPrimary Amount of replicas to create per primary for this Redis Cache. If both
replicas_per_primary
andreplicas_per_master
are set, they need to be equal.- resource
Group StringName The name of the resource group in which to create the Redis instance. Changing this forces a new resource to be created.
- secondary
Access StringKey The Secondary Access Key for the Redis Instance
- secondary
Connection StringString The secondary connection string of the Redis Instance.
- shard
Count Number Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
- sku
Name String The SKU of Redis to use. Possible values are
Basic
,Standard
andPremium
.Note Downgrading the SKU will force a new resource to be created.
- ssl
Port Number The SSL Port of the Redis Instance
- subnet
Id 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.
- Map<String>
A mapping of tags to assign to the resource.
- tenant
Settings Map<String> A mapping of tenant settings to assign to the resource.
- zones List<String>
Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.
Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.
Supporting Types
CacheIdentity, CacheIdentityArgs
- Type string
Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- Identity
Ids List<string> A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- Principal
Id string - Tenant
Id string
- Type string
Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- Identity
Ids []string A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- Principal
Id string - Tenant
Id string
- type String
Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id String - tenant
Id String
- type string
Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids string[] A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id string - tenant
Id string
- type str
Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity_
ids Sequence[str] A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- principal_
id str - tenant_
id str
- type String
Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id String - tenant
Id String
CachePatchSchedule, CachePatchScheduleArgs
- Day
Of stringWeek the Weekday name - possible values include
Monday
,Tuesday
,Wednesday
etc.- Maintenance
Window string The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to
PT5H
.- Start
Hour intUtc the Start Hour for maintenance in UTC - possible values range from
0 - 23
.Note: The Patch Window lasts for
5
hours from thestart_hour_utc
.
- Day
Of stringWeek the Weekday name - possible values include
Monday
,Tuesday
,Wednesday
etc.- Maintenance
Window string The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to
PT5H
.- Start
Hour intUtc the Start Hour for maintenance in UTC - possible values range from
0 - 23
.Note: The Patch Window lasts for
5
hours from thestart_hour_utc
.
- day
Of StringWeek the Weekday name - possible values include
Monday
,Tuesday
,Wednesday
etc.- maintenance
Window String The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to
PT5H
.- start
Hour IntegerUtc the Start Hour for maintenance in UTC - possible values range from
0 - 23
.Note: The Patch Window lasts for
5
hours from thestart_hour_utc
.
- day
Of stringWeek the Weekday name - possible values include
Monday
,Tuesday
,Wednesday
etc.- maintenance
Window string The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to
PT5H
.- start
Hour numberUtc the Start Hour for maintenance in UTC - possible values range from
0 - 23
.Note: The Patch Window lasts for
5
hours from thestart_hour_utc
.
- day_
of_ strweek the Weekday name - possible values include
Monday
,Tuesday
,Wednesday
etc.- maintenance_
window str The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to
PT5H
.- start_
hour_ intutc the Start Hour for maintenance in UTC - possible values range from
0 - 23
.Note: The Patch Window lasts for
5
hours from thestart_hour_utc
.
- day
Of StringWeek the Weekday name - possible values include
Monday
,Tuesday
,Wednesday
etc.- maintenance
Window String The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to
PT5H
.- start
Hour NumberUtc the Start Hour for maintenance in UTC - possible values range from
0 - 23
.Note: The Patch Window lasts for
5
hours from thestart_hour_utc
.
CacheRedisConfiguration, CacheRedisConfigurationArgs
- Active
Directory boolAuthentication Enabled Enable Microsoft Entra (AAD) authentication. Defaults to
false
.- Aof
Backup boolEnabled Enable or disable AOF persistence for this Redis Cache. Defaults to
false
.NOTE:
aof_backup_enabled
can only be set when SKU isPremium
.- Aof
Storage stringConnection String0 First Storage Account connection string for AOF persistence.
- Aof
Storage stringConnection String1 Second Storage Account connection string for AOF persistence.
Example usage:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- Enable
Authentication bool If set to
false
, the Redis instance will be accessible without authentication. Defaults totrue
.NOTE:
enable_authentication
can only be set tofalse
if asubnet_id
is specified; and only works if there aren't existing instances within the subnet withenable_authentication
set totrue
.- Maxclients int
Returns the max number of connected clients at the same time.
- Maxfragmentationmemory
Reserved int Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
- Maxmemory
Delta int The max-memory delta for this Redis instance. Defaults are shown below.
- Maxmemory
Policy string How Redis will select what to remove when
maxmemory
is reached. Defaults tovolatile-lru
.- Maxmemory
Reserved int Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
- Notify
Keyspace stringEvents Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- Rdb
Backup boolEnabled Is Backup Enabled? Only supported on Premium SKUs. Defaults to
false
.NOTE: If
rdb_backup_enabled
set totrue
,rdb_storage_connection_string
must also be set.- Rdb
Backup intFrequency The Backup Frequency in Minutes. Only supported on Premium SKUs. Possible values are:
15
,30
,60
,360
,720
and1440
.- Rdb
Backup intMax Snapshot Count The maximum number of snapshots to create as a backup. Only supported for Premium SKUs.
- Rdb
Storage stringConnection String The Connection String to the Storage Account. Only supported for Premium SKUs. In the format:
DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}
.NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the
ignoreChanges
attribute to ignore changes to this field e.g.:package generated_program;
import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.azure.redis.Cache; import com.pulumi.azure.redis.CacheArgs; 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 Cache("example", CacheArgs.builder() .ignoreChanges(redis_configuration[0].rdb_storage_connection_string()) .build()); }
}
resources: example: type: azure:redis:Cache properties: # ... ignoreChanges: - ${redis_configuration[0].rdb_storage_connection_string}
- Active
Directory boolAuthentication Enabled Enable Microsoft Entra (AAD) authentication. Defaults to
false
.- Aof
Backup boolEnabled Enable or disable AOF persistence for this Redis Cache. Defaults to
false
.NOTE:
aof_backup_enabled
can only be set when SKU isPremium
.- Aof
Storage stringConnection String0 First Storage Account connection string for AOF persistence.
- Aof
Storage stringConnection String1 Second Storage Account connection string for AOF persistence.
Example usage:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- Enable
Authentication bool If set to
false
, the Redis instance will be accessible without authentication. Defaults totrue
.NOTE:
enable_authentication
can only be set tofalse
if asubnet_id
is specified; and only works if there aren't existing instances within the subnet withenable_authentication
set totrue
.- Maxclients int
Returns the max number of connected clients at the same time.
- Maxfragmentationmemory
Reserved int Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
- Maxmemory
Delta int The max-memory delta for this Redis instance. Defaults are shown below.
- Maxmemory
Policy string How Redis will select what to remove when
maxmemory
is reached. Defaults tovolatile-lru
.- Maxmemory
Reserved int Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
- Notify
Keyspace stringEvents Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- Rdb
Backup boolEnabled Is Backup Enabled? Only supported on Premium SKUs. Defaults to
false
.NOTE: If
rdb_backup_enabled
set totrue
,rdb_storage_connection_string
must also be set.- Rdb
Backup intFrequency The Backup Frequency in Minutes. Only supported on Premium SKUs. Possible values are:
15
,30
,60
,360
,720
and1440
.- Rdb
Backup intMax Snapshot Count The maximum number of snapshots to create as a backup. Only supported for Premium SKUs.
- Rdb
Storage stringConnection String The Connection String to the Storage Account. Only supported for Premium SKUs. In the format:
DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}
.NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the
ignoreChanges
attribute to ignore changes to this field e.g.:package generated_program;
import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.azure.redis.Cache; import com.pulumi.azure.redis.CacheArgs; 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 Cache("example", CacheArgs.builder() .ignoreChanges(redis_configuration[0].rdb_storage_connection_string()) .build()); }
}
resources: example: type: azure:redis:Cache properties: # ... ignoreChanges: - ${redis_configuration[0].rdb_storage_connection_string}
- active
Directory BooleanAuthentication Enabled Enable Microsoft Entra (AAD) authentication. Defaults to
false
.- aof
Backup BooleanEnabled Enable or disable AOF persistence for this Redis Cache. Defaults to
false
.NOTE:
aof_backup_enabled
can only be set when SKU isPremium
.- aof
Storage StringConnection String0 First Storage Account connection string for AOF persistence.
- aof
Storage StringConnection String1 Second Storage Account connection string for AOF persistence.
Example usage:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- enable
Authentication Boolean If set to
false
, the Redis instance will be accessible without authentication. Defaults totrue
.NOTE:
enable_authentication
can only be set tofalse
if asubnet_id
is specified; and only works if there aren't existing instances within the subnet withenable_authentication
set totrue
.- maxclients Integer
Returns the max number of connected clients at the same time.
- maxfragmentationmemory
Reserved Integer Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
- maxmemory
Delta Integer The max-memory delta for this Redis instance. Defaults are shown below.
- maxmemory
Policy String How Redis will select what to remove when
maxmemory
is reached. Defaults tovolatile-lru
.- maxmemory
Reserved Integer Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
- notify
Keyspace StringEvents Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- rdb
Backup BooleanEnabled Is Backup Enabled? Only supported on Premium SKUs. Defaults to
false
.NOTE: If
rdb_backup_enabled
set totrue
,rdb_storage_connection_string
must also be set.- rdb
Backup IntegerFrequency The Backup Frequency in Minutes. Only supported on Premium SKUs. Possible values are:
15
,30
,60
,360
,720
and1440
.- rdb
Backup IntegerMax Snapshot Count The maximum number of snapshots to create as a backup. Only supported for Premium SKUs.
- rdb
Storage StringConnection String The Connection String to the Storage Account. Only supported for Premium SKUs. In the format:
DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}
.NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the
ignoreChanges
attribute to ignore changes to this field e.g.:package generated_program;
import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.azure.redis.Cache; import com.pulumi.azure.redis.CacheArgs; 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 Cache("example", CacheArgs.builder() .ignoreChanges(redis_configuration[0].rdb_storage_connection_string()) .build()); }
}
resources: example: type: azure:redis:Cache properties: # ... ignoreChanges: - ${redis_configuration[0].rdb_storage_connection_string}
- active
Directory booleanAuthentication Enabled Enable Microsoft Entra (AAD) authentication. Defaults to
false
.- aof
Backup booleanEnabled Enable or disable AOF persistence for this Redis Cache. Defaults to
false
.NOTE:
aof_backup_enabled
can only be set when SKU isPremium
.- aof
Storage stringConnection String0 First Storage Account connection string for AOF persistence.
- aof
Storage stringConnection String1 Second Storage Account connection string for AOF persistence.
Example usage:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- enable
Authentication boolean If set to
false
, the Redis instance will be accessible without authentication. Defaults totrue
.NOTE:
enable_authentication
can only be set tofalse
if asubnet_id
is specified; and only works if there aren't existing instances within the subnet withenable_authentication
set totrue
.- maxclients number
Returns the max number of connected clients at the same time.
- maxfragmentationmemory
Reserved number Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
- maxmemory
Delta number The max-memory delta for this Redis instance. Defaults are shown below.
- maxmemory
Policy string How Redis will select what to remove when
maxmemory
is reached. Defaults tovolatile-lru
.- maxmemory
Reserved number Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
- notify
Keyspace stringEvents Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- rdb
Backup booleanEnabled Is Backup Enabled? Only supported on Premium SKUs. Defaults to
false
.NOTE: If
rdb_backup_enabled
set totrue
,rdb_storage_connection_string
must also be set.- rdb
Backup numberFrequency The Backup Frequency in Minutes. Only supported on Premium SKUs. Possible values are:
15
,30
,60
,360
,720
and1440
.- rdb
Backup numberMax Snapshot Count The maximum number of snapshots to create as a backup. Only supported for Premium SKUs.
- rdb
Storage stringConnection String The Connection String to the Storage Account. Only supported for Premium SKUs. In the format:
DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}
.NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the
ignoreChanges
attribute to ignore changes to this field e.g.:package generated_program;
import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.azure.redis.Cache; import com.pulumi.azure.redis.CacheArgs; 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 Cache("example", CacheArgs.builder() .ignoreChanges(redis_configuration[0].rdb_storage_connection_string()) .build()); }
}
resources: example: type: azure:redis:Cache properties: # ... ignoreChanges: - ${redis_configuration[0].rdb_storage_connection_string}
- active_
directory_ boolauthentication_ enabled Enable Microsoft Entra (AAD) authentication. Defaults to
false
.- aof_
backup_ boolenabled Enable or disable AOF persistence for this Redis Cache. Defaults to
false
.NOTE:
aof_backup_enabled
can only be set when SKU isPremium
.- aof_
storage_ strconnection_ string0 First Storage Account connection string for AOF persistence.
- aof_
storage_ strconnection_ string1 Second Storage Account connection string for AOF persistence.
Example usage:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- enable_
authentication bool If set to
false
, the Redis instance will be accessible without authentication. Defaults totrue
.NOTE:
enable_authentication
can only be set tofalse
if asubnet_id
is specified; and only works if there aren't existing instances within the subnet withenable_authentication
set totrue
.- maxclients int
Returns the max number of connected clients at the same time.
- maxfragmentationmemory_
reserved int Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
- maxmemory_
delta int The max-memory delta for this Redis instance. Defaults are shown below.
- maxmemory_
policy str How Redis will select what to remove when
maxmemory
is reached. Defaults tovolatile-lru
.- maxmemory_
reserved int Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
- notify_
keyspace_ strevents Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- rdb_
backup_ boolenabled Is Backup Enabled? Only supported on Premium SKUs. Defaults to
false
.NOTE: If
rdb_backup_enabled
set totrue
,rdb_storage_connection_string
must also be set.- rdb_
backup_ intfrequency The Backup Frequency in Minutes. Only supported on Premium SKUs. Possible values are:
15
,30
,60
,360
,720
and1440
.- rdb_
backup_ intmax_ snapshot_ count The maximum number of snapshots to create as a backup. Only supported for Premium SKUs.
- rdb_
storage_ strconnection_ string The Connection String to the Storage Account. Only supported for Premium SKUs. In the format:
DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}
.NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the
ignoreChanges
attribute to ignore changes to this field e.g.:package generated_program;
import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.azure.redis.Cache; import com.pulumi.azure.redis.CacheArgs; 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 Cache("example", CacheArgs.builder() .ignoreChanges(redis_configuration[0].rdb_storage_connection_string()) .build()); }
}
resources: example: type: azure:redis:Cache properties: # ... ignoreChanges: - ${redis_configuration[0].rdb_storage_connection_string}
- active
Directory BooleanAuthentication Enabled Enable Microsoft Entra (AAD) authentication. Defaults to
false
.- aof
Backup BooleanEnabled Enable or disable AOF persistence for this Redis Cache. Defaults to
false
.NOTE:
aof_backup_enabled
can only be set when SKU isPremium
.- aof
Storage StringConnection String0 First Storage Account connection string for AOF persistence.
- aof
Storage StringConnection String1 Second Storage Account connection string for AOF persistence.
Example usage:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- enable
Authentication Boolean If set to
false
, the Redis instance will be accessible without authentication. Defaults totrue
.NOTE:
enable_authentication
can only be set tofalse
if asubnet_id
is specified; and only works if there aren't existing instances within the subnet withenable_authentication
set totrue
.- maxclients Number
Returns the max number of connected clients at the same time.
- maxfragmentationmemory
Reserved Number Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
- maxmemory
Delta Number The max-memory delta for this Redis instance. Defaults are shown below.
- maxmemory
Policy String How Redis will select what to remove when
maxmemory
is reached. Defaults tovolatile-lru
.- maxmemory
Reserved Number Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
- notify
Keyspace StringEvents Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- rdb
Backup BooleanEnabled Is Backup Enabled? Only supported on Premium SKUs. Defaults to
false
.NOTE: If
rdb_backup_enabled
set totrue
,rdb_storage_connection_string
must also be set.- rdb
Backup NumberFrequency The Backup Frequency in Minutes. Only supported on Premium SKUs. Possible values are:
15
,30
,60
,360
,720
and1440
.- rdb
Backup NumberMax Snapshot Count The maximum number of snapshots to create as a backup. Only supported for Premium SKUs.
- rdb
Storage StringConnection String The Connection String to the Storage Account. Only supported for Premium SKUs. In the format:
DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}
.NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the
ignoreChanges
attribute to ignore changes to this field e.g.:package generated_program;
import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.azure.redis.Cache; import com.pulumi.azure.redis.CacheArgs; 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 Cache("example", CacheArgs.builder() .ignoreChanges(redis_configuration[0].rdb_storage_connection_string()) .build()); }
}
resources: example: type: azure:redis:Cache properties: # ... ignoreChanges: - ${redis_configuration[0].rdb_storage_connection_string}
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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.