1. Docs
  2. Reference
  3. API
  4. @pulumi/openstack
  5. database

Module database

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-openstack repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-openstack repo.

Resources

Others

Resources

Resource Configuration

class Configuration extends CustomResource

Manages a V1 DB configuration resource within OpenStack.

Example Usage

Configuration
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const test = new openstack.database.Configuration("test", {
    configurations: [{
        name: "maxConnections",
        value: "200",
    }],
    datastore: {
        type: "mysql",
        version: "mysql-5.7",
    },
    description: "description",
});

constructor

new Configuration(name: string, args: ConfigurationArgs, opts?: pulumi.CustomResourceOptions)

Create a Configuration resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigurationState, opts?: pulumi.CustomResourceOptions): Configuration

Get an existing Configuration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Configuration

Returns true if the given object is an instance of Configuration. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property configurations

public configurations: pulumi.Output<ConfigurationConfiguration[] | undefined>;

An array of configuration parameter name and value. Can be specified multiple times. The configuration object structure is documented below.

property datastore

public datastore: pulumi.Output<ConfigurationDatastore>;

An array of database engine type and version. The datastore object structure is documented below. Changing this creates resource.

property description

public description: pulumi.Output<string>;

Description of the resource.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Configuration parameter name. Changing this creates a new resource.

property region

public region: pulumi.Output<string>;

The region in which to create the db instance. Changing this creates a new instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Database

class Database extends CustomResource

Manages a V1 DB database resource within OpenStack.

Example Usage

Database
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const mydb = new openstack.database.Database("mydb", {
    instanceId: openstack_db_instance_v1_basic.id,
});

constructor

new Database(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions)

Create a Database resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DatabaseState, opts?: pulumi.CustomResourceOptions): Database

Get an existing Database resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Database

Returns true if the given object is an instance of Database. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The ID for the database instance.

property name

public name: pulumi.Output<string>;

A unique name for the resource.

property region

public region: pulumi.Output<string>;

Openstack region resource is created in.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Instance

class Instance extends CustomResource

Manages a V1 DB instance resource within OpenStack.

Example Usage

Instance
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const test = new openstack.database.Instance("test", {
    datastore: {
        type: "mysql",
        version: "mysql-5.7",
    },
    flavorId: "31792d21-c355-4587-9290-56c1ed0ca376",
    networks: [{
        uuid: "c0612505-caf2-4fb0-b7cb-56a0240a2b12",
    }],
    region: "region-test",
    size: 8,
});

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property configurationId

public configurationId: pulumi.Output<string | undefined>;

Configuration ID to be attached to the instance. Database instance will be rebooted when configuration is detached.

property databases

public databases: pulumi.Output<InstanceDatabase[] | undefined>;

An array of database name, charset and collate. The database object structure is documented below.

property datastore

public datastore: pulumi.Output<InstanceDatastore>;

An array of database engine type and version. The datastore object structure is documented below. Changing this creates a new instance.

property flavorId

public flavorId: pulumi.Output<string>;

The flavor ID of the desired flavor for the instance. Changing this creates new instance.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Database to be created on new instance. Changing this creates a new instance.

property networks

public networks: pulumi.Output<InstanceNetwork[] | undefined>;

An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new instance.

property region

public region: pulumi.Output<string>;

The region in which to create the db instance. Changing this creates a new instance.

property size

public size: pulumi.Output<number>;

Specifies the volume size in GB. Changing this creates new instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property users

public users: pulumi.Output<InstanceUser[] | undefined>;

An array of username, password, host and databases. The user object structure is documented below.

Resource User

class User extends CustomResource

Manages a V1 DB user resource within OpenStack.

Example Usage

User
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const basic = new openstack.database.User("basic", {
    databases: ["testdb"],
    instance: openstack_db_instance_v1_basic.id,
    password: "password",
});

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property databases

public databases: pulumi.Output<string[]>;

A list of database user should have access to.

property host

public host: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

A unique name for the resource.

property password

public password: pulumi.Output<string>;

User’s password.

property region

public region: pulumi.Output<string>;

Openstack region resource is created in.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ConfigurationArgs

interface ConfigurationArgs

The set of arguments for constructing a Configuration resource.

property configurations

configurations?: pulumi.Input<pulumi.Input<ConfigurationConfiguration>[]>;

An array of configuration parameter name and value. Can be specified multiple times. The configuration object structure is documented below.

property datastore

datastore: pulumi.Input<ConfigurationDatastore>;

An array of database engine type and version. The datastore object structure is documented below. Changing this creates resource.

property description

description: pulumi.Input<string>;

Description of the resource.

property name

name?: pulumi.Input<string>;

