We recommend using Azure Native.
azure.redis.EnterpriseDatabase
Explore with Pulumi AI
Manages a Redis Enterprise Database.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-redisenterprise",
location: "West Europe",
});
const exampleEnterpriseCluster = new azure.redis.EnterpriseCluster("example", {
name: "example-redisenterprise",
resourceGroupName: example.name,
location: example.location,
skuName: "Enterprise_E20-4",
});
const example1 = new azure.redis.EnterpriseCluster("example1", {
name: "example-redisenterprise1",
resourceGroupName: example.name,
location: example.location,
skuName: "Enterprise_E20-4",
});
const exampleEnterpriseDatabase = new azure.redis.EnterpriseDatabase("example", {
name: "default",
resourceGroupName: example.name,
clusterId: exampleEnterpriseCluster.id,
clientProtocol: "Encrypted",
clusteringPolicy: "EnterpriseCluster",
evictionPolicy: "NoEviction",
port: 10000,
linkedDatabaseIds: [
pulumi.interpolate`${exampleEnterpriseCluster.id}/databases/default`,
pulumi.interpolate`${example1.id}/databases/default`,
],
linkedDatabaseGroupNickname: "tftestGeoGroup",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-redisenterprise",
location="West Europe")
example_enterprise_cluster = azure.redis.EnterpriseCluster("example",
name="example-redisenterprise",
resource_group_name=example.name,
location=example.location,
sku_name="Enterprise_E20-4")
example1 = azure.redis.EnterpriseCluster("example1",
name="example-redisenterprise1",
resource_group_name=example.name,
location=example.location,
sku_name="Enterprise_E20-4")
example_enterprise_database = azure.redis.EnterpriseDatabase("example",
name="default",
resource_group_name=example.name,
cluster_id=example_enterprise_cluster.id,
client_protocol="Encrypted",
clustering_policy="EnterpriseCluster",
eviction_policy="NoEviction",
port=10000,
linked_database_ids=[
example_enterprise_cluster.id.apply(lambda id: f"{id}/databases/default"),
example1.id.apply(lambda id: f"{id}/databases/default"),
],
linked_database_group_nickname="tftestGeoGroup")
package main
import (
"fmt"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/redis"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-redisenterprise"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleEnterpriseCluster, err := redis.NewEnterpriseCluster(ctx, "example", &redis.EnterpriseClusterArgs{
Name: pulumi.String("example-redisenterprise"),
ResourceGroupName: example.Name,
Location: example.Location,
SkuName: pulumi.String("Enterprise_E20-4"),
})
if err != nil {
return err
}
example1, err := redis.NewEnterpriseCluster(ctx, "example1", &redis.EnterpriseClusterArgs{
Name: pulumi.String("example-redisenterprise1"),
ResourceGroupName: example.Name,
Location: example.Location,
SkuName: pulumi.String("Enterprise_E20-4"),
})
if err != nil {
return err
}
_, err = redis.NewEnterpriseDatabase(ctx, "example", &redis.EnterpriseDatabaseArgs{
Name: pulumi.String("default"),
ResourceGroupName: example.Name,
ClusterId: exampleEnterpriseCluster.ID(),
ClientProtocol: pulumi.String("Encrypted"),
ClusteringPolicy: pulumi.String("EnterpriseCluster"),
EvictionPolicy: pulumi.String("NoEviction"),
Port: pulumi.Int(10000),
LinkedDatabaseIds: pulumi.StringArray{
exampleEnterpriseCluster.ID().ApplyT(func(id string) (string, error) {
return fmt.Sprintf("%v/databases/default", id), nil
}).(pulumi.StringOutput),
example1.ID().ApplyT(func(id string) (string, error) {
return fmt.Sprintf("%v/databases/default", id), nil
}).(pulumi.StringOutput),
},
LinkedDatabaseGroupNickname: pulumi.String("tftestGeoGroup"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-redisenterprise",
Location = "West Europe",
});
var exampleEnterpriseCluster = new Azure.Redis.EnterpriseCluster("example", new()
{
Name = "example-redisenterprise",
ResourceGroupName = example.Name,
Location = example.Location,
SkuName = "Enterprise_E20-4",
});
var example1 = new Azure.Redis.EnterpriseCluster("example1", new()
{
Name = "example-redisenterprise1",
ResourceGroupName = example.Name,
Location = example.Location,
SkuName = "Enterprise_E20-4",
});
var exampleEnterpriseDatabase = new Azure.Redis.EnterpriseDatabase("example", new()
{
Name = "default",
ResourceGroupName = example.Name,
ClusterId = exampleEnterpriseCluster.Id,
ClientProtocol = "Encrypted",
ClusteringPolicy = "EnterpriseCluster",
EvictionPolicy = "NoEviction",
Port = 10000,
LinkedDatabaseIds = new[]
{
exampleEnterpriseCluster.Id.Apply(id => $"{id}/databases/default"),
example1.Id.Apply(id => $"{id}/databases/default"),
},
LinkedDatabaseGroupNickname = "tftestGeoGroup",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.redis.EnterpriseCluster;
import com.pulumi.azure.redis.EnterpriseClusterArgs;
import com.pulumi.azure.redis.EnterpriseDatabase;
import com.pulumi.azure.redis.EnterpriseDatabaseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-redisenterprise")
.location("West Europe")
.build());
var exampleEnterpriseCluster = new EnterpriseCluster("exampleEnterpriseCluster", EnterpriseClusterArgs.builder()
.name("example-redisenterprise")
.resourceGroupName(example.name())
.location(example.location())
.skuName("Enterprise_E20-4")
.build());
var example1 = new EnterpriseCluster("example1", EnterpriseClusterArgs.builder()
.name("example-redisenterprise1")
.resourceGroupName(example.name())
.location(example.location())
.skuName("Enterprise_E20-4")
.build());
var exampleEnterpriseDatabase = new EnterpriseDatabase("exampleEnterpriseDatabase", EnterpriseDatabaseArgs.builder()
.name("default")
.resourceGroupName(example.name())
.clusterId(exampleEnterpriseCluster.id())
.clientProtocol("Encrypted")
.clusteringPolicy("EnterpriseCluster")
.evictionPolicy("NoEviction")
.port(10000)
.linkedDatabaseIds(
exampleEnterpriseCluster.id().applyValue(id -> String.format("%s/databases/default", id)),
example1.id().applyValue(id -> String.format("%s/databases/default", id)))
.linkedDatabaseGroupNickname("tftestGeoGroup")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-redisenterprise
location: West Europe
exampleEnterpriseCluster:
type: azure:redis:EnterpriseCluster
name: example
properties:
name: example-redisenterprise
resourceGroupName: ${example.name}
location: ${example.location}
skuName: Enterprise_E20-4
example1:
type: azure:redis:EnterpriseCluster
properties:
name: example-redisenterprise1
resourceGroupName: ${example.name}
location: ${example.location}
skuName: Enterprise_E20-4
exampleEnterpriseDatabase:
type: azure:redis:EnterpriseDatabase
name: example
properties:
name: default
resourceGroupName: ${example.name}
clusterId: ${exampleEnterpriseCluster.id}
clientProtocol: Encrypted
clusteringPolicy: EnterpriseCluster
evictionPolicy: NoEviction
port: 10000
linkedDatabaseIds:
- ${exampleEnterpriseCluster.id}/databases/default
- ${example1.id}/databases/default
linkedDatabaseGroupNickname: tftestGeoGroup
Create EnterpriseDatabase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EnterpriseDatabase(name: string, args: EnterpriseDatabaseArgs, opts?: CustomResourceOptions);
@overload
def EnterpriseDatabase(resource_name: str,
args: EnterpriseDatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EnterpriseDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_id: Optional[str] = None,
client_protocol: Optional[str] = None,
clustering_policy: Optional[str] = None,
eviction_policy: Optional[str] = None,
linked_database_group_nickname: Optional[str] = None,
linked_database_ids: Optional[Sequence[str]] = None,
modules: Optional[Sequence[EnterpriseDatabaseModuleArgs]] = None,
name: Optional[str] = None,
port: Optional[int] = None,
resource_group_name: Optional[str] = None)
func NewEnterpriseDatabase(ctx *Context, name string, args EnterpriseDatabaseArgs, opts ...ResourceOption) (*EnterpriseDatabase, error)
public EnterpriseDatabase(string name, EnterpriseDatabaseArgs args, CustomResourceOptions? opts = null)
public EnterpriseDatabase(String name, EnterpriseDatabaseArgs args)
public EnterpriseDatabase(String name, EnterpriseDatabaseArgs args, CustomResourceOptions options)
type: azure:redis:EnterpriseDatabase
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 EnterpriseDatabaseArgs
- 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 EnterpriseDatabaseArgs
- 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 EnterpriseDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnterpriseDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EnterpriseDatabaseArgs
- 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 enterpriseDatabaseResource = new Azure.Redis.EnterpriseDatabase("enterpriseDatabaseResource", new()
{
ClusterId = "string",
ClientProtocol = "string",
ClusteringPolicy = "string",
EvictionPolicy = "string",
LinkedDatabaseGroupNickname = "string",
LinkedDatabaseIds = new[]
{
"string",
},
Modules = new[]
{
new Azure.Redis.Inputs.EnterpriseDatabaseModuleArgs
{
Name = "string",
Args = "string",
Version = "string",
},
},
Name = "string",
Port = 0,
});
example, err := redis.NewEnterpriseDatabase(ctx, "enterpriseDatabaseResource", &redis.EnterpriseDatabaseArgs{
ClusterId: pulumi.String("string"),
ClientProtocol: pulumi.String("string"),
ClusteringPolicy: pulumi.String("string"),
EvictionPolicy: pulumi.String("string"),
LinkedDatabaseGroupNickname: pulumi.String("string"),
LinkedDatabaseIds: pulumi.StringArray{
pulumi.String("string"),
},
Modules: redis.EnterpriseDatabaseModuleArray{
&redis.EnterpriseDatabaseModuleArgs{
Name: pulumi.String("string"),
Args: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Port: pulumi.Int(0),
})
var enterpriseDatabaseResource = new EnterpriseDatabase("enterpriseDatabaseResource", EnterpriseDatabaseArgs.builder()
.clusterId("string")
.clientProtocol("string")
.clusteringPolicy("string")
.evictionPolicy("string")
.linkedDatabaseGroupNickname("string")
.linkedDatabaseIds("string")
.modules(EnterpriseDatabaseModuleArgs.builder()
.name("string")
.args("string")
.version("string")
.build())
.name("string")
.port(0)
.build());
enterprise_database_resource = azure.redis.EnterpriseDatabase("enterpriseDatabaseResource",
cluster_id="string",
client_protocol="string",
clustering_policy="string",
eviction_policy="string",
linked_database_group_nickname="string",
linked_database_ids=["string"],
modules=[azure.redis.EnterpriseDatabaseModuleArgs(
name="string",
args="string",
version="string",
)],
name="string",
port=0)
const enterpriseDatabaseResource = new azure.redis.EnterpriseDatabase("enterpriseDatabaseResource", {
clusterId: "string",
clientProtocol: "string",
clusteringPolicy: "string",
evictionPolicy: "string",
linkedDatabaseGroupNickname: "string",
linkedDatabaseIds: ["string"],
modules: [{
name: "string",
args: "string",
version: "string",
}],
name: "string",
port: 0,
});
type: azure:redis:EnterpriseDatabase
properties:
clientProtocol: string
clusterId: string
clusteringPolicy: string
evictionPolicy: string
linkedDatabaseGroupNickname: string
linkedDatabaseIds:
- string
modules:
- args: string
name: string
version: string
name: string
port: 0
EnterpriseDatabase 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 EnterpriseDatabase resource accepts the following input properties:
- Cluster
Id string - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- Client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - Clustering
Policy string - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - Eviction
Policy string - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - Linked
Database stringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- Linked
Database List<string>Ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- Modules
List<Enterprise
Database Module> A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- Name string
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - Port int
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - Resource
Group stringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- Cluster
Id string - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- Client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - Clustering
Policy string - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - Eviction
Policy string - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - Linked
Database stringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- Linked
Database []stringIds A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- Modules
[]Enterprise
Database Module Args A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- Name string
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - Port int
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - Resource
Group stringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- cluster
Id String - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- client
Protocol String - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - clustering
Policy String - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - eviction
Policy String - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - linked
Database StringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- linked
Database List<String>Ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- modules
List<Enterprise
Database Module> A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- name String
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - port Integer
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - resource
Group StringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- cluster
Id string - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - clustering
Policy string - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - eviction
Policy string - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - linked
Database stringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- linked
Database string[]Ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- modules
Enterprise
Database Module[] A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- name string
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - port number
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - resource
Group stringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- cluster_
id str - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- client_
protocol str - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - clustering_
policy str - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - eviction_
policy str - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - linked_
database_ strgroup_ nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- linked_
database_ Sequence[str]ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- modules
Sequence[Enterprise
Database Module Args] A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- name str
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - port int
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - resource_
group_ strname - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- cluster
Id String - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- client
Protocol String - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - clustering
Policy String - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - eviction
Policy String - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - linked
Database StringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- linked
Database List<String>Ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- modules List<Property Map>
A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- name String
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - port Number
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - resource
Group StringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the EnterpriseDatabase resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Primary
Access stringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- Secondary
Access stringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Primary
Access stringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- Secondary
Access stringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
- id String
- The provider-assigned unique ID for this managed resource.
- primary
Access StringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- secondary
Access StringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
- id string
- The provider-assigned unique ID for this managed resource.
- primary
Access stringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- secondary
Access stringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
- id str
- The provider-assigned unique ID for this managed resource.
- primary_
access_ strkey - The Primary Access Key for the Redis Enterprise Database Instance.
- secondary_
access_ strkey - The Secondary Access Key for the Redis Enterprise Database Instance.
- id String
- The provider-assigned unique ID for this managed resource.
- primary
Access StringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- secondary
Access StringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
Look up Existing EnterpriseDatabase Resource
Get an existing EnterpriseDatabase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EnterpriseDatabaseState, opts?: CustomResourceOptions): EnterpriseDatabase
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
client_protocol: Optional[str] = None,
cluster_id: Optional[str] = None,
clustering_policy: Optional[str] = None,
eviction_policy: Optional[str] = None,
linked_database_group_nickname: Optional[str] = None,
linked_database_ids: Optional[Sequence[str]] = None,
modules: Optional[Sequence[EnterpriseDatabaseModuleArgs]] = None,
name: Optional[str] = None,
port: Optional[int] = None,
primary_access_key: Optional[str] = None,
resource_group_name: Optional[str] = None,
secondary_access_key: Optional[str] = None) -> EnterpriseDatabase
func GetEnterpriseDatabase(ctx *Context, name string, id IDInput, state *EnterpriseDatabaseState, opts ...ResourceOption) (*EnterpriseDatabase, error)
public static EnterpriseDatabase Get(string name, Input<string> id, EnterpriseDatabaseState? state, CustomResourceOptions? opts = null)
public static EnterpriseDatabase get(String name, Output<String> id, EnterpriseDatabaseState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - Cluster
Id string - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- Clustering
Policy string - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - Eviction
Policy string - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - Linked
Database stringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- Linked
Database List<string>Ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- Modules
List<Enterprise
Database Module> A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- Name string
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - Port int
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - Primary
Access stringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- Resource
Group stringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- Secondary
Access stringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
- Client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - Cluster
Id string - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- Clustering
Policy string - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - Eviction
Policy string - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - Linked
Database stringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- Linked
Database []stringIds A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- Modules
[]Enterprise
Database Module Args A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- Name string
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - Port int
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - Primary
Access stringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- Resource
Group stringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- Secondary
Access stringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
- client
Protocol String - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - cluster
Id String - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- clustering
Policy String - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - eviction
Policy String - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - linked
Database StringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- linked
Database List<String>Ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- modules
List<Enterprise
Database Module> A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- name String
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - port Integer
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - primary
Access StringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- resource
Group StringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- secondary
Access StringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
- client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - cluster
Id string - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- clustering
Policy string - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - eviction
Policy string - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - linked
Database stringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- linked
Database string[]Ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- modules
Enterprise
Database Module[] A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- name string
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - port number
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - primary
Access stringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- resource
Group stringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- secondary
Access stringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
- client_
protocol str - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - cluster_
id str - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- clustering_
policy str - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - eviction_
policy str - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - linked_
database_ strgroup_ nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- linked_
database_ Sequence[str]ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- modules
Sequence[Enterprise
Database Module Args] A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- name str
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - port int
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - primary_
access_ strkey - The Primary Access Key for the Redis Enterprise Database Instance.
- resource_
group_ strname - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- secondary_
access_ strkey - The Secondary Access Key for the Redis Enterprise Database Instance.
- client
Protocol String - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Possible values are
Encrypted
andPlaintext
. Defaults toEncrypted
. Changing this forces a new Redis Enterprise Database to be created. - cluster
Id String - The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.
- clustering
Policy String - Clustering policy Specified at create time. Possible values are
EnterpriseCluster
andOSSCluster
. Defaults toOSSCluster
. Changing this forces a new Redis Enterprise Database to be created. - eviction
Policy String - Redis eviction policy possible values are
AllKeysLFU
,AllKeysLRU
,AllKeysRandom
,VolatileLRU
,VolatileLFU
,VolatileTTL
,VolatileRandom
andNoEviction
. Changing this forces a new Redis Enterprise Database to be created. Defaults toVolatileLRU
. - linked
Database StringGroup Nickname - Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.
- linked
Database List<String>Ids A list of database resources to link with this database with a maximum of 5.
NOTE: Only the newly created databases can be added to an existing geo-replication group. Existing regular databases or recreated databases cannot be added to the existing geo-replication group. Any linked database be removed from the list will be forcefully unlinked.The only recommended operation is to delete after force-unlink and the recommended scenario of force-unlink is region outrage. The database cannot be linked again after force-unlink.
- modules List<Property Map>
A
module
block as defined below. Changing this forces a new resource to be created.NOTE: Only
RediSearch
andRedisJSON
modules are allowed with geo-replication- name String
- The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is
default
. Defaults todefault
. Changing this forces a new Redis Enterprise Database to be created. - port Number
- TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to
10000
. - primary
Access StringKey - The Primary Access Key for the Redis Enterprise Database Instance.
- resource
Group StringName - The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.
- secondary
Access StringKey - The Secondary Access Key for the Redis Enterprise Database Instance.
Supporting Types
EnterpriseDatabaseModule, EnterpriseDatabaseModuleArgs
- Name string
- The name which should be used for this module. Possible values are
RedisBloom
,RedisTimeSeries
,RediSearch
andRedisJSON
. Changing this forces a new Redis Enterprise Database to be created. - Args string
- Configuration options for the module (e.g.
ERROR_RATE 0.00 INITIAL_SIZE 400
). Changing this forces a new resource to be created. Defaults to""
. - Version string
- Name string
- The name which should be used for this module. Possible values are
RedisBloom
,RedisTimeSeries
,RediSearch
andRedisJSON
. Changing this forces a new Redis Enterprise Database to be created. - Args string
- Configuration options for the module (e.g.
ERROR_RATE 0.00 INITIAL_SIZE 400
). Changing this forces a new resource to be created. Defaults to""
. - Version string
- name String
- The name which should be used for this module. Possible values are
RedisBloom
,RedisTimeSeries
,RediSearch
andRedisJSON
. Changing this forces a new Redis Enterprise Database to be created. - args String
- Configuration options for the module (e.g.
ERROR_RATE 0.00 INITIAL_SIZE 400
). Changing this forces a new resource to be created. Defaults to""
. - version String
- name string
- The name which should be used for this module. Possible values are
RedisBloom
,RedisTimeSeries
,RediSearch
andRedisJSON
. Changing this forces a new Redis Enterprise Database to be created. - args string
- Configuration options for the module (e.g.
ERROR_RATE 0.00 INITIAL_SIZE 400
). Changing this forces a new resource to be created. Defaults to""
. - version string
- name str
- The name which should be used for this module. Possible values are
RedisBloom
,RedisTimeSeries
,RediSearch
andRedisJSON
. Changing this forces a new Redis Enterprise Database to be created. - args str
- Configuration options for the module (e.g.
ERROR_RATE 0.00 INITIAL_SIZE 400
). Changing this forces a new resource to be created. Defaults to""
. - version str
- name String
- The name which should be used for this module. Possible values are
RedisBloom
,RedisTimeSeries
,RediSearch
andRedisJSON
. Changing this forces a new Redis Enterprise Database to be created. - args String
- Configuration options for the module (e.g.
ERROR_RATE 0.00 INITIAL_SIZE 400
). Changing this forces a new resource to be created. Defaults to""
. - version String
Import
Redis Enterprise Databases can be imported using the resource id
, e.g.
$ pulumi import azure:redis/enterpriseDatabase:EnterpriseDatabase example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Cache/redisEnterprise/cluster1/databases/database1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.