This page documents the language specification for the openstack package. If you're looking for help working with the inputs, outputs, or functions of openstack resources in a Pulumi program, please see the resource documentation for examples and API reference.

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.

class pulumi_openstack.database.Configuration(resource_name, opts=None, configurations=None, datastore=None, description=None, name=None, region=None, __props__=None, __name__=None, __opts__=None)¶

Manages a V1 DB configuration resource within OpenStack.

import pulumi
import pulumi_openstack as openstack

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
configurations (pulumi.Input[list]) – An array of configuration parameter name and value. Can be specified multiple times. The configuration object structure is documented below.
datastore (pulumi.Input[dict]) – An array of database engine type and version. The datastore object structure is documented below. Changing this creates resource.
description (pulumi.Input[str]) – Description of the resource.
name (pulumi.Input[str]) – Configuration parameter name. Changing this creates a new resource.
region (pulumi.Input[str]) – The region in which to create the db instance. Changing this creates a new instance.

The configurations object supports the following:

name (pulumi.Input[str]) - Configuration parameter name. Changing this creates a new resource.
value (pulumi.Input[str]) - Configuration parameter value. Changing this creates a new resource.

The datastore object supports the following:

type (pulumi.Input[str]) - Database engine type to be used with this configuration. Changing this creates a new resource.
version (pulumi.Input[str]) - Version of database engine type to be used with this configuration. Changing this creates a new resource.

configurations: pulumi.Output[list] = None¶

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

name (str) - Configuration parameter name. Changing this creates a new resource.
value (str) - Configuration parameter value. Changing this creates a new resource.

datastore: pulumi.Output[dict] = None¶

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

type (str) - Database engine type to be used with this configuration. Changing this creates a new resource.
version (str) - Version of database engine type to be used with this configuration. Changing this creates a new resource.

description: pulumi.Output[str] = None¶: Description of the resource.

name: pulumi.Output[str] = None¶: Configuration parameter name. Changing this creates a new resource.

region: pulumi.Output[str] = None¶: The region in which to create the db instance. Changing this creates a new instance.

