Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. cache
  5. Database
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.cache.Database

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure-native

    Describes a database on the RedisEnterprise cluster Azure REST API version: 2023-03-01-preview. Prior API version in Azure Native 1.x: 2021-03-01.

    Other available API versions: 2023-07-01, 2023-08-01-preview, 2023-10-01-preview, 2023-11-01, 2024-02-01.

    Example Usage

    RedisEnterpriseDatabasesCreate

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

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

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cache.NewDatabase(ctx, "database", &cache.DatabaseArgs{
			ClientProtocol:   pulumi.String(cache.ProtocolEncrypted),
			ClusterName:      pulumi.String("cache1"),
			ClusteringPolicy: pulumi.String(cache.ClusteringPolicyEnterpriseCluster),
			DatabaseName:     pulumi.String("default"),
			EvictionPolicy:   pulumi.String(cache.EvictionPolicyAllKeysLRU),
			Modules: cache.ModuleArray{
				&cache.ModuleArgs{
					Args: pulumi.String("ERROR_RATE 0.00 INITIAL_SIZE 400"),
					Name: pulumi.String("RedisBloom"),
				},
				&cache.ModuleArgs{
					Args: pulumi.String("RETENTION_POLICY 20"),
					Name: pulumi.String("RedisTimeSeries"),
				},
				&cache.ModuleArgs{
					Name: pulumi.String("RediSearch"),
				},
			},
			Persistence: &cache.PersistenceArgs{
				AofEnabled:   pulumi.Bool(true),
				AofFrequency: pulumi.String(cache.AofFrequency_1s),
			},
			Port:              pulumi.Int(10000),
			ResourceGroupName: pulumi.String("rg1"),
		})
		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.azurenative.cache.Database;
import com.pulumi.azurenative.cache.DatabaseArgs;
import com.pulumi.azurenative.cache.inputs.ModuleArgs;
import com.pulumi.azurenative.cache.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")
            .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());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

database = azure_native.cache.Database("database",
    client_protocol=azure_native.cache.Protocol.ENCRYPTED,
    cluster_name="cache1",
    clustering_policy=azure_native.cache.ClusteringPolicy.ENTERPRISE_CLUSTER,
    database_name="default",
    eviction_policy=azure_native.cache.EvictionPolicy.ALL_KEYS_LRU,
    modules=[
        azure_native.cache.ModuleArgs(
            args="ERROR_RATE 0.00 INITIAL_SIZE 400",
            name="RedisBloom",
        ),
        azure_native.cache.ModuleArgs(
            args="RETENTION_POLICY 20",
            name="RedisTimeSeries",
        ),
        azure_native.cache.ModuleArgs(
            name="RediSearch",
        ),
    ],
    persistence=azure_native.cache.PersistenceArgs(
        aof_enabled=True,
        aof_frequency=azure_native.cache.AofFrequency.AOF_FREQUENCY_1S,
    ),
    port=10000,
    resource_group_name="rg1")

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

