rediscloud.SubscriptionDatabase
Explore with Pulumi AI
Creates a Database within a specified Subscription in your Redis Enterprise Cloud Account.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rediscloud = Pulumi.Rediscloud;
using Rediscloud = RedisLabs.Rediscloud;
return await Deployment.RunAsync(() =>
{
var card = Rediscloud.GetPaymentMethod.Invoke(new()
{
CardType = "Visa",
});
var subscription_resource = new Rediscloud.Subscription("subscription-resource", new()
{
PaymentMethod = "credit-card",
PaymentMethodId = card.Apply(getPaymentMethodResult => getPaymentMethodResult.Id),
MemoryStorage = "ram",
CloudProvider = new Rediscloud.Inputs.SubscriptionCloudProviderArgs
{
Provider = data.Rediscloud_cloud_account.Account.Provider_type,
Regions = new[]
{
new Rediscloud.Inputs.SubscriptionCloudProviderRegionArgs
{
Region = "eu-west-1",
MultipleAvailabilityZones = true,
NetworkingDeploymentCidr = "10.0.0.0/24",
PreferredAvailabilityZones = new[]
{
"euw1-az1, euw1-az2, euw1-az3",
},
},
},
},
CreationPlan = new Rediscloud.Inputs.SubscriptionCreationPlanArgs
{
MemoryLimitInGb = 15,
Quantity = 1,
Replication = true,
ThroughputMeasurementBy = "operations-per-second",
ThroughputMeasurementValue = 20000,
Modules = new[]
{
"RedisJSON",
},
},
});
// The primary database to provision
var database_resource = new Rediscloud.SubscriptionDatabase("database-resource", new()
{
SubscriptionId = subscription_resource.Id,
MemoryLimitInGb = 15,
DataPersistence = "aof-every-write",
ThroughputMeasurementBy = "operations-per-second",
ThroughputMeasurementValue = 20000,
Replication = true,
Modules = new[]
{
new Rediscloud.Inputs.SubscriptionDatabaseModuleArgs
{
Name = "RedisJSON",
},
},
Alerts = new[]
{
new Rediscloud.Inputs.SubscriptionDatabaseAlertArgs
{
Name = "dataset-size",
Value = 40,
},
},
}, new CustomResourceOptions
{
DependsOn = new[]
{
subscription_resource,
},
});
});
package main
import (
"github.com/RedisLabs/pulumi-rediscloud/sdk/go/rediscloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
card, err := rediscloud.GetPaymentMethod(ctx, &rediscloud.GetPaymentMethodArgs{
CardType: pulumi.StringRef("Visa"),
}, nil)
if err != nil {
return err
}
_, err = rediscloud.NewSubscription(ctx, "subscription-resource", &rediscloud.SubscriptionArgs{
PaymentMethod: pulumi.String("credit-card"),
PaymentMethodId: *pulumi.String(card.Id),
MemoryStorage: pulumi.String("ram"),
CloudProvider: &rediscloud.SubscriptionCloudProviderArgs{
Provider: pulumi.Any(data.Rediscloud_cloud_account.Account.Provider_type),
Regions: rediscloud.SubscriptionCloudProviderRegionArray{
&rediscloud.SubscriptionCloudProviderRegionArgs{
Region: pulumi.String("eu-west-1"),
MultipleAvailabilityZones: pulumi.Bool(true),
NetworkingDeploymentCidr: pulumi.String("10.0.0.0/24"),
PreferredAvailabilityZones: pulumi.StringArray{
pulumi.String("euw1-az1, euw1-az2, euw1-az3"),
},
},
},
},
CreationPlan: &rediscloud.SubscriptionCreationPlanArgs{
MemoryLimitInGb: pulumi.Float64(15),
Quantity: pulumi.Int(1),
Replication: pulumi.Bool(true),
ThroughputMeasurementBy: pulumi.String("operations-per-second"),
ThroughputMeasurementValue: pulumi.Int(20000),
Modules: pulumi.StringArray{
pulumi.String("RedisJSON"),
},
},
})
if err != nil {
return err
}
_, err = rediscloud.NewSubscriptionDatabase(ctx, "database-resource", &rediscloud.SubscriptionDatabaseArgs{
SubscriptionId: subscription_resource.ID(),
MemoryLimitInGb: pulumi.Float64(15),
DataPersistence: pulumi.String("aof-every-write"),
ThroughputMeasurementBy: pulumi.String("operations-per-second"),
ThroughputMeasurementValue: pulumi.Int(20000),
Replication: pulumi.Bool(true),
Modules: rediscloud.SubscriptionDatabaseModuleArray{
&rediscloud.SubscriptionDatabaseModuleArgs{
Name: pulumi.String("RedisJSON"),
},
},
Alerts: rediscloud.SubscriptionDatabaseAlertArray{
&rediscloud.SubscriptionDatabaseAlertArgs{
Name: pulumi.String("dataset-size"),
Value: pulumi.Int(40),
},
},
}, pulumi.DependsOn([]pulumi.Resource{
subscription_resource,
}))
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.rediscloud.RediscloudFunctions;
import com.pulumi.rediscloud.inputs.GetPaymentMethodArgs;
import com.pulumi.rediscloud.Subscription;
import com.pulumi.rediscloud.SubscriptionArgs;
import com.pulumi.rediscloud.inputs.SubscriptionCloudProviderArgs;
import com.pulumi.rediscloud.inputs.SubscriptionCreationPlanArgs;
import com.pulumi.rediscloud.SubscriptionDatabase;
import com.pulumi.rediscloud.SubscriptionDatabaseArgs;
import com.pulumi.rediscloud.inputs.SubscriptionDatabaseModuleArgs;
import com.pulumi.rediscloud.inputs.SubscriptionDatabaseAlertArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
final var card = RediscloudFunctions.getPaymentMethod(GetPaymentMethodArgs.builder()
.cardType("Visa")
.build());
var subscription_resource = new Subscription("subscription-resource", SubscriptionArgs.builder()
.paymentMethod("credit-card")
.paymentMethodId(card.applyValue(getPaymentMethodResult -> getPaymentMethodResult.id()))
.memoryStorage("ram")
.cloudProvider(SubscriptionCloudProviderArgs.builder()
.provider(data.rediscloud_cloud_account().account().provider_type())
.regions(SubscriptionCloudProviderRegionArgs.builder()
.region("eu-west-1")
.multipleAvailabilityZones(true)
.networkingDeploymentCidr("10.0.0.0/24")
.preferredAvailabilityZones("euw1-az1, euw1-az2, euw1-az3")
.build())
.build())
.creationPlan(SubscriptionCreationPlanArgs.builder()
.memoryLimitInGb(15)
.quantity(1)
.replication(true)
.throughputMeasurementBy("operations-per-second")
.throughputMeasurementValue(20000)
.modules("RedisJSON")
.build())
.build());
var database_resource = new SubscriptionDatabase("database-resource", SubscriptionDatabaseArgs.builder()
.subscriptionId(subscription_resource.id())
.memoryLimitInGb(15)
.dataPersistence("aof-every-write")
.throughputMeasurementBy("operations-per-second")
.throughputMeasurementValue(20000)
.replication(true)
.modules(SubscriptionDatabaseModuleArgs.builder()
.name("RedisJSON")
.build())
.alerts(SubscriptionDatabaseAlertArgs.builder()
.name("dataset-size")
.value(40)
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(subscription_resource)
.build());
}
}
import pulumi
import pulumi_rediscloud as rediscloud
card = rediscloud.get_payment_method(card_type="Visa")
subscription_resource = rediscloud.Subscription("subscription-resource",
payment_method="credit-card",
payment_method_id=card.id,
memory_storage="ram",
cloud_provider=rediscloud.SubscriptionCloudProviderArgs(
provider=data["rediscloud_cloud_account"]["account"]["provider_type"],
regions=[rediscloud.SubscriptionCloudProviderRegionArgs(
region="eu-west-1",
multiple_availability_zones=True,
networking_deployment_cidr="10.0.0.0/24",
preferred_availability_zones=["euw1-az1, euw1-az2, euw1-az3"],
)],
),
creation_plan=rediscloud.SubscriptionCreationPlanArgs(
memory_limit_in_gb=15,
quantity=1,
replication=True,
throughput_measurement_by="operations-per-second",
throughput_measurement_value=20000,
modules=["RedisJSON"],
))
# The primary database to provision
database_resource = rediscloud.SubscriptionDatabase("database-resource",
subscription_id=subscription_resource.id,
memory_limit_in_gb=15,
data_persistence="aof-every-write",
throughput_measurement_by="operations-per-second",
throughput_measurement_value=20000,
replication=True,
modules=[rediscloud.SubscriptionDatabaseModuleArgs(
name="RedisJSON",
)],
alerts=[rediscloud.SubscriptionDatabaseAlertArgs(
name="dataset-size",
value=40,
)],
opts=pulumi.ResourceOptions(depends_on=[subscription_resource]))
import * as pulumi from "@pulumi/pulumi";
import * as rediscloud from "@pulumi/rediscloud";
import * as rediscloud from "@rediscloud/pulumi-rediscloud";
const card = rediscloud.getPaymentMethod({
cardType: "Visa",
});
const subscription_resource = new rediscloud.Subscription("subscription-resource", {
paymentMethod: "credit-card",
paymentMethodId: card.then(card => card.id),
memoryStorage: "ram",
cloudProvider: {
provider: data.rediscloud_cloud_account.account.provider_type,
regions: [{
region: "eu-west-1",
multipleAvailabilityZones: true,
networkingDeploymentCidr: "10.0.0.0/24",
preferredAvailabilityZones: ["euw1-az1, euw1-az2, euw1-az3"],
}],
},
creationPlan: {
memoryLimitInGb: 15,
quantity: 1,
replication: true,
throughputMeasurementBy: "operations-per-second",
throughputMeasurementValue: 20000,
modules: ["RedisJSON"],
},
});
// The primary database to provision
const database_resource = new rediscloud.SubscriptionDatabase("database-resource", {
subscriptionId: subscription_resource.id,
memoryLimitInGb: 15,
dataPersistence: "aof-every-write",
throughputMeasurementBy: "operations-per-second",
throughputMeasurementValue: 20000,
replication: true,
modules: [{
name: "RedisJSON",
}],
alerts: [{
name: "dataset-size",
value: 40,
}],
}, {
dependsOn: [subscription_resource],
});
resources:
subscription-resource:
type: rediscloud:Subscription
properties:
paymentMethod: credit-card
paymentMethodId: ${card.id}
memoryStorage: ram
cloudProvider:
provider: ${data.rediscloud_cloud_account.account.provider_type}
regions:
- region: eu-west-1
multipleAvailabilityZones: true
networkingDeploymentCidr: 10.0.0.0/24
preferredAvailabilityZones:
- euw1-az1, euw1-az2, euw1-az3
creationPlan:
memoryLimitInGb: 15
quantity: 1
replication: true
throughputMeasurementBy: operations-per-second
throughputMeasurementValue: 20000
modules:
- RedisJSON
# The primary database to provision
database-resource:
type: rediscloud:SubscriptionDatabase
properties:
subscriptionId: ${["subscription-resource"].id}
memoryLimitInGb: 15
dataPersistence: aof-every-write
throughputMeasurementBy: operations-per-second
throughputMeasurementValue: 20000
replication: true
modules:
- name: RedisJSON
alerts:
- name: dataset-size
value: 40
options:
dependson:
- ${["subscription-resource"]}
variables:
card:
fn::invoke:
Function: rediscloud:getPaymentMethod
Arguments:
cardType: Visa
Create SubscriptionDatabase Resource
new SubscriptionDatabase(name: string, args: SubscriptionDatabaseArgs, opts?: CustomResourceOptions);
@overload
def SubscriptionDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
alerts: Optional[Sequence[SubscriptionDatabaseAlertArgs]] = None,
average_item_size_in_bytes: Optional[int] = None,
client_ssl_certificate: Optional[str] = None,
data_eviction: Optional[str] = None,
data_persistence: Optional[str] = None,
enable_tls: Optional[bool] = None,
external_endpoint_for_oss_cluster_api: Optional[bool] = None,
hashing_policies: Optional[Sequence[str]] = None,
memory_limit_in_gb: Optional[float] = None,
modules: Optional[Sequence[SubscriptionDatabaseModuleArgs]] = None,
name: Optional[str] = None,
password: Optional[str] = None,
periodic_backup_path: Optional[str] = None,
port: Optional[int] = None,
protocol: Optional[str] = None,
remote_backup: Optional[SubscriptionDatabaseRemoteBackupArgs] = None,
replica_ofs: Optional[Sequence[str]] = None,
replication: Optional[bool] = None,
source_ips: Optional[Sequence[str]] = None,
subscription_id: Optional[str] = None,
support_oss_cluster_api: Optional[bool] = None,
throughput_measurement_by: Optional[str] = None,
throughput_measurement_value: Optional[int] = None)
@overload
def SubscriptionDatabase(resource_name: str,
args: SubscriptionDatabaseArgs,
opts: Optional[ResourceOptions] = None)
func NewSubscriptionDatabase(ctx *Context, name string, args SubscriptionDatabaseArgs, opts ...ResourceOption) (*SubscriptionDatabase, error)
public SubscriptionDatabase(string name, SubscriptionDatabaseArgs args, CustomResourceOptions? opts = null)
public SubscriptionDatabase(String name, SubscriptionDatabaseArgs args)
public SubscriptionDatabase(String name, SubscriptionDatabaseArgs args, CustomResourceOptions options)
type: rediscloud:SubscriptionDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriptionDatabaseArgs
- 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 SubscriptionDatabaseArgs
- 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 SubscriptionDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriptionDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubscriptionDatabaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
SubscriptionDatabase 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 SubscriptionDatabase resource accepts the following input properties:
- Memory
Limit doubleIn Gb Maximum memory usage for this specific database
- Subscription
Id string The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- Throughput
Measurement stringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- Throughput
Measurement intValue Throughput value (as applies to selected measurement method)
- Alerts
List<Redis
Labs. Rediscloud. Inputs. Subscription Database Alert> A block defining Redis database alert, documented below, can be specified multiple times
- Average
Item intSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- Client
Ssl stringCertificate SSL certificate to authenticate user connections
- Data
Eviction string The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- Data
Persistence string Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- Enable
Tls bool Use TLS for authentication. Default: ‘false’
- External
Endpoint boolFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- Hashing
Policies List<string> List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- Modules
List<Redis
Labs. Rediscloud. Inputs. Subscription Database Module> A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- Name string
A meaningful name to identify the database
- Password string
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- Periodic
Backup stringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- Port int
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- Protocol string
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- Remote
Backup RedisLabs. Rediscloud. Inputs. Subscription Database Remote Backup Specifies the backup options for the database, documented below
- Replica
Ofs List<string> Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- Replication bool
Databases replication. Default: ‘true’
- Source
Ips List<string> List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- Support
Oss boolCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- Memory
Limit float64In Gb Maximum memory usage for this specific database
- Subscription
Id string The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- Throughput
Measurement stringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- Throughput
Measurement intValue Throughput value (as applies to selected measurement method)
- Alerts
[]Subscription
Database Alert Args A block defining Redis database alert, documented below, can be specified multiple times
- Average
Item intSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- Client
Ssl stringCertificate SSL certificate to authenticate user connections
- Data
Eviction string The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- Data
Persistence string Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- Enable
Tls bool Use TLS for authentication. Default: ‘false’
- External
Endpoint boolFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- Hashing
Policies []string List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- Modules
[]Subscription
Database Module Args A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- Name string
A meaningful name to identify the database
- Password string
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- Periodic
Backup stringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- Port int
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- Protocol string
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- Remote
Backup SubscriptionDatabase Remote Backup Args Specifies the backup options for the database, documented below
- Replica
Ofs []string Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- Replication bool
Databases replication. Default: ‘true’
- Source
Ips []string List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- Support
Oss boolCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- memory
Limit DoubleIn Gb Maximum memory usage for this specific database
- subscription
Id String The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- throughput
Measurement StringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- throughput
Measurement IntegerValue Throughput value (as applies to selected measurement method)
- alerts
List<Subscription
Database Alert> A block defining Redis database alert, documented below, can be specified multiple times
- average
Item IntegerSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- client
Ssl StringCertificate SSL certificate to authenticate user connections
- data
Eviction String The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- data
Persistence String Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- enable
Tls Boolean Use TLS for authentication. Default: ‘false’
- external
Endpoint BooleanFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- hashing
Policies List<String> List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- modules
List<Subscription
Database Module> A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- name String
A meaningful name to identify the database
- password String
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- periodic
Backup StringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- port Integer
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- protocol String
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- remote
Backup SubscriptionDatabase Remote Backup Specifies the backup options for the database, documented below
- replica
Ofs List<String> Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- replication Boolean
Databases replication. Default: ‘true’
- source
Ips List<String> List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- support
Oss BooleanCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- memory
Limit numberIn Gb Maximum memory usage for this specific database
- subscription
Id string The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- throughput
Measurement stringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- throughput
Measurement numberValue Throughput value (as applies to selected measurement method)
- alerts
Subscription
Database Alert[] A block defining Redis database alert, documented below, can be specified multiple times
- average
Item numberSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- client
Ssl stringCertificate SSL certificate to authenticate user connections
- data
Eviction string The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- data
Persistence string Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- enable
Tls boolean Use TLS for authentication. Default: ‘false’
- external
Endpoint booleanFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- hashing
Policies string[] List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- modules
Subscription
Database Module[] A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- name string
A meaningful name to identify the database
- password string
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- periodic
Backup stringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- port number
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- protocol string
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- remote
Backup SubscriptionDatabase Remote Backup Specifies the backup options for the database, documented below
- replica
Ofs string[] Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- replication boolean
Databases replication. Default: ‘true’
- source
Ips string[] List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- support
Oss booleanCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- memory_
limit_ floatin_ gb Maximum memory usage for this specific database
- subscription_
id str The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- throughput_
measurement_ strby Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- throughput_
measurement_ intvalue Throughput value (as applies to selected measurement method)
- alerts
Sequence[Subscription
Database Alert Args] A block defining Redis database alert, documented below, can be specified multiple times
- average_
item_ intsize_ in_ bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- client_
ssl_ strcertificate SSL certificate to authenticate user connections
- data_
eviction str The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- data_
persistence str Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- enable_
tls bool Use TLS for authentication. Default: ‘false’
- external_
endpoint_ boolfor_ oss_ cluster_ api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- hashing_
policies Sequence[str] List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- modules
Sequence[Subscription
Database Module Args] A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- name str
A meaningful name to identify the database
- password str
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- periodic_
backup_ strpath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- port int
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- protocol str
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- remote_
backup SubscriptionDatabase Remote Backup Args Specifies the backup options for the database, documented below
- replica_
ofs Sequence[str] Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- replication bool
Databases replication. Default: ‘true’
- source_
ips Sequence[str] List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- support_
oss_ boolcluster_ api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- memory
Limit NumberIn Gb Maximum memory usage for this specific database
- subscription
Id String The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- throughput
Measurement StringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- throughput
Measurement NumberValue Throughput value (as applies to selected measurement method)
- alerts List<Property Map>
A block defining Redis database alert, documented below, can be specified multiple times
- average
Item NumberSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- client
Ssl StringCertificate SSL certificate to authenticate user connections
- data
Eviction String The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- data
Persistence String Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- enable
Tls Boolean Use TLS for authentication. Default: ‘false’
- external
Endpoint BooleanFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- hashing
Policies List<String> List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- modules List<Property Map>
A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- name String
A meaningful name to identify the database
- password String
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- periodic
Backup StringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- port Number
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- protocol String
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- remote
Backup Property Map Specifies the backup options for the database, documented below
- replica
Ofs List<String> Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- replication Boolean
Databases replication. Default: ‘true’
- source
Ips List<String> List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- support
Oss BooleanCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
Outputs
All input properties are implicitly available as output properties. Additionally, the SubscriptionDatabase resource produces the following output properties:
- Db
Id int Identifier of the database created
- Id string
The provider-assigned unique ID for this managed resource.
- Private
Endpoint string Private endpoint to access the database
- Public
Endpoint string Public endpoint to access the database
- Db
Id int Identifier of the database created
- Id string
The provider-assigned unique ID for this managed resource.
- Private
Endpoint string Private endpoint to access the database
- Public
Endpoint string Public endpoint to access the database
- db
Id Integer Identifier of the database created
- id String
The provider-assigned unique ID for this managed resource.
- private
Endpoint String Private endpoint to access the database
- public
Endpoint String Public endpoint to access the database
- db
Id number Identifier of the database created
- id string
The provider-assigned unique ID for this managed resource.
- private
Endpoint string Private endpoint to access the database
- public
Endpoint string Public endpoint to access the database
- db_
id int Identifier of the database created
- id str
The provider-assigned unique ID for this managed resource.
- private_
endpoint str Private endpoint to access the database
- public_
endpoint str Public endpoint to access the database
- db
Id Number Identifier of the database created
- id String
The provider-assigned unique ID for this managed resource.
- private
Endpoint String Private endpoint to access the database
- public
Endpoint String Public endpoint to access the database
Look up Existing SubscriptionDatabase Resource
Get an existing SubscriptionDatabase 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?: SubscriptionDatabaseState, opts?: CustomResourceOptions): SubscriptionDatabase
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alerts: Optional[Sequence[SubscriptionDatabaseAlertArgs]] = None,
average_item_size_in_bytes: Optional[int] = None,
client_ssl_certificate: Optional[str] = None,
data_eviction: Optional[str] = None,
data_persistence: Optional[str] = None,
db_id: Optional[int] = None,
enable_tls: Optional[bool] = None,
external_endpoint_for_oss_cluster_api: Optional[bool] = None,
hashing_policies: Optional[Sequence[str]] = None,
memory_limit_in_gb: Optional[float] = None,
modules: Optional[Sequence[SubscriptionDatabaseModuleArgs]] = None,
name: Optional[str] = None,
password: Optional[str] = None,
periodic_backup_path: Optional[str] = None,
port: Optional[int] = None,
private_endpoint: Optional[str] = None,
protocol: Optional[str] = None,
public_endpoint: Optional[str] = None,
remote_backup: Optional[SubscriptionDatabaseRemoteBackupArgs] = None,
replica_ofs: Optional[Sequence[str]] = None,
replication: Optional[bool] = None,
source_ips: Optional[Sequence[str]] = None,
subscription_id: Optional[str] = None,
support_oss_cluster_api: Optional[bool] = None,
throughput_measurement_by: Optional[str] = None,
throughput_measurement_value: Optional[int] = None) -> SubscriptionDatabase
func GetSubscriptionDatabase(ctx *Context, name string, id IDInput, state *SubscriptionDatabaseState, opts ...ResourceOption) (*SubscriptionDatabase, error)
public static SubscriptionDatabase Get(string name, Input<string> id, SubscriptionDatabaseState? state, CustomResourceOptions? opts = null)
public static SubscriptionDatabase get(String name, Output<String> id, SubscriptionDatabaseState 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.
- Alerts
List<Redis
Labs. Rediscloud. Inputs. Subscription Database Alert> A block defining Redis database alert, documented below, can be specified multiple times
- Average
Item intSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- Client
Ssl stringCertificate SSL certificate to authenticate user connections
- Data
Eviction string The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- Data
Persistence string Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- Db
Id int Identifier of the database created
- Enable
Tls bool Use TLS for authentication. Default: ‘false’
- External
Endpoint boolFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- Hashing
Policies List<string> List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- Memory
Limit doubleIn Gb Maximum memory usage for this specific database
- Modules
List<Redis
Labs. Rediscloud. Inputs. Subscription Database Module> A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- Name string
A meaningful name to identify the database
- Password string
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- Periodic
Backup stringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- Port int
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- Private
Endpoint string Private endpoint to access the database
- Protocol string
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- Public
Endpoint string Public endpoint to access the database
- Remote
Backup RedisLabs. Rediscloud. Inputs. Subscription Database Remote Backup Specifies the backup options for the database, documented below
- Replica
Ofs List<string> Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- Replication bool
Databases replication. Default: ‘true’
- Source
Ips List<string> List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- Subscription
Id string The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- Support
Oss boolCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- Throughput
Measurement stringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- Throughput
Measurement intValue Throughput value (as applies to selected measurement method)
- Alerts
[]Subscription
Database Alert Args A block defining Redis database alert, documented below, can be specified multiple times
- Average
Item intSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- Client
Ssl stringCertificate SSL certificate to authenticate user connections
- Data
Eviction string The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- Data
Persistence string Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- Db
Id int Identifier of the database created
- Enable
Tls bool Use TLS for authentication. Default: ‘false’
- External
Endpoint boolFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- Hashing
Policies []string List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- Memory
Limit float64In Gb Maximum memory usage for this specific database
- Modules
[]Subscription
Database Module Args A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- Name string
A meaningful name to identify the database
- Password string
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- Periodic
Backup stringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- Port int
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- Private
Endpoint string Private endpoint to access the database
- Protocol string
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- Public
Endpoint string Public endpoint to access the database
- Remote
Backup SubscriptionDatabase Remote Backup Args Specifies the backup options for the database, documented below
- Replica
Ofs []string Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- Replication bool
Databases replication. Default: ‘true’
- Source
Ips []string List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- Subscription
Id string The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- Support
Oss boolCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- Throughput
Measurement stringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- Throughput
Measurement intValue Throughput value (as applies to selected measurement method)
- alerts
List<Subscription
Database Alert> A block defining Redis database alert, documented below, can be specified multiple times
- average
Item IntegerSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- client
Ssl StringCertificate SSL certificate to authenticate user connections
- data
Eviction String The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- data
Persistence String Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- db
Id Integer Identifier of the database created
- enable
Tls Boolean Use TLS for authentication. Default: ‘false’
- external
Endpoint BooleanFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- hashing
Policies List<String> List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- memory
Limit DoubleIn Gb Maximum memory usage for this specific database
- modules
List<Subscription
Database Module> A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- name String
A meaningful name to identify the database
- password String
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- periodic
Backup StringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- port Integer
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- private
Endpoint String Private endpoint to access the database
- protocol String
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- public
Endpoint String Public endpoint to access the database
- remote
Backup SubscriptionDatabase Remote Backup Specifies the backup options for the database, documented below
- replica
Ofs List<String> Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- replication Boolean
Databases replication. Default: ‘true’
- source
Ips List<String> List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- subscription
Id String The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- support
Oss BooleanCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- throughput
Measurement StringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- throughput
Measurement IntegerValue Throughput value (as applies to selected measurement method)
- alerts
Subscription
Database Alert[] A block defining Redis database alert, documented below, can be specified multiple times
- average
Item numberSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- client
Ssl stringCertificate SSL certificate to authenticate user connections
- data
Eviction string The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- data
Persistence string Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- db
Id number Identifier of the database created
- enable
Tls boolean Use TLS for authentication. Default: ‘false’
- external
Endpoint booleanFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- hashing
Policies string[] List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- memory
Limit numberIn Gb Maximum memory usage for this specific database
- modules
Subscription
Database Module[] A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- name string
A meaningful name to identify the database
- password string
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- periodic
Backup stringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- port number
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- private
Endpoint string Private endpoint to access the database
- protocol string
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- public
Endpoint string Public endpoint to access the database
- remote
Backup SubscriptionDatabase Remote Backup Specifies the backup options for the database, documented below
- replica
Ofs string[] Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- replication boolean
Databases replication. Default: ‘true’
- source
Ips string[] List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- subscription
Id string The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- support
Oss booleanCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- throughput
Measurement stringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- throughput
Measurement numberValue Throughput value (as applies to selected measurement method)
- alerts
Sequence[Subscription
Database Alert Args] A block defining Redis database alert, documented below, can be specified multiple times
- average_
item_ intsize_ in_ bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- client_
ssl_ strcertificate SSL certificate to authenticate user connections
- data_
eviction str The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- data_
persistence str Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- db_
id int Identifier of the database created
- enable_
tls bool Use TLS for authentication. Default: ‘false’
- external_
endpoint_ boolfor_ oss_ cluster_ api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- hashing_
policies Sequence[str] List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- memory_
limit_ floatin_ gb Maximum memory usage for this specific database
- modules
Sequence[Subscription
Database Module Args] A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- name str
A meaningful name to identify the database
- password str
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- periodic_
backup_ strpath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- port int
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- private_
endpoint str Private endpoint to access the database
- protocol str
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- public_
endpoint str Public endpoint to access the database
- remote_
backup SubscriptionDatabase Remote Backup Args Specifies the backup options for the database, documented below
- replica_
ofs Sequence[str] Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- replication bool
Databases replication. Default: ‘true’
- source_
ips Sequence[str] List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- subscription_
id str The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- support_
oss_ boolcluster_ api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- throughput_
measurement_ strby Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- throughput_
measurement_ intvalue Throughput value (as applies to selected measurement method)
- alerts List<Property Map>
A block defining Redis database alert, documented below, can be specified multiple times
- average
Item NumberSize In Bytes Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000
- client
Ssl StringCertificate SSL certificate to authenticate user connections
- data
Eviction String The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'). Default: 'volatile-lru'
- data
Persistence String Rate of database's storage data persistence (either: 'none', 'aof-every-1-second', 'aof-every-write', 'snapshot-every-1-hour', 'snapshot-every-6-hours' or 'snapshot-every-12-hours'). Default: ‘none’
- db
Id Number Identifier of the database created
- enable
Tls Boolean Use TLS for authentication. Default: ‘false’
- external
Endpoint BooleanFor Oss Cluster Api Should use the external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
- hashing
Policies List<String> List of regular expression rules to shard the database by. See the documentation on clustering for more information on the hashing policy. This cannot be set when
support_oss_cluster_api
is set to true.- memory
Limit NumberIn Gb Maximum memory usage for this specific database
- modules List<Property Map>
A list of modules objects, documented below. Modifying this attribute will force creation of a new resource.
- name String
A meaningful name to identify the database
- password String
Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
- periodic
Backup StringPath Path that will be used to store database backup files. Deprecated: Use
remote_backup
block insteadUse
remote_backup
block instead- port Number
TCP port on which the database is available - must be between 10000 and 19999. Modifying this attribute will force creation of a new resource.
- private
Endpoint String Private endpoint to access the database
- protocol String
The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. Modifying this attribute will force creation of a new resource.
- public
Endpoint String Public endpoint to access the database
- remote
Backup Property Map Specifies the backup options for the database, documented below
- replica
Ofs List<String> Set of Redis database URIs, in the format
redis://user:password@host:port
, that this database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided. Cannot be enabled whensupport_oss_cluster_api
is enabled.- replication Boolean
Databases replication. Default: ‘true’
- source
Ips List<String> List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: [‘192.168.10.0/32’, ‘192.168.12.0/24’])
- subscription
Id String The ID of the subscription to create the database in. Modifying this attribute will force creation of a new resource.
- support
Oss BooleanCluster Api Support Redis open-source (OSS) Cluster API. Default: ‘false’
- throughput
Measurement StringBy Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
- throughput
Measurement NumberValue Throughput value (as applies to selected measurement method)
Supporting Types
SubscriptionDatabaseAlert, SubscriptionDatabaseAlertArgs
SubscriptionDatabaseModule, SubscriptionDatabaseModuleArgs
- Name string
Name of the Redis database module to enable. Modifying this attribute will force creation of a new resource.
Example:
import * as pulumi from "@pulumi/pulumi";
const modules = [ { name: "RedisJSON", }, { name: "RedisBloom", }, ];
import pulumi modules = [ { "name": "RedisJSON", }, { "name": "RedisBloom", }, ]
using System.Collections.Generic; using System.Linq; using Pulumi; return await Deployment.RunAsync(() => { var modules = new[] { { { "name", "RedisJSON" }, }, { { "name", "RedisBloom" }, }, }; });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _ := []map[string]interface{}{ map[string]interface{}{ "name": "RedisJSON", }, map[string]interface{}{ "name": "RedisBloom", }, } return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { final var modules = %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference), %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference); } }
variables: modules: - name: RedisJSON - name: RedisBloom
- Name string
Name of the Redis database module to enable. Modifying this attribute will force creation of a new resource.
Example:
import * as pulumi from "@pulumi/pulumi";
const modules = [ { name: "RedisJSON", }, { name: "RedisBloom", }, ];
import pulumi modules = [ { "name": "RedisJSON", }, { "name": "RedisBloom", }, ]
using System.Collections.Generic; using System.Linq; using Pulumi; return await Deployment.RunAsync(() => { var modules = new[] { { { "name", "RedisJSON" }, }, { { "name", "RedisBloom" }, }, }; });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _ := []map[string]interface{}{ map[string]interface{}{ "name": "RedisJSON", }, map[string]interface{}{ "name": "RedisBloom", }, } return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { final var modules = %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference), %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference); } }
variables: modules: - name: RedisJSON - name: RedisBloom
- name String
Name of the Redis database module to enable. Modifying this attribute will force creation of a new resource.
Example:
import * as pulumi from "@pulumi/pulumi";
const modules = [ { name: "RedisJSON", }, { name: "RedisBloom", }, ];
import pulumi modules = [ { "name": "RedisJSON", }, { "name": "RedisBloom", }, ]
using System.Collections.Generic; using System.Linq; using Pulumi; return await Deployment.RunAsync(() => { var modules = new[] { { { "name", "RedisJSON" }, }, { { "name", "RedisBloom" }, }, }; });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _ := []map[string]interface{}{ map[string]interface{}{ "name": "RedisJSON", }, map[string]interface{}{ "name": "RedisBloom", }, } return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { final var modules = %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference), %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference); } }
variables: modules: - name: RedisJSON - name: RedisBloom
- name string
Name of the Redis database module to enable. Modifying this attribute will force creation of a new resource.
Example:
import * as pulumi from "@pulumi/pulumi";
const modules = [ { name: "RedisJSON", }, { name: "RedisBloom", }, ];
import pulumi modules = [ { "name": "RedisJSON", }, { "name": "RedisBloom", }, ]
using System.Collections.Generic; using System.Linq; using Pulumi; return await Deployment.RunAsync(() => { var modules = new[] { { { "name", "RedisJSON" }, }, { { "name", "RedisBloom" }, }, }; });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _ := []map[string]interface{}{ map[string]interface{}{ "name": "RedisJSON", }, map[string]interface{}{ "name": "RedisBloom", }, } return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { final var modules = %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference), %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference); } }
variables: modules: - name: RedisJSON - name: RedisBloom
- name str
Name of the Redis database module to enable. Modifying this attribute will force creation of a new resource.
Example:
import * as pulumi from "@pulumi/pulumi";
const modules = [ { name: "RedisJSON", }, { name: "RedisBloom", }, ];
import pulumi modules = [ { "name": "RedisJSON", }, { "name": "RedisBloom", }, ]
using System.Collections.Generic; using System.Linq; using Pulumi; return await Deployment.RunAsync(() => { var modules = new[] { { { "name", "RedisJSON" }, }, { { "name", "RedisBloom" }, }, }; });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _ := []map[string]interface{}{ map[string]interface{}{ "name": "RedisJSON", }, map[string]interface{}{ "name": "RedisBloom", }, } return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { final var modules = %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference), %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference); } }
variables: modules: - name: RedisJSON - name: RedisBloom
- name String
Name of the Redis database module to enable. Modifying this attribute will force creation of a new resource.
Example:
import * as pulumi from "@pulumi/pulumi";
const modules = [ { name: "RedisJSON", }, { name: "RedisBloom", }, ];
import pulumi modules = [ { "name": "RedisJSON", }, { "name": "RedisBloom", }, ]
using System.Collections.Generic; using System.Linq; using Pulumi; return await Deployment.RunAsync(() => { var modules = new[] { { { "name", "RedisJSON" }, }, { { "name", "RedisBloom" }, }, }; });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _ := []map[string]interface{}{ map[string]interface{}{ "name": "RedisJSON", }, map[string]interface{}{ "name": "RedisBloom", }, } return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { final var modules = %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference), %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference); } }
variables: modules: - name: RedisJSON - name: RedisBloom
SubscriptionDatabaseRemoteBackup, SubscriptionDatabaseRemoteBackupArgs
- Interval string
Defines the interval between backups. Should be in the following format 'every-x-hours'. x is one of [24,12,6,4,2,1]. For example: 'every-4-hours'
- Storage
Path string Defines a URI representing the backup storage location
- Storage
Type string Defines the provider of the storage location
- Time
Utc string Defines the hour automatic backups are made - only applicable when the interval is
every-12-hours
orevery-24-hours
. For example: '14:00'
- Interval string
Defines the interval between backups. Should be in the following format 'every-x-hours'. x is one of [24,12,6,4,2,1]. For example: 'every-4-hours'
- Storage
Path string Defines a URI representing the backup storage location
- Storage
Type string Defines the provider of the storage location
- Time
Utc string Defines the hour automatic backups are made - only applicable when the interval is
every-12-hours
orevery-24-hours
. For example: '14:00'
- interval String
Defines the interval between backups. Should be in the following format 'every-x-hours'. x is one of [24,12,6,4,2,1]. For example: 'every-4-hours'
- storage
Path String Defines a URI representing the backup storage location
- storage
Type String Defines the provider of the storage location
- time
Utc String Defines the hour automatic backups are made - only applicable when the interval is
every-12-hours
orevery-24-hours
. For example: '14:00'
- interval string
Defines the interval between backups. Should be in the following format 'every-x-hours'. x is one of [24,12,6,4,2,1]. For example: 'every-4-hours'
- storage
Path string Defines a URI representing the backup storage location
- storage
Type string Defines the provider of the storage location
- time
Utc string Defines the hour automatic backups are made - only applicable when the interval is
every-12-hours
orevery-24-hours
. For example: '14:00'
- interval str
Defines the interval between backups. Should be in the following format 'every-x-hours'. x is one of [24,12,6,4,2,1]. For example: 'every-4-hours'
- storage_
path str Defines a URI representing the backup storage location
- storage_
type str Defines the provider of the storage location
- time_
utc str Defines the hour automatic backups are made - only applicable when the interval is
every-12-hours
orevery-24-hours
. For example: '14:00'
- interval String
Defines the interval between backups. Should be in the following format 'every-x-hours'. x is one of [24,12,6,4,2,1]. For example: 'every-4-hours'
- storage
Path String Defines a URI representing the backup storage location
- storage
Type String Defines the provider of the storage location
- time
Utc String Defines the hour automatic backups are made - only applicable when the interval is
every-12-hours
orevery-24-hours
. For example: '14:00'
Import
rediscloud_subscription_database
can be imported using the ID of the subscription and the ID of the database in the format {subscription ID}/{database ID}, e.g.
$ pulumi import rediscloud:index/subscriptionDatabase:SubscriptionDatabase database-resource 123456/12345678
Package Details
- Repository
- rediscloud RedisLabs/pulumi-rediscloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
rediscloud
Terraform Provider.