1. Packages
  2. Civo
  3. API Docs
  4. Database
Civo v2.3.8 published on Tuesday, Jul 25, 2023 by Pulumi

civo.Database

Explore with Pulumi AI

civo logo
Civo v2.3.8 published on Tuesday, Jul 25, 2023 by Pulumi

    Import

    using ID

     $ pulumi import civo:index/database:Database mydb 29fcd1c4-fb61-44c7-b49c-dc7b98e9927e
    

    Create Database Resource

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def Database(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 engine: Optional[str] = None,
                 firewall_id: Optional[str] = None,
                 name: Optional[str] = None,
                 network_id: Optional[str] = None,
                 nodes: Optional[int] = None,
                 region: Optional[str] = None,
                 size: Optional[str] = None,
                 version: Optional[str] = None)
    @overload
    def Database(resource_name: str,
                 args: DatabaseArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
    public Database(String name, DatabaseArgs args, CustomResourceOptions options)
    
    type: civo:Database
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DatabaseArgs
    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 DatabaseArgs
    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 DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Engine string

    The engine of the database

    Nodes int

    Count of nodes

    Size string

    Size of the database

    Version string

    The version of the database

    FirewallId string

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    Name string

    Name of the database

    NetworkId string

    The id of the associated network

    Region string

    The region where the database will be created.

    Engine string

    The engine of the database

    Nodes int

    Count of nodes

    Size string

    Size of the database

    Version string

    The version of the database

    FirewallId string

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    Name string

    Name of the database

    NetworkId string

    The id of the associated network

    Region string

    The region where the database will be created.

    engine String

    The engine of the database

    nodes Integer

    Count of nodes

    size String

    Size of the database

    version String

    The version of the database

    firewallId String

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    name String

    Name of the database

    networkId String

    The id of the associated network

    region String

    The region where the database will be created.

    engine string

    The engine of the database

    nodes number

    Count of nodes

    size string

    Size of the database

    version string

    The version of the database

    firewallId string

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    name string

    Name of the database

    networkId string

    The id of the associated network

    region string

    The region where the database will be created.

    engine str

    The engine of the database

    nodes int

    Count of nodes

    size str

    Size of the database

    version str

    The version of the database

    firewall_id str

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    name str

    Name of the database

    network_id str

    The id of the associated network

    region str

    The region where the database will be created.

    engine String

    The engine of the database

    nodes Number

    Count of nodes

    size String

    Size of the database

    version String

    The version of the database

    firewallId String

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    name String

    Name of the database

    networkId String

    The id of the associated network

    region String

    The region where the database will be created.

    Outputs

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

    DnsEndpoint string

    The DNS endpoint of the database

    Endpoint string

    The endpoint of the database

    Id string

    The provider-assigned unique ID for this managed resource.

    Password string

    The password of the database

    Port int

    The port of the database

    Status string

    The status of the database

    Username string

    The username of the database

    DnsEndpoint string

    The DNS endpoint of the database

    Endpoint string

    The endpoint of the database

    Id string

    The provider-assigned unique ID for this managed resource.

    Password string

    The password of the database

    Port int

    The port of the database

    Status string

    The status of the database

    Username string

    The username of the database

    dnsEndpoint String

    The DNS endpoint of the database

    endpoint String

    The endpoint of the database

    id String

    The provider-assigned unique ID for this managed resource.

    password String

    The password of the database

    port Integer

    The port of the database

    status String

    The status of the database

    username String

    The username of the database

    dnsEndpoint string

    The DNS endpoint of the database

    endpoint string

    The endpoint of the database

    id string

    The provider-assigned unique ID for this managed resource.

    password string

    The password of the database

    port number

    The port of the database

    status string

    The status of the database

    username string

    The username of the database

    dns_endpoint str

    The DNS endpoint of the database

    endpoint str

    The endpoint of the database

    id str

    The provider-assigned unique ID for this managed resource.

    password str

    The password of the database

    port int

    The port of the database

    status str

    The status of the database

    username str

    The username of the database

    dnsEndpoint String

    The DNS endpoint of the database

    endpoint String

    The endpoint of the database

    id String

    The provider-assigned unique ID for this managed resource.

    password String

    The password of the database

    port Number

    The port of the database

    status String

    The status of the database

    username String

    The username of the database

    Look up Existing Database Resource

    Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dns_endpoint: Optional[str] = None,
            endpoint: Optional[str] = None,
            engine: Optional[str] = None,
            firewall_id: Optional[str] = None,
            name: Optional[str] = None,
            network_id: Optional[str] = None,
            nodes: Optional[int] = None,
            password: Optional[str] = None,
            port: Optional[int] = None,
            region: Optional[str] = None,
            size: Optional[str] = None,
            status: Optional[str] = None,
            username: Optional[str] = None,
            version: Optional[str] = None) -> Database
    func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
    public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
    public static Database get(String name, Output<String> id, DatabaseState 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:
    DnsEndpoint string

    The DNS endpoint of the database

    Endpoint string

    The endpoint of the database

    Engine string

    The engine of the database

    FirewallId string

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    Name string

    Name of the database

    NetworkId string

    The id of the associated network

    Nodes int

    Count of nodes

    Password string

    The password of the database

    Port int

    The port of the database

    Region string

    The region where the database will be created.

    Size string

    Size of the database

    Status string

    The status of the database

    Username string

    The username of the database

    Version string

    The version of the database

    DnsEndpoint string

    The DNS endpoint of the database

    Endpoint string

    The endpoint of the database

    Engine string

    The engine of the database

    FirewallId string

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    Name string

    Name of the database

    NetworkId string

    The id of the associated network

    Nodes int

    Count of nodes

    Password string

    The password of the database

    Port int

    The port of the database

    Region string

    The region where the database will be created.

    Size string

    Size of the database

    Status string

    The status of the database

    Username string

    The username of the database

    Version string

    The version of the database

    dnsEndpoint String

    The DNS endpoint of the database

    endpoint String

    The endpoint of the database

    engine String

    The engine of the database

    firewallId String

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    name String

    Name of the database

    networkId String

    The id of the associated network

    nodes Integer

    Count of nodes

    password String

    The password of the database

    port Integer

    The port of the database

    region String

    The region where the database will be created.

    size String

    Size of the database

    status String

    The status of the database

    username String

    The username of the database

    version String

    The version of the database

    dnsEndpoint string

    The DNS endpoint of the database

    endpoint string

    The endpoint of the database

    engine string

    The engine of the database

    firewallId string

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    name string

    Name of the database

    networkId string

    The id of the associated network

    nodes number

    Count of nodes

    password string

    The password of the database

    port number

    The port of the database

    region string

    The region where the database will be created.

    size string

    Size of the database

    status string

    The status of the database

    username string

    The username of the database

    version string

    The version of the database

    dns_endpoint str

    The DNS endpoint of the database

    endpoint str

    The endpoint of the database

    engine str

    The engine of the database

    firewall_id str

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    name str

    Name of the database

    network_id str

    The id of the associated network

    nodes int

    Count of nodes

    password str

    The password of the database

    port int

    The port of the database

    region str

    The region where the database will be created.

    size str

    Size of the database

    status str

    The status of the database

    username str

    The username of the database

    version str

    The version of the database

    dnsEndpoint String

    The DNS endpoint of the database

    endpoint String

    The endpoint of the database

    engine String

    The engine of the database

    firewallId String

    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)

    name String

    Name of the database

    networkId String

    The id of the associated network

    nodes Number

    Count of nodes

    password String

    The password of the database

    port Number

    The port of the database

    region String

    The region where the database will be created.

    size String

    Size of the database

    status String

    The status of the database

    username String

    The username of the database

    version String

    The version of the database

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the civo Terraform Provider.

    civo logo
    Civo v2.3.8 published on Tuesday, Jul 25, 2023 by Pulumi