1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabase
  5. getDatabaseInstance
OVHCloud v0.35.0 published on Monday, Nov 13, 2023 by OVHcloud

ovh.CloudProjectDatabase.getDatabaseInstance

Explore with Pulumi AI

ovh logo
OVHCloud v0.35.0 published on Monday, Nov 13, 2023 by OVHcloud

    Use this data source to get information about a database of a database cluster associated with a public cloud project.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var database = Ovh.CloudProjectDatabase.GetDatabaseInstance.Invoke(new()
        {
            ServiceName = "XXX",
            Engine = "YYY",
            ClusterId = "ZZZ",
            Name = "UUU",
        });
    
        return new Dictionary<string, object?>
        {
            ["databaseName"] = database.Apply(getDatabaseInstanceResult => getDatabaseInstanceResult.Name),
        };
    });
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/go/ovh/CloudProjectDatabase"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		database, err := CloudProjectDatabase.GetDatabaseInstance(ctx, &cloudprojectdatabase.GetDatabaseInstanceArgs{
    			ServiceName: "XXX",
    			Engine:      "YYY",
    			ClusterId:   "ZZZ",
    			Name:        "UUU",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("databaseName", database.Name)
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.CloudProjectDatabase.CloudProjectDatabaseFunctions;
    import com.pulumi.ovh.CloudProjectDatabase.inputs.GetDatabaseInstanceArgs;
    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 database = CloudProjectDatabaseFunctions.getDatabaseInstance(GetDatabaseInstanceArgs.builder()
                .serviceName("XXX")
                .engine("YYY")
                .clusterId("ZZZ")
                .name("UUU")
                .build());
    
            ctx.export("databaseName", database.applyValue(getDatabaseInstanceResult -> getDatabaseInstanceResult.name()));
        }
    }
    
    import pulumi
    import pulumi_ovh as ovh
    
    database = ovh.CloudProjectDatabase.get_database_instance(service_name="XXX",
        engine="YYY",
        cluster_id="ZZZ",
        name="UUU")
    pulumi.export("databaseName", database.name)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@pulumi/ovh";
    
    const database = ovh.CloudProjectDatabase.getDatabaseInstance({
        serviceName: "XXX",
        engine: "YYY",
        clusterId: "ZZZ",
        name: "UUU",
    });
    export const databaseName = database.then(database => database.name);
    
    variables:
      database:
        fn::invoke:
          Function: ovh:CloudProjectDatabase:getDatabaseInstance
          Arguments:
            serviceName: XXX
            engine: YYY
            clusterId: ZZZ
            name: UUU
    outputs:
      databaseName: ${database.name}
    

    Using getDatabaseInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDatabaseInstance(args: GetDatabaseInstanceArgs, opts?: InvokeOptions): Promise<GetDatabaseInstanceResult>
    function getDatabaseInstanceOutput(args: GetDatabaseInstanceOutputArgs, opts?: InvokeOptions): Output<GetDatabaseInstanceResult>
    def get_database_instance(cluster_id: Optional[str] = None,
                              engine: Optional[str] = None,
                              name: Optional[str] = None,
                              service_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDatabaseInstanceResult
    def get_database_instance_output(cluster_id: Optional[pulumi.Input[str]] = None,
                              engine: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              service_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseInstanceResult]
    func GetDatabaseInstance(ctx *Context, args *GetDatabaseInstanceArgs, opts ...InvokeOption) (*GetDatabaseInstanceResult, error)
    func GetDatabaseInstanceOutput(ctx *Context, args *GetDatabaseInstanceOutputArgs, opts ...InvokeOption) GetDatabaseInstanceResultOutput

    > Note: This function is named GetDatabaseInstance in the Go SDK.

    public static class GetDatabaseInstance 
    {
        public static Task<GetDatabaseInstanceResult> InvokeAsync(GetDatabaseInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetDatabaseInstanceResult> Invoke(GetDatabaseInstanceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: ovh:CloudProjectDatabase/getDatabaseInstance:getDatabaseInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterId string

    Cluster ID

    Engine string

    The engine of the database cluster you want database information. To get a full list of available engine visit: public documentation. Available engines:

    Name string

    Name of the database.

    ServiceName string

    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    ClusterId string

    Cluster ID

    Engine string

    The engine of the database cluster you want database information. To get a full list of available engine visit: public documentation. Available engines:

    Name string

    Name of the database.

    ServiceName string

    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    clusterId String

    Cluster ID

    engine String

    The engine of the database cluster you want database information. To get a full list of available engine visit: public documentation. Available engines:

    name String

    Name of the database.

    serviceName String

    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    clusterId string

    Cluster ID

    engine string

    The engine of the database cluster you want database information. To get a full list of available engine visit: public documentation. Available engines:

    name string

    Name of the database.

    serviceName string

    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    cluster_id str

    Cluster ID

    engine str

    The engine of the database cluster you want database information. To get a full list of available engine visit: public documentation. Available engines:

    name str

    Name of the database.

    service_name str

    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    clusterId String

    Cluster ID

    engine String

    The engine of the database cluster you want database information. To get a full list of available engine visit: public documentation. Available engines:

    name String

    Name of the database.

    serviceName String

    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    getDatabaseInstance Result

    The following output properties are available:

    ClusterId string

    See Argument Reference above.

    Default bool

    Defines if the database has been created by default.

    Engine string

    See Argument Reference above.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    Name of the database.

    ServiceName string

    Current status of the database.

    ClusterId string

    See Argument Reference above.

    Default bool

    Defines if the database has been created by default.

    Engine string

    See Argument Reference above.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    Name of the database.

    ServiceName string

    Current status of the database.

    clusterId String

    See Argument Reference above.

    default_ Boolean

    Defines if the database has been created by default.

    engine String

    See Argument Reference above.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    Name of the database.

    serviceName String

    Current status of the database.

    clusterId string

    See Argument Reference above.

    default boolean

    Defines if the database has been created by default.

    engine string

    See Argument Reference above.

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    Name of the database.

    serviceName string

    Current status of the database.

    cluster_id str

    See Argument Reference above.

    default bool

    Defines if the database has been created by default.

    engine str

    See Argument Reference above.

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    Name of the database.

    service_name str

    Current status of the database.

    clusterId String

    See Argument Reference above.

    default Boolean

    Defines if the database has been created by default.

    engine String

    See Argument Reference above.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    Name of the database.

    serviceName String

    Current status of the database.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the ovh Terraform Provider.

    ovh logo
    OVHCloud v0.35.0 published on Monday, Nov 13, 2023 by OVHcloud