1. Packages
  2. Azure Native
  3. API Docs
  4. redisenterprise
  5. Database
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.redisenterprise.Database

Explore with Pulumi AI

Describes a database on the RedisEnterprise cluster

Uses Azure REST API version 2024-03-01-preview.

Other available API versions: 2020-10-01-preview, 2021-02-01-preview, 2021-03-01, 2021-08-01, 2022-01-01, 2022-11-01-preview, 2023-03-01-preview, 2023-07-01, 2023-08-01-preview, 2023-10-01-preview, 2023-11-01, 2024-02-01, 2024-06-01-preview, 2024-09-01-preview, 2024-10-01, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native redisenterprise [ApiVersion]. See the version guide for details.

Example Usage

RedisEnterpriseDatabasesCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var database = new AzureNative.RedisEnterprise.Database("database", new()
    {
        ClientProtocol = AzureNative.RedisEnterprise.Protocol.Encrypted,
        ClusterName = "cache1",
        ClusteringPolicy = AzureNative.RedisEnterprise.ClusteringPolicy.EnterpriseCluster,
        DatabaseName = "default",
        DeferUpgrade = AzureNative.RedisEnterprise.DeferUpgradeSetting.NotDeferred,
        EvictionPolicy = AzureNative.RedisEnterprise.EvictionPolicy.AllKeysLRU,
        Modules = new[]
        {
            new AzureNative.RedisEnterprise.Inputs.ModuleArgs
            {
                Args = "ERROR_RATE 0.00 INITIAL_SIZE 400",
                Name = "RedisBloom",
            },
            new AzureNative.RedisEnterprise.Inputs.ModuleArgs
            {
                Args = "RETENTION_POLICY 20",
                Name = "RedisTimeSeries",
            },
            new AzureNative.RedisEnterprise.Inputs.ModuleArgs
            {
                Name = "RediSearch",
            },
        },
        Persistence = new AzureNative.RedisEnterprise.Inputs.PersistenceArgs
        {
            AofEnabled = true,
            AofFrequency = AzureNative.RedisEnterprise.AofFrequency.AofFrequency_1s,
        },
        Port = 10000,
        ResourceGroupName = "rg1",
    });

});
Copy
package main