const database = new azure_native.cache.Database("database", {
    clientProtocol: azure_native.cache.Protocol.Encrypted,
    clusterName: "cache1",
    clusteringPolicy: azure_native.cache.ClusteringPolicy.EnterpriseCluster,
    databaseName: "default",
    evictionPolicy: azure_native.cache.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.cache.AofFrequency.AofFrequency_1s,
    },
    port: 10000,
    resourceGroupName: "rg1",
});

    resources:
  database:
    type: azure-native:cache:Database
    properties:
      clientProtocol: Encrypted
      clusterName: cache1
      clusteringPolicy: EnterpriseCluster
      databaseName: default
      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

    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.Cache.Database("database", new()
    {
        ClientProtocol = AzureNative.Cache.Protocol.Encrypted,
        ClusterName = "cache1",
        ClusteringPolicy = AzureNative.Cache.ClusteringPolicy.EnterpriseCluster,
        DatabaseName = "default",
        EvictionPolicy = AzureNative.Cache.EvictionPolicy.NoEviction,
        GeoReplication = new AzureNative.Cache.Inputs.DatabasePropertiesGeoReplicationArgs
        {
            GroupNickname = "groupName",
            LinkedDatabases = new[]
            {
                new AzureNative.Cache.Inputs.LinkedDatabaseArgs
                {
                    Id = "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
                },
                new AzureNative.Cache.Inputs.LinkedDatabaseArgs
                {
                    Id = "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
                },
            },
        },
        Port = 10000,
        ResourceGroupName = "rg1",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cache.NewDatabase(ctx, "database", &cache.DatabaseArgs{
			ClientProtocol:   pulumi.String(cache.ProtocolEncrypted),
			ClusterName:      pulumi.String("cache1"),
			ClusteringPolicy: pulumi.String(cache.ClusteringPolicyEnterpriseCluster),
			DatabaseName:     pulumi.String("default"),
			EvictionPolicy:   pulumi.String(cache.EvictionPolicyNoEviction),
			GeoReplication: &cache.DatabasePropertiesGeoReplicationArgs{
				GroupNickname: pulumi.String("groupName"),
				LinkedDatabases: cache.LinkedDatabaseArray{
					&cache.LinkedDatabaseArgs{
						Id: pulumi.String("/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"),
					},
					&cache.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
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cache.Database;
import com.pulumi.azurenative.cache.DatabaseArgs;
import com.pulumi.azurenative.cache.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());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

database = azure_native.cache.Database("database",
    client_protocol=azure_native.cache.Protocol.ENCRYPTED,
    cluster_name="cache1",
    clustering_policy=azure_native.cache.ClusteringPolicy.ENTERPRISE_CLUSTER,
    database_name="default",
    eviction_policy=azure_native.cache.EvictionPolicy.NO_EVICTION,
    geo_replication=azure_native.cache.DatabasePropertiesGeoReplicationArgs(
        group_nickname="groupName",
        linked_databases=[
            azure_native.cache.LinkedDatabaseArgs(
                id="/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
            ),
            azure_native.cache.LinkedDatabaseArgs(
                id="/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
            ),
        ],
    ),
    port=10000,
    resource_group_name="rg1")

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

const database = new azure_native.cache.Database("database", {
    clientProtocol: azure_native.cache.Protocol.Encrypted,
    clusterName: "cache1",
    clusteringPolicy: azure_native.cache.ClusteringPolicy.EnterpriseCluster,
    databaseName: "default",
    evictionPolicy: azure_native.cache.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",
});

    resources:
  database:
    type: azure-native:cache: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

    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,
             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:cache:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DatabaseArgs
    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 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 string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var databaseResource = new AzureNative.Cache.Database("databaseResource", new()
{
    ClusterName = "string",
    ResourceGroupName = "string",
    ClientProtocol = "string",
    ClusteringPolicy = "string",
    DatabaseName = "string",
    EvictionPolicy = "string",
    GeoReplication = new AzureNative.Cache.Inputs.DatabasePropertiesGeoReplicationArgs
    {
        GroupNickname = "string",
        LinkedDatabases = new[]
        {
            new AzureNative.Cache.Inputs.LinkedDatabaseArgs
            {
                Id = "string",
            },
        },
    },
    Modules = new[]
    {
        new AzureNative.Cache.Inputs.ModuleArgs
        {
            Name = "string",
            Args = "string",
        },
    },
    Persistence = new AzureNative.Cache.Inputs.PersistenceArgs
    {
        AofEnabled = false,
        AofFrequency = "string",
        RdbEnabled = false,
        RdbFrequency = "string",
    },
    Port = 0,
});

    example, err := cache.NewDatabase(ctx, "databaseResource", &cache.DatabaseArgs{
ClusterName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ClientProtocol: pulumi.String("string"),
ClusteringPolicy: pulumi.String("string"),
DatabaseName: pulumi.String("string"),
EvictionPolicy: pulumi.String("string"),
GeoReplication: &cache.DatabasePropertiesGeoReplicationArgs{
GroupNickname: pulumi.String("string"),
LinkedDatabases: cache.LinkedDatabaseArray{
&cache.LinkedDatabaseArgs{
Id: pulumi.String("string"),
},
},
},
Modules: cache.ModuleArray{
&cache.ModuleArgs{
Name: pulumi.String("string"),
Args: pulumi.String("string"),
},
},
Persistence: &cache.PersistenceArgs{
AofEnabled: pulumi.Bool(false),
AofFrequency: pulumi.String("string"),
RdbEnabled: pulumi.Bool(false),
RdbFrequency: pulumi.String("string"),
},
Port: pulumi.Int(0),
})

    var databaseResource = new Database("databaseResource", DatabaseArgs.builder()        
    .clusterName("string")
    .resourceGroupName("string")
    .clientProtocol("string")
    .clusteringPolicy("string")
    .databaseName("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());

    database_resource = azure_native.cache.Database("databaseResource",
    cluster_name="string",
    resource_group_name="string",
    client_protocol="string",
    clustering_policy="string",
    database_name="string",
    eviction_policy="string",
    geo_replication=azure_native.cache.DatabasePropertiesGeoReplicationArgs(
        group_nickname="string",
        linked_databases=[azure_native.cache.LinkedDatabaseArgs(
            id="string",
        )],
    ),
    modules=[azure_native.cache.ModuleArgs(
        name="string",
        args="string",
    )],
    persistence=azure_native.cache.PersistenceArgs(
        aof_enabled=False,
        aof_frequency="string",
        rdb_enabled=False,
        rdb_frequency="string",
    ),
    port=0)

    const databaseResource = new azure_native.cache.Database("databaseResource", {
    clusterName: "string",
    resourceGroupName: "string",
    clientProtocol: "string",
    clusteringPolicy: "string",
    databaseName: "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,
});

    type: azure-native:cache:Database
properties:
    clientProtocol: string
    clusterName: string
    clusteringPolicy: string
    databaseName: 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

    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

    The Database resource accepts the following input properties:

    ClusterName string
    The name of the RedisEnterprise cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClientProtocol string | Pulumi.AzureNative.Cache.Protocol
    Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
    ClusteringPolicy string | Pulumi.AzureNative.Cache.ClusteringPolicy
    Clustering policy - default is OSSCluster. Specified at create time.
    DatabaseName string
    The name of the database.
    EvictionPolicy string | Pulumi.AzureNative.Cache.EvictionPolicy
    Redis eviction policy - default is VolatileLRU
    GeoReplication Pulumi.AzureNative.Cache.Inputs.DatabasePropertiesGeoReplication
    Optional set of properties to configure geo replication for this database.
    Modules List<Pulumi.AzureNative.Cache.Inputs.Module>
    Optional set of redis modules to enable in this database - modules can only be added at creation time.
    Persistence Pulumi.AzureNative.Cache.Inputs.Persistence
    Persistence settings
    Port int
    TCP port of the database endpoint. Specified at create time. Defaults to an available port.
    ClusterName string
    The name of the RedisEnterprise cluster.
    ResourceGroupName 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 string | ClusteringPolicy
    Clustering policy - default is OSSCluster. Specified at create time.
    DatabaseName string
    The name of the database.
    EvictionPolicy string | EvictionPolicy
    Redis eviction policy - default is VolatileLRU
    GeoReplication DatabasePropertiesGeoReplicationArgs
    Optional set of properties to configure geo replication for this database.
    Modules []ModuleArgs
    Optional set of redis modules to enable in this database - modules can only be added at creation time.
    Persistence PersistenceArgs
    Persistence settings
    Port int
    TCP port of the database endpoint. Specified at create time. Defaults to an available port.
    clusterName String
    The name of the RedisEnterprise cluster.
    resourceGroupName 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 String | ClusteringPolicy
    Clustering policy - default is OSSCluster. Specified at create time.
    databaseName String
    The name of the database.
    evictionPolicy String | EvictionPolicy
    Redis eviction policy - default is VolatileLRU
    geoReplication DatabasePropertiesGeoReplication
    Optional set of properties to configure geo replication for this database.
    modules 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 Integer
    TCP port of the database endpoint. Specified at create time. Defaults to an available port.
    clusterName string
    The name of the RedisEnterprise cluster.
    resourceGroupName 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 string | ClusteringPolicy
    Clustering policy - default is OSSCluster. Specified at create time.
    databaseName string
    The name of the database.
    evictionPolicy string | EvictionPolicy
    Redis eviction policy - default is VolatileLRU
    geoReplication DatabasePropertiesGeoReplication
    Optional set of properties to configure geo replication for this database.
    modules Module[]
    Optional set of redis modules to enable in this database - modules can only be added at creation time.
    persistence Persistence
    Persistence settings
    port number
    TCP port of the database endpoint. Specified at create time. Defaults to an available port.
    cluster_name str
    The name of the RedisEnterprise cluster.
    resource_group_name 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 str | ClusteringPolicy
    Clustering policy - default is OSSCluster. Specified at create time.
    database_name str
    The name of the database.
    eviction_policy str | EvictionPolicy
    Redis eviction policy - default is VolatileLRU
    geo_replication DatabasePropertiesGeoReplicationArgs
    Optional set of properties to configure geo replication for this database.
    modules 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 int
    TCP port of the database endpoint. Specified at create time. Defaults to an available port.
    clusterName String
    The name of the RedisEnterprise cluster.
    resourceGroupName 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 String | "EnterpriseCluster" | "OSSCluster"
    Clustering policy - default is OSSCluster. Specified at create time.
    databaseName String
    The name of the database.
    evictionPolicy String | "AllKeysLFU" | "AllKeysLRU" | "AllKeysRandom" | "VolatileLRU" | "VolatileLFU" | "VolatileTTL" | "VolatileRandom" | "NoEviction"
    Redis eviction policy - default is VolatileLRU
    geoReplication Property Map
    Optional set of properties to configure geo replication for this database.
    modules 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 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:

    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
    ResourceState string
    Current resource status of the database
    SystemData Pulumi.AzureNative.Cache.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    ResourceState string
    Current resource status of the database
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    resourceState String
    Current resource status of the database
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    resourceState string
    Current resource status of the database
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    resource_state str
    Current resource status of the database
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    resourceState String
    Current resource status of the database
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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.Cache.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.Cache.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

    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 string
    State of the link between the database resources.
    Id string
    Resource ID of a database resource to link with this database.
    State string
    State of the link between the database resources.
    Id string
    Resource ID of a database resource to link with this database.
    state String
    State of the link between the database resources.
    id String
    Resource ID of a database resource to link with this database.
    state string
    State of the link between the database resources.
    id string
    Resource ID of a database resource to link with this database.
    state str
    State of the link between the database resources.
    id str
    Resource ID of a database resource to link with this database.
    state 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 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 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 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 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 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 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 string
    The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
    Version 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 string
    The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
    Version 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 String
    The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
    version 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 string
    The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
    version 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 str
    The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
    version 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 String
    The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
    version 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.Cache.AofFrequency
    Sets the frequency at which data is written to disk.
    RdbEnabled bool
    Sets whether RDB is enabled.
    RdbFrequency string | Pulumi.AzureNative.Cache.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

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

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

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

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
    pulumi/pulumi-azure-native