Upstash

v0.0.21 published on Thursday, Aug 4, 2022 by Upstash

RedisDatabase

Example Usage

using Pulumi;
using Upstash = Pulumi.Upstash;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleDB = new Upstash.RedisDatabase("exampleDB", new Upstash.RedisDatabaseArgs
        {
            DatabaseName = "Terraform DB6",
            Multizone = true,
            Region = "eu-west-1",
            Tls = true,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/upstash/upstash-pulumi-provider/sdk/go/upstash"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := upstash.NewRedisDatabase(ctx, "exampleDB", &upstash.RedisDatabaseArgs{
			DatabaseName: pulumi.String("Terraform DB6"),
			Multizone:    pulumi.Bool(true),
			Region:       pulumi.String("eu-west-1"),
			Tls:          pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleDB = new RedisDatabase("exampleDB", RedisDatabaseArgs.builder()        
            .databaseName("Terraform DB6")
            .multizone("true")
            .region("eu-west-1")
            .tls("true")
            .build());

    }
}
import pulumi
import upstash_pulumi as upstash

example_db = upstash.RedisDatabase("exampleDB",
    database_name="Terraform DB6",
    multizone=True,
    region="eu-west-1",
    tls=True)
import * as pulumi from "@pulumi/pulumi";
import * as upstash from "@pulumi/upstash";

const exampleDB = new upstash.RedisDatabase("exampleDB", {
    databaseName: "Terraform DB6",
    multizone: true,
    region: "eu-west-1",
    tls: true,
});
resources:
  exampleDB:
    type: upstash:RedisDatabase
    properties:
      databaseName: Terraform DB6
      multizone: true
      region: eu-west-1
      tls: true

Create RedisDatabase Resource

new RedisDatabase(name: string, args: RedisDatabaseArgs, opts?: CustomResourceOptions);
@overload
def RedisDatabase(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  consistent: Optional[bool] = None,
                  database_name: Optional[str] = None,
                  multizone: Optional[bool] = None,
                  region: Optional[str] = None,
                  tls: Optional[bool] = None)
@overload
def RedisDatabase(resource_name: str,
                  args: RedisDatabaseArgs,
                  opts: Optional[ResourceOptions] = None)
func NewRedisDatabase(ctx *Context, name string, args RedisDatabaseArgs, opts ...ResourceOption) (*RedisDatabase, error)
public RedisDatabase(string name, RedisDatabaseArgs args, CustomResourceOptions? opts = null)
public RedisDatabase(String name, RedisDatabaseArgs args)
public RedisDatabase(String name, RedisDatabaseArgs args, CustomResourceOptions options)
type: upstash:RedisDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

RedisDatabase 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 RedisDatabase resource accepts the following input properties:

DatabaseName string

Name of the database

Region string

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

Consistent bool

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

Multizone bool

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

Tls bool

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

DatabaseName string

Name of the database

Region string

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

Consistent bool

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

Multizone bool

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

Tls bool

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

databaseName String

Name of the database

region String

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

consistent Boolean

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

multizone Boolean

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

tls Boolean

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

databaseName string

Name of the database

region string

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

consistent boolean

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

multizone boolean

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

tls boolean

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

database_name str

Name of the database

region str

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

consistent bool

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

multizone bool

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

tls bool

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

databaseName String

Name of the database

region String

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

consistent Boolean

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

multizone Boolean

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

tls Boolean

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

Outputs

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

CreationTime int

Creation time of the database

DatabaseId string

Unique Database ID for created database

DatabaseType string

Type of the database

DbDailyBandwidthLimit int

Daily bandwidth limit for the database

DbDiskThreshold int

Disk threshold for the database

DbMaxClients int

Max clients for the database

DbMaxCommandsPerSecond int

Max commands per second for the database

DbMaxEntrySize int

Max entry size for the database

DbMaxRequestSize int

Max request size for the database

DbMemoryThreshold int

Memory threshold for the database

Endpoint string

Database URL for connection

Id string

The provider-assigned unique ID for this managed resource.

Password string

Password of the database

Port int

Port of the endpoint

ReadOnlyRestToken string

Rest Token for the database.

RestToken string

Rest Token for the database.

State string

State of the database

UserEmail string

User email for the database

CreationTime int

Creation time of the database

DatabaseId string

Unique Database ID for created database

DatabaseType string

Type of the database

DbDailyBandwidthLimit int

Daily bandwidth limit for the database

DbDiskThreshold int

Disk threshold for the database

DbMaxClients int

Max clients for the database

DbMaxCommandsPerSecond int

Max commands per second for the database

DbMaxEntrySize int

Max entry size for the database

DbMaxRequestSize int

Max request size for the database

DbMemoryThreshold int

Memory threshold for the database

Endpoint string

Database URL for connection

Id string

The provider-assigned unique ID for this managed resource.

Password string

Password of the database

Port int

Port of the endpoint

ReadOnlyRestToken string

Rest Token for the database.

RestToken string

Rest Token for the database.

State string

State of the database

UserEmail string