Configuration parameter name. Changing this creates a new resource.

property region

region?: pulumi.Input<string>;

The region in which to create the db instance. Changing this creates a new instance.

interface ConfigurationState

interface ConfigurationState

Input properties used for looking up and filtering Configuration resources.

property configurations

configurations?: pulumi.Input<pulumi.Input<ConfigurationConfiguration>[]>;

An array of configuration parameter name and value. Can be specified multiple times. The configuration object structure is documented below.

property datastore

datastore?: pulumi.Input<ConfigurationDatastore>;

An array of database engine type and version. The datastore object structure is documented below. Changing this creates resource.

property description

description?: pulumi.Input<string>;

Description of the resource.

property name

name?: pulumi.Input<string>;

Configuration parameter name. Changing this creates a new resource.

property region

region?: pulumi.Input<string>;

The region in which to create the db instance. Changing this creates a new instance.

interface DatabaseArgs

interface DatabaseArgs

The set of arguments for constructing a Database resource.

property instanceId

instanceId: pulumi.Input<string>;

The ID for the database instance.

property name

name?: pulumi.Input<string>;

A unique name for the resource.

property region

region?: pulumi.Input<string>;

Openstack region resource is created in.

interface DatabaseState

interface DatabaseState

Input properties used for looking up and filtering Database resources.

property instanceId

instanceId?: pulumi.Input<string>;

The ID for the database instance.

property name

name?: pulumi.Input<string>;

A unique name for the resource.

property region

region?: pulumi.Input<string>;

Openstack region resource is created in.

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property configurationId

configurationId?: pulumi.Input<string>;

Configuration ID to be attached to the instance. Database instance will be rebooted when configuration is detached.

property databases

databases?: pulumi.Input<pulumi.Input<InstanceDatabase>[]>;

An array of database name, charset and collate. The database object structure is documented below.

property datastore

datastore: pulumi.Input<InstanceDatastore>;

An array of database engine type and version. The datastore object structure is documented below. Changing this creates a new instance.

property flavorId

flavorId?: pulumi.Input<string>;

The flavor ID of the desired flavor for the instance. Changing this creates new instance.

property name

name?: pulumi.Input<string>;

Database to be created on new instance. Changing this creates a new instance.

property networks

networks?: pulumi.Input<pulumi.Input<InstanceNetwork>[]>;

An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new instance.

property region

region?: pulumi.Input<string>;

The region in which to create the db instance. Changing this creates a new instance.

property size

size: pulumi.Input<number>;

Specifies the volume size in GB. Changing this creates new instance.

property users

users?: pulumi.Input<pulumi.Input<InstanceUser>[]>;

An array of username, password, host and databases. The user object structure is documented below.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property configurationId

configurationId?: pulumi.Input<string>;

Configuration ID to be attached to the instance. Database instance will be rebooted when configuration is detached.

property databases

databases?: pulumi.Input<pulumi.Input<InstanceDatabase>[]>;

An array of database name, charset and collate. The database object structure is documented below.

property datastore

datastore?: pulumi.Input<InstanceDatastore>;

An array of database engine type and version. The datastore object structure is documented below. Changing this creates a new instance.

property flavorId

flavorId?: pulumi.Input<string>;

The flavor ID of the desired flavor for the instance. Changing this creates new instance.

property name

name?: pulumi.Input<string>;

Database to be created on new instance. Changing this creates a new instance.

property networks

networks?: pulumi.Input<pulumi.Input<InstanceNetwork>[]>;

An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new instance.

property region

region?: pulumi.Input<string>;

The region in which to create the db instance. Changing this creates a new instance.

property size

size?: pulumi.Input<number>;

Specifies the volume size in GB. Changing this creates new instance.

property users

users?: pulumi.Input<pulumi.Input<InstanceUser>[]>;

An array of username, password, host and databases. The user object structure is documented below.

interface UserArgs

interface UserArgs

The set of arguments for constructing a User resource.

property databases

databases?: pulumi.Input<pulumi.Input<string>[]>;

A list of database user should have access to.

property host

host?: pulumi.Input<string>;

property instanceId

instanceId: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

A unique name for the resource.

property password

password: pulumi.Input<string>;

User’s password.

property region

region?: pulumi.Input<string>;

Openstack region resource is created in.

interface UserState

interface UserState

Input properties used for looking up and filtering User resources.

property databases

databases?: pulumi.Input<pulumi.Input<string>[]>;

A list of database user should have access to.

property host

host?: pulumi.Input<string>;

property instanceId

instanceId?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

A unique name for the resource.

property password

password?: pulumi.Input<string>;

User’s password.

property region

region?: pulumi.Input<string>;

Openstack region resource is created in.