import (
	redisenterprise "github.com/pulumi/pulumi-azure-native-sdk/redisenterprise/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redisenterprise.NewDatabase(ctx, "database", &redisenterprise.DatabaseArgs{
			ClientProtocol:   pulumi.String(redisenterprise.ProtocolEncrypted),
			ClusterName:      pulumi.String("cache1"),
			ClusteringPolicy: pulumi.String(redisenterprise.ClusteringPolicyEnterpriseCluster),
			DatabaseName:     pulumi.String("default"),
			DeferUpgrade:     pulumi.String(redisenterprise.DeferUpgradeSettingNotDeferred),
			EvictionPolicy:   pulumi.String(redisenterprise.EvictionPolicyAllKeysLRU),
			Modules: redisenterprise.ModuleArray{
				&redisenterprise.ModuleArgs{
					Args: pulumi.String("ERROR_RATE 0.00 INITIAL_SIZE 400"),
					Name: pulumi.String("RedisBloom"),
				},
				&redisenterprise.ModuleArgs{
					Args: pulumi.String("RETENTION_POLICY 20"),
					Name: pulumi.String("RedisTimeSeries"),
				},
				&redisenterprise.ModuleArgs{
					Name: pulumi.String("RediSearch"),
				},
			},
			Persistence: &redisenterprise.PersistenceArgs{
				AofEnabled:   pulumi.Bool(true),
				AofFrequency: pulumi.String(redisenterprise.AofFrequency_1s),
			},
			Port:              pulumi.Int(10000),
			ResourceGroupName: pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.redisenterprise.Database;
import com.pulumi.azurenative.redisenterprise.DatabaseArgs;
import com.pulumi.azurenative.redisenterprise.inputs.ModuleArgs;
import com.pulumi.azurenative.redisenterprise.inputs.PersistenceArgs;
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 database = new Database("database", DatabaseArgs.builder()
            .clientProtocol("Encrypted")
            .clusterName("cache1")
            .clusteringPolicy("EnterpriseCluster")
            .databaseName("default")
            .deferUpgrade("NotDeferred")
            .evictionPolicy("AllKeysLRU")
            .modules(            
                ModuleArgs.builder()
                    .args("ERROR_RATE 0.00 INITIAL_SIZE 400")
                    .name("RedisBloom")
                    .build(),
                ModuleArgs.builder()
                    .args("RETENTION_POLICY 20")
                    .name("RedisTimeSeries")
                    .build(),
                ModuleArgs.builder()
                    .name("RediSearch")
                    .build())
            .persistence(PersistenceArgs.builder()
                .aofEnabled(true)
                .aofFrequency("1s")
                .build())
            .port(10000)
            .resourceGroupName("rg1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const database = new azure_native.redisenterprise.Database("database", {
    clientProtocol: azure_native.redisenterprise.Protocol.Encrypted,
    clusterName: "cache1",
    clusteringPolicy: azure_native.redisenterprise.ClusteringPolicy.EnterpriseCluster,
    databaseName: "default",
    deferUpgrade: azure_native.redisenterprise.DeferUpgradeSetting.NotDeferred,
    evictionPolicy: azure_native.redisenterprise.EvictionPolicy.AllKeysLRU,
    modules: [
        {
            args: "ERROR_RATE 0.00 INITIAL_SIZE 400",
            name: "RedisBloom",
        },
        {
            args: "RETENTION_POLICY 20",
            name: "RedisTimeSeries",
        },
        {
            name: "RediSearch",
        },
    ],
    persistence: {
        aofEnabled: true,
        aofFrequency: azure_native.redisenterprise.AofFrequency.AofFrequency_1s,
    },
    port: 10000,
    resourceGroupName: "rg1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

database = azure_native.redisenterprise.Database("database",
    client_protocol=azure_native.redisenterprise.Protocol.ENCRYPTED,
    cluster_name="cache1",
    clustering_policy=azure_native.redisenterprise.ClusteringPolicy.ENTERPRISE_CLUSTER,
    database_name="default",
    defer_upgrade=azure_native.redisenterprise.DeferUpgradeSetting.NOT_DEFERRED,
    eviction_policy=azure_native.redisenterprise.EvictionPolicy.ALL_KEYS_LRU,
    modules=[
        {
            "args": "ERROR_RATE 0.00 INITIAL_SIZE 400",
            "name": "RedisBloom",
        },
        {
            "args": "RETENTION_POLICY 20",
            "name": "RedisTimeSeries",
        },
        {
            "name": "RediSearch",
        },
    ],
    persistence={
        "aof_enabled": True,
        "aof_frequency": azure_native.redisenterprise.AofFrequency.AOF_FREQUENCY_1S,
    },
    port=10000,
    resource_group_name="rg1")
Copy
resources:
  database:
    type: azure-native:redisenterprise:Database
    properties:
      clientProtocol: Encrypted
      clusterName: cache1
      clusteringPolicy: EnterpriseCluster
      databaseName: default
      deferUpgrade: NotDeferred
      evictionPolicy: AllKeysLRU
      modules:
        - args: ERROR_RATE 0.00 INITIAL_SIZE 400
          name: RedisBloom
        - args: RETENTION_POLICY 20
          name: RedisTimeSeries
        - name: RediSearch
      persistence:
        aofEnabled: true
        aofFrequency: 1s
      port: 10000
      resourceGroupName: rg1
Copy

RedisEnterpriseDatabasesCreate With Active Geo Replication

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var database = new AzureNative.RedisEnterprise.Database("database", new()
    {
        ClientProtocol = AzureNative.RedisEnterprise.Protocol.Encrypted,
        ClusterName = "cache1",
        ClusteringPolicy = AzureNative.RedisEnterprise.ClusteringPolicy.EnterpriseCluster,
        DatabaseName = "default",
        EvictionPolicy = AzureNative.RedisEnterprise.EvictionPolicy.NoEviction,
        GeoReplication = new AzureNative.RedisEnterprise.Inputs.DatabasePropertiesGeoReplicationArgs
        {
            GroupNickname = "groupName",
            LinkedDatabases = new[]
            {
                new AzureNative.RedisEnterprise.Inputs.LinkedDatabaseArgs
                {
                    Id = "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
                },
                new AzureNative.RedisEnterprise.Inputs.LinkedDatabaseArgs
                {
                    Id = "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
                },
            },
        },
        Port = 10000,
        ResourceGroupName = "rg1",
    });

});
Copy
package main

import (
	redisenterprise "github.com/pulumi/pulumi-azure-native-sdk/redisenterprise/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redisenterprise.NewDatabase(ctx, "database", &redisenterprise.DatabaseArgs{
			ClientProtocol:   pulumi.String(redisenterprise.ProtocolEncrypted),
			ClusterName:      pulumi.String("cache1"),
			ClusteringPolicy: pulumi.String(redisenterprise.ClusteringPolicyEnterpriseCluster),
			DatabaseName:     pulumi.String("default"),
			EvictionPolicy:   pulumi.String(redisenterprise.EvictionPolicyNoEviction),
			GeoReplication: &redisenterprise.DatabasePropertiesGeoReplicationArgs{
				GroupNickname: pulumi.String("groupName"),
				LinkedDatabases: redisenterprise.LinkedDatabaseArray{
					&redisenterprise.LinkedDatabaseArgs{
						Id: pulumi.String("/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"),
					},
					&redisenterprise.LinkedDatabaseArgs{
						Id: pulumi.String("/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"),
					},
				},
			},
			Port:              pulumi.Int(10000),
			ResourceGroupName: pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.redisenterprise.Database;
import com.pulumi.azurenative.redisenterprise.DatabaseArgs;
import com.pulumi.azurenative.redisenterprise.inputs.DatabasePropertiesGeoReplicationArgs;
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 database = new Database("database", DatabaseArgs.builder()
            .clientProtocol("Encrypted")
            .clusterName("cache1")
            .clusteringPolicy("EnterpriseCluster")
            .databaseName("default")
            .evictionPolicy("NoEviction")
            .geoReplication(DatabasePropertiesGeoReplicationArgs.builder()
                .groupNickname("groupName")
                .linkedDatabases(                
                    LinkedDatabaseArgs.builder()
                        .id("/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default")
                        .build(),
                    LinkedDatabaseArgs.builder()
                        .id("/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default")
                        .build())
                .build())
            .port(10000)
            .resourceGroupName("rg1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const database = new azure_native.redisenterprise.Database("database", {
    clientProtocol: azure_native.redisenterprise.Protocol.Encrypted,
    clusterName: "cache1",
    clusteringPolicy: azure_native.redisenterprise.ClusteringPolicy.EnterpriseCluster,
    databaseName: "default",
    evictionPolicy: azure_native.redisenterprise.EvictionPolicy.NoEviction,
    geoReplication: {
        groupNickname: "groupName",
        linkedDatabases: [
            {
                id: "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
            },
            {
                id: "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
            },
        ],
    },
    port: 10000,
    resourceGroupName: "rg1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

database = azure_native.redisenterprise.Database("database",
    client_protocol=azure_native.redisenterprise.Protocol.ENCRYPTED,
    cluster_name="cache1",
    clustering_policy=azure_native.redisenterprise.ClusteringPolicy.ENTERPRISE_CLUSTER,
    database_name="default",
    eviction_policy=azure_native.redisenterprise.EvictionPolicy.NO_EVICTION,
    geo_replication={
        "group_nickname": "groupName",
        "linked_databases": [
            {
                "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
            },
            {
                "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
            },
        ],
    },
    port=10000,
    resource_group_name="rg1")
Copy
resources:
  database:
    type: azure-native:redisenterprise:Database
    properties:
      clientProtocol: Encrypted
      clusterName: cache1
      clusteringPolicy: EnterpriseCluster
      databaseName: default
      evictionPolicy: NoEviction
      geoReplication:
        groupNickname: groupName
        linkedDatabases:
          - id: /subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default
          - id: /subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default
      port: 10000
      resourceGroupName: rg1
Copy

Create Database Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
@overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cluster_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             client_protocol: Optional[Union[str, Protocol]] = None,
             clustering_policy: Optional[Union[str, ClusteringPolicy]] = None,
             database_name: Optional[str] = None,
             defer_upgrade: Optional[Union[str, DeferUpgradeSetting]] = None,
             eviction_policy: Optional[Union[str, EvictionPolicy]] = None,
             geo_replication: Optional[DatabasePropertiesGeoReplicationArgs] = None,
             modules: Optional[Sequence[ModuleArgs]] = None,
             persistence: Optional[PersistenceArgs] = None,
             port: Optional[int] = None)
func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)
type: azure-native:redisenterprise:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampledatabaseResourceResourceFromRedisenterprise = new AzureNative.RedisEnterprise.Database("exampledatabaseResourceResourceFromRedisenterprise", new()
{
    ClusterName = "string",
    ResourceGroupName = "string",
    ClientProtocol = "string",
    ClusteringPolicy = "string",
    DatabaseName = "string",
    DeferUpgrade = "string",
    EvictionPolicy = "string",
    GeoReplication = new AzureNative.RedisEnterprise.Inputs.DatabasePropertiesGeoReplicationArgs
    {
        GroupNickname = "string",
        LinkedDatabases = new[]
        {
            new AzureNative.RedisEnterprise.Inputs.LinkedDatabaseArgs
            {
                Id = "string",
            },
        },
    },
    Modules = new[]
    {
        new AzureNative.RedisEnterprise.Inputs.ModuleArgs
        {
            Name = "string",
            Args = "string",
        },
    },
    Persistence = new AzureNative.RedisEnterprise.Inputs.PersistenceArgs
    {
        AofEnabled = false,
        AofFrequency = "string",
        RdbEnabled = false,
        RdbFrequency = "string",
    },
    Port = 0,
});
Copy
example, err := redisenterprise.NewDatabase(ctx, "exampledatabaseResourceResourceFromRedisenterprise", &redisenterprise.DatabaseArgs{
	ClusterName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ClientProtocol:    pulumi.String("string"),
	ClusteringPolicy:  pulumi.String("string"),
	DatabaseName:      pulumi.String("string"),
	DeferUpgrade:      pulumi.String("string"),
	EvictionPolicy:    pulumi.String("string"),
	GeoReplication: &redisenterprise.DatabasePropertiesGeoReplicationArgs{
		GroupNickname: pulumi.String("string"),
		LinkedDatabases: redisenterprise.LinkedDatabaseArray{
			&redisenterprise.LinkedDatabaseArgs{
				Id: pulumi.String("string"),
			},
		},
	},
	Modules: redisenterprise.ModuleArray{
		&redisenterprise.ModuleArgs{
			Name: pulumi.String("string"),
			Args: pulumi.String("string"),
		},
	},
	Persistence: &redisenterprise.PersistenceArgs{
		AofEnabled:   pulumi.Bool(false),
		AofFrequency: pulumi.String("string"),
		RdbEnabled:   pulumi.Bool(false),
		RdbFrequency: pulumi.String("string"),
	},
	Port: pulumi.Int(0),
})
Copy
var exampledatabaseResourceResourceFromRedisenterprise = new Database("exampledatabaseResourceResourceFromRedisenterprise", DatabaseArgs.builder()
    .clusterName("string")
    .resourceGroupName("string")
    .clientProtocol("string")
    .clusteringPolicy("string")
    .databaseName("string")
    .deferUpgrade("string")
    .evictionPolicy("string")
    .geoReplication(DatabasePropertiesGeoReplicationArgs.builder()
        .groupNickname("string")
        .linkedDatabases(LinkedDatabaseArgs.builder()
            .id("string")
            .build())
        .build())
    .modules(ModuleArgs.builder()
        .name("string")
        .args("string")
        .build())
    .persistence(PersistenceArgs.builder()
        .aofEnabled(false)
        .aofFrequency("string")
        .rdbEnabled(false)
        .rdbFrequency("string")
        .build())
    .port(0)
    .build());
Copy
exampledatabase_resource_resource_from_redisenterprise = azure_native.redisenterprise.Database("exampledatabaseResourceResourceFromRedisenterprise",
    cluster_name="string",
    resource_group_name="string",
    client_protocol="string",
    clustering_policy="string",
    database_name="string",
    defer_upgrade="string",
    eviction_policy="string",
    geo_replication={
        "group_nickname": "string",
        "linked_databases": [{
            "id": "string",
        }],
    },
    modules=[{
        "name": "string",
        "args": "string",
    }],
    persistence={
        "aof_enabled": False,
        "aof_frequency": "string",
        "rdb_enabled": False,
        "rdb_frequency": "string",
    },
    port=0)
Copy
const exampledatabaseResourceResourceFromRedisenterprise = new azure_native.redisenterprise.Database("exampledatabaseResourceResourceFromRedisenterprise", {
    clusterName: "string",
    resourceGroupName: "string",
    clientProtocol: "string",
    clusteringPolicy: "string",
    databaseName: "string",
    deferUpgrade: "string",
    evictionPolicy: "string",
    geoReplication: {
        groupNickname: "string",
        linkedDatabases: [{
            id: "string",
        }],
    },
    modules: [{
        name: "string",
        args: "string",
    }],
    persistence: {
        aofEnabled: false,
        aofFrequency: "string",
        rdbEnabled: false,
        rdbFrequency: "string",
    },
    port: 0,
});
Copy
type: azure-native:redisenterprise:Database
properties:
    clientProtocol: string
    clusterName: string
    clusteringPolicy: string
    databaseName: string
    deferUpgrade: string
    evictionPolicy: string
    geoReplication:
        groupNickname: string
        linkedDatabases:
            - id: string
    modules:
        - args: string
          name: string
    persistence:
        aofEnabled: false
        aofFrequency: string
        rdbEnabled: false
        rdbFrequency: string
    port: 0
    resourceGroupName: string
Copy

Database Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Database resource accepts the following input properties:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis Enterprise cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ClientProtocol string | Pulumi.AzureNative.RedisEnterprise.Protocol
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
ClusteringPolicy Changes to this property will trigger replacement. string | Pulumi.AzureNative.RedisEnterprise.ClusteringPolicy
Clustering policy - default is OSSCluster. Specified at create time.
DatabaseName Changes to this property will trigger replacement. string
The name of the Redis Enterprise database.
DeferUpgrade string | Pulumi.AzureNative.RedisEnterprise.DeferUpgradeSetting
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
EvictionPolicy string | Pulumi.AzureNative.RedisEnterprise.EvictionPolicy
Redis eviction policy - default is VolatileLRU
GeoReplication Changes to this property will trigger replacement. Pulumi.AzureNative.RedisEnterprise.Inputs.DatabasePropertiesGeoReplication
Optional set of properties to configure geo replication for this database.
Modules Changes to this property will trigger replacement. List<Pulumi.AzureNative.RedisEnterprise.Inputs.Module>
Optional set of redis modules to enable in this database - modules can only be added at creation time.
Persistence Pulumi.AzureNative.RedisEnterprise.Inputs.Persistence
Persistence settings
Port Changes to this property will trigger replacement. int
TCP port of the database endpoint. Specified at create time. Defaults to an available port.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis Enterprise cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ClientProtocol string | Protocol
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
ClusteringPolicy Changes to this property will trigger replacement. string | ClusteringPolicy
Clustering policy - default is OSSCluster. Specified at create time.
DatabaseName Changes to this property will trigger replacement. string
The name of the Redis Enterprise database.
DeferUpgrade string | DeferUpgradeSetting
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
EvictionPolicy string | EvictionPolicy
Redis eviction policy - default is VolatileLRU
GeoReplication Changes to this property will trigger replacement. DatabasePropertiesGeoReplicationArgs
Optional set of properties to configure geo replication for this database.
Modules Changes to this property will trigger replacement. []ModuleArgs
Optional set of redis modules to enable in this database - modules can only be added at creation time.
Persistence PersistenceArgs
Persistence settings
Port Changes to this property will trigger replacement. int
TCP port of the database endpoint. Specified at create time. Defaults to an available port.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis Enterprise cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
clientProtocol String | Protocol
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clusteringPolicy Changes to this property will trigger replacement. String | ClusteringPolicy
Clustering policy - default is OSSCluster. Specified at create time.
databaseName Changes to this property will trigger replacement. String
The name of the Redis Enterprise database.
deferUpgrade String | DeferUpgradeSetting
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
evictionPolicy String | EvictionPolicy
Redis eviction policy - default is VolatileLRU
geoReplication Changes to this property will trigger replacement. DatabasePropertiesGeoReplication
Optional set of properties to configure geo replication for this database.
modules Changes to this property will trigger replacement. List<Module>
Optional set of redis modules to enable in this database - modules can only be added at creation time.
persistence Persistence
Persistence settings
port Changes to this property will trigger replacement. Integer
TCP port of the database endpoint. Specified at create time. Defaults to an available port.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis Enterprise cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
clientProtocol string | Protocol
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clusteringPolicy Changes to this property will trigger replacement. string | ClusteringPolicy
Clustering policy - default is OSSCluster. Specified at create time.
databaseName Changes to this property will trigger replacement. string
The name of the Redis Enterprise database.
deferUpgrade string | DeferUpgradeSetting
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
evictionPolicy string | EvictionPolicy
Redis eviction policy - default is VolatileLRU
geoReplication Changes to this property will trigger replacement. DatabasePropertiesGeoReplication
Optional set of properties to configure geo replication for this database.
modules Changes to this property will trigger replacement. Module[]
Optional set of redis modules to enable in this database - modules can only be added at creation time.
persistence Persistence
Persistence settings
port Changes to this property will trigger replacement. number
TCP port of the database endpoint. Specified at create time. Defaults to an available port.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Redis Enterprise cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
client_protocol str | Protocol
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clustering_policy Changes to this property will trigger replacement. str | ClusteringPolicy
Clustering policy - default is OSSCluster. Specified at create time.
database_name Changes to this property will trigger replacement. str
The name of the Redis Enterprise database.
defer_upgrade str | DeferUpgradeSetting
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
eviction_policy str | EvictionPolicy
Redis eviction policy - default is VolatileLRU
geo_replication Changes to this property will trigger replacement. DatabasePropertiesGeoReplicationArgs
Optional set of properties to configure geo replication for this database.
modules Changes to this property will trigger replacement. Sequence[ModuleArgs]
Optional set of redis modules to enable in this database - modules can only be added at creation time.
persistence PersistenceArgs
Persistence settings
port Changes to this property will trigger replacement. int
TCP port of the database endpoint. Specified at create time. Defaults to an available port.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis Enterprise cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
clientProtocol String | "Encrypted" | "Plaintext"
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clusteringPolicy Changes to this property will trigger replacement. String | "EnterpriseCluster" | "OSSCluster"
Clustering policy - default is OSSCluster. Specified at create time.
databaseName Changes to this property will trigger replacement. String
The name of the Redis Enterprise database.
deferUpgrade String | "Deferred" | "NotDeferred"
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
evictionPolicy String | "AllKeysLFU" | "AllKeysLRU" | "AllKeysRandom" | "VolatileLRU" | "VolatileLFU" | "VolatileTTL" | "VolatileRandom" | "NoEviction"
Redis eviction policy - default is VolatileLRU
geoReplication Changes to this property will trigger replacement. Property Map
Optional set of properties to configure geo replication for this database.
modules Changes to this property will trigger replacement. List<Property Map>
Optional set of redis modules to enable in this database - modules can only be added at creation time.
persistence Property Map
Persistence settings
port Changes to this property will trigger replacement. Number
TCP port of the database endpoint. Specified at create time. Defaults to an available port.

Outputs

All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Current provisioning status of the database
RedisVersion string
Version of Redis the database is running on, e.g. '6.0'
ResourceState string
Current resource status of the database
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Current provisioning status of the database
RedisVersion string
Version of Redis the database is running on, e.g. '6.0'
ResourceState string
Current resource status of the database
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Current provisioning status of the database
redisVersion String
Version of Redis the database is running on, e.g. '6.0'
resourceState String
Current resource status of the database
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Current provisioning status of the database
redisVersion string
Version of Redis the database is running on, e.g. '6.0'
resourceState string
Current resource status of the database
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Current provisioning status of the database
redis_version str
Version of Redis the database is running on, e.g. '6.0'
resource_state str
Current resource status of the database
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Current provisioning status of the database
redisVersion String
Version of Redis the database is running on, e.g. '6.0'
resourceState String
Current resource status of the database
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

AofFrequency
, AofFrequencyArgs

AofFrequency_1s
1s
Always
always
AofFrequency_1s
1s
AofFrequencyAlways
always
_1s
1s
Always
always
AofFrequency_1s
1s
Always
always
AOF_FREQUENCY_1S
1s
ALWAYS
always
"1s"
1s
"always"
always

ClusteringPolicy
, ClusteringPolicyArgs

EnterpriseCluster
EnterpriseCluster
OSSCluster
OSSCluster
ClusteringPolicyEnterpriseCluster
EnterpriseCluster
ClusteringPolicyOSSCluster
OSSCluster
EnterpriseCluster
EnterpriseCluster
OSSCluster
OSSCluster
EnterpriseCluster
EnterpriseCluster
OSSCluster
OSSCluster
ENTERPRISE_CLUSTER
EnterpriseCluster
OSS_CLUSTER
OSSCluster
"EnterpriseCluster"
EnterpriseCluster
"OSSCluster"
OSSCluster

DatabasePropertiesGeoReplication
, DatabasePropertiesGeoReplicationArgs

GroupNickname string
Name for the group of linked database resources
LinkedDatabases List<Pulumi.AzureNative.RedisEnterprise.Inputs.LinkedDatabase>
List of database resources to link with this database
GroupNickname string
Name for the group of linked database resources
LinkedDatabases []LinkedDatabase
List of database resources to link with this database
groupNickname String
Name for the group of linked database resources
linkedDatabases List<LinkedDatabase>
List of database resources to link with this database
groupNickname string
Name for the group of linked database resources
linkedDatabases LinkedDatabase[]
List of database resources to link with this database
group_nickname str
Name for the group of linked database resources
linked_databases Sequence[LinkedDatabase]
List of database resources to link with this database
groupNickname String
Name for the group of linked database resources
linkedDatabases List<Property Map>
List of database resources to link with this database

DatabasePropertiesResponseGeoReplication
, DatabasePropertiesResponseGeoReplicationArgs

GroupNickname string
Name for the group of linked database resources
LinkedDatabases List<Pulumi.AzureNative.RedisEnterprise.Inputs.LinkedDatabaseResponse>
List of database resources to link with this database
GroupNickname string
Name for the group of linked database resources
LinkedDatabases []LinkedDatabaseResponse
List of database resources to link with this database
groupNickname String
Name for the group of linked database resources
linkedDatabases List<LinkedDatabaseResponse>
List of database resources to link with this database
groupNickname string
Name for the group of linked database resources
linkedDatabases LinkedDatabaseResponse[]
List of database resources to link with this database
group_nickname str
Name for the group of linked database resources
linked_databases Sequence[LinkedDatabaseResponse]
List of database resources to link with this database
groupNickname String
Name for the group of linked database resources
linkedDatabases List<Property Map>
List of database resources to link with this database

DeferUpgradeSetting
, DeferUpgradeSettingArgs

Deferred
Deferred
NotDeferred
NotDeferred
DeferUpgradeSettingDeferred
Deferred
DeferUpgradeSettingNotDeferred
NotDeferred
Deferred
Deferred
NotDeferred
NotDeferred
Deferred
Deferred
NotDeferred
NotDeferred
DEFERRED
Deferred
NOT_DEFERRED
NotDeferred
"Deferred"
Deferred
"NotDeferred"
NotDeferred

EvictionPolicy
, EvictionPolicyArgs

AllKeysLFU
AllKeysLFU
AllKeysLRU
AllKeysLRU
AllKeysRandom
AllKeysRandom
VolatileLRU
VolatileLRU
VolatileLFU
VolatileLFU
VolatileTTL
VolatileTTL
VolatileRandom
VolatileRandom
NoEviction
NoEviction
EvictionPolicyAllKeysLFU
AllKeysLFU
EvictionPolicyAllKeysLRU
AllKeysLRU
EvictionPolicyAllKeysRandom
AllKeysRandom
EvictionPolicyVolatileLRU
VolatileLRU
EvictionPolicyVolatileLFU
VolatileLFU
EvictionPolicyVolatileTTL
VolatileTTL
EvictionPolicyVolatileRandom
VolatileRandom
EvictionPolicyNoEviction
NoEviction
AllKeysLFU
AllKeysLFU
AllKeysLRU
AllKeysLRU
AllKeysRandom
AllKeysRandom
VolatileLRU
VolatileLRU
VolatileLFU
VolatileLFU
VolatileTTL
VolatileTTL
VolatileRandom
VolatileRandom
NoEviction
NoEviction
AllKeysLFU
AllKeysLFU
AllKeysLRU
AllKeysLRU
AllKeysRandom
AllKeysRandom
VolatileLRU
VolatileLRU
VolatileLFU
VolatileLFU
VolatileTTL
VolatileTTL
VolatileRandom
VolatileRandom
NoEviction
NoEviction
ALL_KEYS_LFU
AllKeysLFU
ALL_KEYS_LRU
AllKeysLRU
ALL_KEYS_RANDOM
AllKeysRandom
VOLATILE_LRU
VolatileLRU
VOLATILE_LFU
VolatileLFU
VOLATILE_TTL
VolatileTTL
VOLATILE_RANDOM
VolatileRandom
NO_EVICTION
NoEviction
"AllKeysLFU"
AllKeysLFU
"AllKeysLRU"
AllKeysLRU
"AllKeysRandom"
AllKeysRandom
"VolatileLRU"
VolatileLRU
"VolatileLFU"
VolatileLFU
"VolatileTTL"
VolatileTTL
"VolatileRandom"
VolatileRandom
"NoEviction"
NoEviction

LinkedDatabase
, LinkedDatabaseArgs

Id string
Resource ID of a database resource to link with this database.
Id string
Resource ID of a database resource to link with this database.
id String
Resource ID of a database resource to link with this database.
id string
Resource ID of a database resource to link with this database.
id str
Resource ID of a database resource to link with this database.
id String
Resource ID of a database resource to link with this database.

LinkedDatabaseResponse
, LinkedDatabaseResponseArgs

State This property is required. string
State of the link between the database resources.
Id string
Resource ID of a database resource to link with this database.
State This property is required. string
State of the link between the database resources.
Id string
Resource ID of a database resource to link with this database.
state This property is required. String
State of the link between the database resources.
id String
Resource ID of a database resource to link with this database.
state This property is required. string
State of the link between the database resources.
id string
Resource ID of a database resource to link with this database.
state This property is required. str
State of the link between the database resources.
id str
Resource ID of a database resource to link with this database.
state This property is required. String
State of the link between the database resources.
id String
Resource ID of a database resource to link with this database.

Module
, ModuleArgs

Name This property is required. string
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
Args string
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
Name This property is required. string
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
Args string
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name This property is required. String
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
args String
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name This property is required. string
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
args string
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name This property is required. str
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
args str
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name This property is required. String
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
args String
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.

ModuleResponse
, ModuleResponseArgs

Name This property is required. string
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
Version This property is required. string
The version of the module, e.g. '1.0'.
Args string
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
Name This property is required. string
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
Version This property is required. string
The version of the module, e.g. '1.0'.
Args string
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name This property is required. String
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version This property is required. String
The version of the module, e.g. '1.0'.
args String
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name This property is required. string
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version This property is required. string
The version of the module, e.g. '1.0'.
args string
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name This property is required. str
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version This property is required. str
The version of the module, e.g. '1.0'.
args str
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name This property is required. String
The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version This property is required. String
The version of the module, e.g. '1.0'.
args String
Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.

Persistence
, PersistenceArgs

AofEnabled bool
Sets whether AOF is enabled.
AofFrequency string | Pulumi.AzureNative.RedisEnterprise.AofFrequency
Sets the frequency at which data is written to disk.
RdbEnabled bool
Sets whether RDB is enabled.
RdbFrequency string | Pulumi.AzureNative.RedisEnterprise.RdbFrequency
Sets the frequency at which a snapshot of the database is created.
AofEnabled bool
Sets whether AOF is enabled.
AofFrequency string | AofFrequency
Sets the frequency at which data is written to disk.
RdbEnabled bool
Sets whether RDB is enabled.
RdbFrequency string | RdbFrequency
Sets the frequency at which a snapshot of the database is created.
aofEnabled Boolean
Sets whether AOF is enabled.
aofFrequency String | AofFrequency
Sets the frequency at which data is written to disk.
rdbEnabled Boolean
Sets whether RDB is enabled.
rdbFrequency String | RdbFrequency
Sets the frequency at which a snapshot of the database is created.
aofEnabled boolean
Sets whether AOF is enabled.
aofFrequency string | AofFrequency
Sets the frequency at which data is written to disk.
rdbEnabled boolean
Sets whether RDB is enabled.
rdbFrequency string | RdbFrequency
Sets the frequency at which a snapshot of the database is created.
aof_enabled bool
Sets whether AOF is enabled.
aof_frequency str | AofFrequency
Sets the frequency at which data is written to disk.
rdb_enabled bool
Sets whether RDB is enabled.
rdb_frequency str | RdbFrequency
Sets the frequency at which a snapshot of the database is created.
aofEnabled Boolean
Sets whether AOF is enabled.
aofFrequency String | "1s" | "always"
Sets the frequency at which data is written to disk.
rdbEnabled Boolean
Sets whether RDB is enabled.
rdbFrequency String | "1h" | "6h" | "12h"
Sets the frequency at which a snapshot of the database is created.

PersistenceResponse
, PersistenceResponseArgs

AofEnabled bool
Sets whether AOF is enabled.
AofFrequency string
Sets the frequency at which data is written to disk.
RdbEnabled bool
Sets whether RDB is enabled.
RdbFrequency string
Sets the frequency at which a snapshot of the database is created.
AofEnabled bool
Sets whether AOF is enabled.
AofFrequency string
Sets the frequency at which data is written to disk.
RdbEnabled bool
Sets whether RDB is enabled.
RdbFrequency string
Sets the frequency at which a snapshot of the database is created.
aofEnabled Boolean
Sets whether AOF is enabled.
aofFrequency String
Sets the frequency at which data is written to disk.
rdbEnabled Boolean
Sets whether RDB is enabled.
rdbFrequency String
Sets the frequency at which a snapshot of the database is created.
aofEnabled boolean
Sets whether AOF is enabled.
aofFrequency string
Sets the frequency at which data is written to disk.
rdbEnabled boolean
Sets whether RDB is enabled.
rdbFrequency string
Sets the frequency at which a snapshot of the database is created.
aof_enabled bool
Sets whether AOF is enabled.
aof_frequency str
Sets the frequency at which data is written to disk.
rdb_enabled bool
Sets whether RDB is enabled.
rdb_frequency str
Sets the frequency at which a snapshot of the database is created.
aofEnabled Boolean
Sets whether AOF is enabled.
aofFrequency String
Sets the frequency at which data is written to disk.
rdbEnabled Boolean
Sets whether RDB is enabled.
rdbFrequency String
Sets the frequency at which a snapshot of the database is created.

Protocol
, ProtocolArgs

Encrypted
Encrypted
Plaintext
Plaintext
ProtocolEncrypted
Encrypted
ProtocolPlaintext
Plaintext
Encrypted
Encrypted
Plaintext
Plaintext
Encrypted
Encrypted
Plaintext
Plaintext
ENCRYPTED
Encrypted
PLAINTEXT
Plaintext
"Encrypted"
Encrypted
"Plaintext"
Plaintext

RdbFrequency
, RdbFrequencyArgs

RdbFrequency_1h
1h
RdbFrequency_6h
6h
RdbFrequency_12h
12h
RdbFrequency_1h
1h
RdbFrequency_6h
6h
RdbFrequency_12h
12h
_1h
1h
_6h
6h
_12h
12h
RdbFrequency_1h
1h
RdbFrequency_6h
6h
RdbFrequency_12h
12h
RDB_FREQUENCY_1H
1h
RDB_FREQUENCY_6H
6h
RDB_FREQUENCY_12H
12h
"1h"
1h
"6h"
6h
"12h"
12h

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:redisenterprise:Database cache1/default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0