User email for the database

creationTime Integer

Creation time of the database

databaseId String

Unique Database ID for created database

databaseType String

Type of the database

dbDailyBandwidthLimit Integer

Daily bandwidth limit for the database

dbDiskThreshold Integer

Disk threshold for the database

dbMaxClients Integer

Max clients for the database

dbMaxCommandsPerSecond Integer

Max commands per second for the database

dbMaxEntrySize Integer

Max entry size for the database

dbMaxRequestSize Integer

Max request size for the database

dbMemoryThreshold Integer

Memory threshold for the database

endpoint String

Database URL for connection

id String

The provider-assigned unique ID for this managed resource.

password String

Password of the database

port Integer

Port of the endpoint

readOnlyRestToken String

Rest Token for the database.

restToken String

Rest Token for the database.

state String

State of the database

userEmail String

User email for the database

creationTime number

Creation time of the database

databaseId string

Unique Database ID for created database

databaseType string

Type of the database

dbDailyBandwidthLimit number

Daily bandwidth limit for the database

dbDiskThreshold number

Disk threshold for the database

dbMaxClients number

Max clients for the database

dbMaxCommandsPerSecond number

Max commands per second for the database

dbMaxEntrySize number

Max entry size for the database

dbMaxRequestSize number

Max request size for the database

dbMemoryThreshold number

Memory threshold for the database

endpoint string

Database URL for connection

id string

The provider-assigned unique ID for this managed resource.

password string

Password of the database

port number

Port of the endpoint

readOnlyRestToken string

Rest Token for the database.

restToken string

Rest Token for the database.

state string

State of the database

userEmail string

User email for the database

creation_time int

Creation time of the database

database_id str

Unique Database ID for created database

database_type str

Type of the database

db_daily_bandwidth_limit int

Daily bandwidth limit for the database

db_disk_threshold int

Disk threshold for the database

db_max_clients int

Max clients for the database

db_max_commands_per_second int

Max commands per second for the database

db_max_entry_size int

Max entry size for the database

db_max_request_size int

Max request size for the database

db_memory_threshold int

Memory threshold for the database

endpoint str

Database URL for connection

id str

The provider-assigned unique ID for this managed resource.

password str

Password of the database

port int

Port of the endpoint

read_only_rest_token str

Rest Token for the database.

rest_token str

Rest Token for the database.

state str

State of the database

user_email str

User email for the database

creationTime Number

Creation time of the database

databaseId String

Unique Database ID for created database

databaseType String

Type of the database

dbDailyBandwidthLimit Number

Daily bandwidth limit for the database

dbDiskThreshold Number

Disk threshold for the database

dbMaxClients Number

Max clients for the database

dbMaxCommandsPerSecond Number

Max commands per second for the database

dbMaxEntrySize Number

Max entry size for the database

dbMaxRequestSize Number

Max request size for the database

dbMemoryThreshold Number

Memory threshold for the database

endpoint String

Database URL for connection

id String

The provider-assigned unique ID for this managed resource.

password String

Password of the database

port Number

Port of the endpoint

readOnlyRestToken String

Rest Token for the database.

restToken String

Rest Token for the database.

state String

State of the database

userEmail String

User email for the database

Look up Existing RedisDatabase Resource

Get an existing RedisDatabase 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?: RedisDatabaseState, opts?: CustomResourceOptions): RedisDatabase
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consistent: Optional[bool] = None,
        creation_time: Optional[int] = None,
        database_id: Optional[str] = None,
        database_name: Optional[str] = None,
        database_type: Optional[str] = None,
        db_daily_bandwidth_limit: Optional[int] = None,
        db_disk_threshold: Optional[int] = None,
        db_max_clients: Optional[int] = None,
        db_max_commands_per_second: Optional[int] = None,
        db_max_entry_size: Optional[int] = None,
        db_max_request_size: Optional[int] = None,
        db_memory_threshold: Optional[int] = None,
        endpoint: Optional[str] = None,
        multizone: Optional[bool] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        read_only_rest_token: Optional[str] = None,
        region: Optional[str] = None,
        rest_token: Optional[str] = None,
        state: Optional[str] = None,
        tls: Optional[bool] = None,
        user_email: Optional[str] = None) -> RedisDatabase