static get(resource_name, id, opts=None, configurations=None, datastore=None, description=None, name=None, region=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
configurations (pulumi.Input[list]) – An array of configuration parameter name and value. Can be specified multiple times. The configuration object structure is documented below.
datastore (pulumi.Input[dict]) – An array of database engine type and version. The datastore object structure is documented below. Changing this creates resource.
description (pulumi.Input[str]) – Description of the resource.
name (pulumi.Input[str]) – Configuration parameter name. Changing this creates a new resource.
region (pulumi.Input[str]) – The region in which to create the db instance. Changing this creates a new instance.

The configurations object supports the following:

name (pulumi.Input[str]) - Configuration parameter name. Changing this creates a new resource.
value (pulumi.Input[str]) - Configuration parameter value. Changing this creates a new resource.

The datastore object supports the following:

type (pulumi.Input[str]) - Database engine type to be used with this configuration. Changing this creates a new resource.
version (pulumi.Input[str]) - Version of database engine type to be used with this configuration. Changing this creates a new resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_openstack.database.Database(resource_name, opts=None, instance_id=None, name=None, region=None, __props__=None, __name__=None, __opts__=None)¶

Manages a V1 DB database resource within OpenStack.

import pulumi
import pulumi_openstack as openstack

mydb = openstack.database.Database("mydb", instance_id=openstack_db_instance_v1["basic"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_id (pulumi.Input[str]) – The ID for the database instance.
name (pulumi.Input[str]) – A unique name for the resource.
region (pulumi.Input[str]) – Openstack region resource is created in.

instance_id: pulumi.Output[str] = None¶: The ID for the database instance.

name: pulumi.Output[str] = None¶: A unique name for the resource.

region: pulumi.Output[str] = None¶: Openstack region resource is created in.

static get(resource_name, id, opts=None, instance_id=None, name=None, region=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_id (pulumi.Input[str]) – The ID for the database instance.
name (pulumi.Input[str]) – A unique name for the resource.
region (pulumi.Input[str]) – Openstack region resource is created in.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_openstack.database.Instance(resource_name, opts=None, configuration_id=None, databases=None, datastore=None, flavor_id=None, name=None, networks=None, region=None, size=None, users=None, __props__=None, __name__=None, __opts__=None)¶

Manages a V1 DB instance resource within OpenStack.

import pulumi
import pulumi_openstack as openstack

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
configuration_id (pulumi.Input[str]) – Configuration ID to be attached to the instance. Database instance will be rebooted when configuration is detached.
databases (pulumi.Input[list]) – An array of database name, charset and collate. The database object structure is documented below.
datastore (pulumi.Input[dict]) – An array of database engine type and version. The datastore object structure is documented below. Changing this creates a new instance.
flavor_id (pulumi.Input[str]) – The flavor ID of the desired flavor for the instance. Changing this creates new instance.
name (pulumi.Input[str]) – Database to be created on new instance. Changing this creates a new instance.
networks (pulumi.Input[list]) – 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.
region (pulumi.Input[str]) – The region in which to create the db instance. Changing this creates a new instance.
size (pulumi.Input[float]) – Specifies the volume size in GB. Changing this creates new instance.
users (pulumi.Input[list]) – An array of username, password, host and databases. The user object structure is documented below.

The databases object supports the following:

charset (pulumi.Input[str]) - Database character set. Changing this creates a new instance.
collate (pulumi.Input[str]) - Database collation. Changing this creates a new instance.
name (pulumi.Input[str]) - Database to be created on new instance. Changing this creates a new instance.

The datastore object supports the following:

type (pulumi.Input[str]) - Database engine type to be used in new instance. Changing this creates a new instance.
version (pulumi.Input[str]) - Version of database engine type to be used in new instance. Changing this creates a new instance.

The networks object supports the following:

fixedIpV4 (pulumi.Input[str]) - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new instance.
fixedIpV6 (pulumi.Input[str]) - Specifies a fixed IPv6 address to be used on this network. Changing this creates a new instance.
port (pulumi.Input[str]) - The port UUID of a network to attach to the instance. Changing this creates a new instance.
uuid (pulumi.Input[str]) - The network UUID to attach to the instance. Changing this creates a new instance.

The users object supports the following:

databases (pulumi.Input[list]) - A list of databases that user will have access to. If not specified, user has access to all databases on th einstance. Changing this creates a new instance.
host (pulumi.Input[str]) - An ip address or % sign indicating what ip addresses can connect with this user credentials. Changing this creates a new instance.
name (pulumi.Input[str]) - Database to be created on new instance. Changing this creates a new instance.
password (pulumi.Input[str]) - User’s password. Changing this creates a new instance.

configuration_id: pulumi.Output[str] = None¶: Configuration ID to be attached to the instance. Database instance will be rebooted when configuration is detached.

databases: pulumi.Output[list] = None¶

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

charset (str) - Database character set. Changing this creates a new instance.
collate (str) - Database collation. Changing this creates a new instance.
name (str) - Database to be created on new instance. Changing this creates a new instance.

datastore: pulumi.Output[dict] = None¶

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

type (str) - Database engine type to be used in new instance. Changing this creates a new instance.
version (str) - Version of database engine type to be used in new instance. Changing this creates a new instance.

flavor_id: pulumi.Output[str] = None¶: The flavor ID of the desired flavor for the instance. Changing this creates new instance.

name: pulumi.Output[str] = None¶: Database to be created on new instance. Changing this creates a new instance.

networks: pulumi.Output[list] = None¶

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.

fixedIpV4 (str) - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new instance.
fixedIpV6 (str) - Specifies a fixed IPv6 address to be used on this network. Changing this creates a new instance.
port (str) - The port UUID of a network to attach to the instance. Changing this creates a new instance.
uuid (str) - The network UUID to attach to the instance. Changing this creates a new instance.

region: pulumi.Output[str] = None¶: The region in which to create the db instance. Changing this creates a new instance.

size: pulumi.Output[float] = None¶: Specifies the volume size in GB. Changing this creates new instance.

users: pulumi.Output[list] = None¶

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

databases (list) - A list of databases that user will have access to. If not specified, user has access to all databases on th einstance. Changing this creates a new instance.
host (str) - An ip address or % sign indicating what ip addresses can connect with this user credentials. Changing this creates a new instance.
name (str) - Database to be created on new instance. Changing this creates a new instance.
password (str) - User’s password. Changing this creates a new instance.

static get(resource_name, id, opts=None, configuration_id=None, databases=None, datastore=None, flavor_id=None, name=None, networks=None, region=None, size=None, users=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
configuration_id (pulumi.Input[str]) – Configuration ID to be attached to the instance. Database instance will be rebooted when configuration is detached.
databases (pulumi.Input[list]) – An array of database name, charset and collate. The database object structure is documented below.
datastore (pulumi.Input[dict]) – An array of database engine type and version. The datastore object structure is documented below. Changing this creates a new instance.
flavor_id (pulumi.Input[str]) – The flavor ID of the desired flavor for the instance. Changing this creates new instance.
name (pulumi.Input[str]) – Database to be created on new instance. Changing this creates a new instance.
networks (pulumi.Input[list]) – 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.
region (pulumi.Input[str]) – The region in which to create the db instance. Changing this creates a new instance.
size (pulumi.Input[float]) – Specifies the volume size in GB. Changing this creates new instance.
users (pulumi.Input[list]) – An array of username, password, host and databases. The user object structure is documented below.

The databases object supports the following:

charset (pulumi.Input[str]) - Database character set. Changing this creates a new instance.
collate (pulumi.Input[str]) - Database collation. Changing this creates a new instance.
name (pulumi.Input[str]) - Database to be created on new instance. Changing this creates a new instance.

The datastore object supports the following:

type (pulumi.Input[str]) - Database engine type to be used in new instance. Changing this creates a new instance.
version (pulumi.Input[str]) - Version of database engine type to be used in new instance. Changing this creates a new instance.

The networks object supports the following:

fixedIpV4 (pulumi.Input[str]) - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new instance.
fixedIpV6 (pulumi.Input[str]) - Specifies a fixed IPv6 address to be used on this network. Changing this creates a new instance.
port (pulumi.Input[str]) - The port UUID of a network to attach to the instance. Changing this creates a new instance.
uuid (pulumi.Input[str]) - The network UUID to attach to the instance. Changing this creates a new instance.

The users object supports the following:

databases (pulumi.Input[list]) - A list of databases that user will have access to. If not specified, user has access to all databases on th einstance. Changing this creates a new instance.
host (pulumi.Input[str]) - An ip address or % sign indicating what ip addresses can connect with this user credentials. Changing this creates a new instance.
name (pulumi.Input[str]) - Database to be created on new instance. Changing this creates a new instance.
password (pulumi.Input[str]) - User’s password. Changing this creates a new instance.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_openstack.database.User(resource_name, opts=None, databases=None, host=None, instance_id=None, name=None, password=None, region=None, __props__=None, __name__=None, __opts__=None)¶

Manages a V1 DB user resource within OpenStack.

import pulumi
import pulumi_openstack as openstack

basic = openstack.database.User("basic",
    databases=["testdb"],
    instance=openstack_db_instance_v1["basic"]["id"],
    password="password")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
databases (pulumi.Input[list]) – A list of database user should have access to.
name (pulumi.Input[str]) – A unique name for the resource.
password (pulumi.Input[str]) – User’s password.
region (pulumi.Input[str]) – Openstack region resource is created in.

databases: pulumi.Output[list] = None¶: A list of database user should have access to.

name: pulumi.Output[str] = None¶: A unique name for the resource.

password: pulumi.Output[str] = None¶: User’s password.

region: pulumi.Output[str] = None¶: Openstack region resource is created in.

static get(resource_name, id, opts=None, databases=None, host=None, instance_id=None, name=None, password=None, region=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
databases (pulumi.Input[list]) – A list of database user should have access to.
name (pulumi.Input[str]) – A unique name for the resource.
password (pulumi.Input[str]) – User’s password.
region (pulumi.Input[str]) – Openstack region resource is created in.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

database¶

On This Page