func GetRedisDatabase(ctx *Context, name string, id IDInput, state *RedisDatabaseState, opts ...ResourceOption) (*RedisDatabase, error)
public static RedisDatabase Get(string name, Input<string> id, RedisDatabaseState? state, CustomResourceOptions? opts = null)
public static RedisDatabase get(String name, Output<String> id, RedisDatabaseState 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.
The following state arguments are supported:
Consistent bool

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

CreationTime int

Creation time of the database

DatabaseId string

Unique Database ID for created database

DatabaseName string

Name of the database

DatabaseType string

Type of the database

DbDailyBandwidthLimit int

Daily bandwidth limit for the database

DbDiskThreshold int

Disk threshold for the database

DbMaxClients int

Max clients for the database

DbMaxCommandsPerSecond int

Max commands per second for the database

DbMaxEntrySize int

Max entry size for the database

DbMaxRequestSize int

Max request size for the database

DbMemoryThreshold int

Memory threshold for the database

Endpoint string

Database URL for connection

Multizone bool

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

Password string

Password of the database

Port int

Port of the endpoint

ReadOnlyRestToken string

Rest Token for the database.

Region string

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

RestToken string

Rest Token for the database.

State string

State of the database

Tls bool

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

UserEmail string

User email for the database

Consistent bool

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

CreationTime int

Creation time of the database

DatabaseId string

Unique Database ID for created database

DatabaseName string

Name of the database

DatabaseType string

Type of the database

DbDailyBandwidthLimit int

Daily bandwidth limit for the database

DbDiskThreshold int

Disk threshold for the database

DbMaxClients int

Max clients for the database

DbMaxCommandsPerSecond int

Max commands per second for the database

DbMaxEntrySize int

Max entry size for the database

DbMaxRequestSize int

Max request size for the database

DbMemoryThreshold int

Memory threshold for the database

Endpoint string

Database URL for connection

Multizone bool

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

Password string

Password of the database

Port int

Port of the endpoint

ReadOnlyRestToken string

Rest Token for the database.

Region string

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

RestToken string

Rest Token for the database.

State string

State of the database

Tls bool

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

UserEmail string

User email for the database

consistent Boolean

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

creationTime Integer

Creation time of the database

databaseId String

Unique Database ID for created database

databaseName String

Name of the database

databaseType String

Type of the database

dbDailyBandwidthLimit Integer

Daily bandwidth limit for the database

dbDiskThreshold Integer

Disk threshold for the database

dbMaxClients Integer

Max clients for the database

dbMaxCommandsPerSecond Integer

Max commands per second for the database

dbMaxEntrySize Integer

Max entry size for the database

dbMaxRequestSize Integer

Max request size for the database

dbMemoryThreshold Integer

Memory threshold for the database

endpoint String

Database URL for connection

multizone Boolean

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

password String

Password of the database

port Integer

Port of the endpoint

readOnlyRestToken String

Rest Token for the database.

region String

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

restToken String

Rest Token for the database.

state String

State of the database

tls Boolean

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

userEmail String

User email for the database

consistent boolean

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

creationTime number

Creation time of the database

databaseId string

Unique Database ID for created database

databaseName string

Name of the database

databaseType string

Type of the database

dbDailyBandwidthLimit number

Daily bandwidth limit for the database

dbDiskThreshold number

Disk threshold for the database

dbMaxClients number

Max clients for the database

dbMaxCommandsPerSecond number

Max commands per second for the database

dbMaxEntrySize number

Max entry size for the database

dbMaxRequestSize number

Max request size for the database

dbMemoryThreshold number

Memory threshold for the database

endpoint string

Database URL for connection

multizone boolean

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

password string

Password of the database

port number

Port of the endpoint

readOnlyRestToken string

Rest Token for the database.

region string

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

restToken string

Rest Token for the database.

state string

State of the database

tls boolean

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

userEmail string

User email for the database

consistent bool

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

creation_time int

Creation time of the database

database_id str

Unique Database ID for created database

database_name str

Name of the database

database_type str

Type of the database

db_daily_bandwidth_limit int

Daily bandwidth limit for the database

db_disk_threshold int

Disk threshold for the database

db_max_clients int

Max clients for the database

db_max_commands_per_second int

Max commands per second for the database

db_max_entry_size int

Max entry size for the database

db_max_request_size int

Max request size for the database

db_memory_threshold int

Memory threshold for the database

endpoint str

Database URL for connection

multizone bool

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

password str

Password of the database

port int

Port of the endpoint

read_only_rest_token str

Rest Token for the database.

region str

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

rest_token str

Rest Token for the database.

state str

State of the database

tls bool

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

user_email str

User email for the database

consistent Boolean

When enabled, all writes are synchronously persisted to the disk.

Deprecated:

Consistent option is deprecated.

creationTime Number

Creation time of the database

databaseId String

Unique Database ID for created database

databaseName String

Name of the database

databaseType String

Type of the database

dbDailyBandwidthLimit Number

Daily bandwidth limit for the database

dbDiskThreshold Number

Disk threshold for the database

dbMaxClients Number

Max clients for the database

dbMaxCommandsPerSecond Number

Max commands per second for the database

dbMaxEntrySize Number

Max entry size for the database

dbMaxRequestSize Number

Max request size for the database

dbMemoryThreshold Number

Memory threshold for the database

endpoint String

Database URL for connection

multizone Boolean

When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)

password String

Password of the database

port Number

Port of the endpoint

readOnlyRestToken String

Rest Token for the database.

region String

region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"

restToken String

Rest Token for the database.

state String

State of the database

tls Boolean

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

userEmail String

User email for the database

Package Details

Repository
https://github.com/upstash/upstash-pulumi-provider
License
Apache-2.0
Notes

This Pulumi package is based on the upstash Terraform Provider.