1. Packages
  2. Aiven
  3. API Docs
  4. getPgDatabase
Aiven v6.13.0 published on Monday, Mar 25, 2024 by Pulumi

aiven.getPgDatabase

Explore with Pulumi AI

aiven logo
Aiven v6.13.0 published on Monday, Mar 25, 2024 by Pulumi

    The PG Database data source provides information about the existing Aiven PostgreSQL Database.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const mydatabase = aiven.getPgDatabase({
        project: aiven_project.myproject.project,
        serviceName: aiven_pg.mypg.service_name,
        databaseName: "<DATABASE_NAME>",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    mydatabase = aiven.get_pg_database(project=aiven_project["myproject"]["project"],
        service_name=aiven_pg["mypg"]["service_name"],
        database_name="<DATABASE_NAME>")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.LookupPgDatabase(ctx, &aiven.LookupPgDatabaseArgs{
    			Project:      aiven_project.Myproject.Project,
    			ServiceName:  aiven_pg.Mypg.Service_name,
    			DatabaseName: "<DATABASE_NAME>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var mydatabase = Aiven.GetPgDatabase.Invoke(new()
        {
            Project = aiven_project.Myproject.Project,
            ServiceName = aiven_pg.Mypg.Service_name,
            DatabaseName = "<DATABASE_NAME>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.AivenFunctions;
    import com.pulumi.aiven.inputs.GetPgDatabaseArgs;
    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 mydatabase = AivenFunctions.getPgDatabase(GetPgDatabaseArgs.builder()
                .project(aiven_project.myproject().project())
                .serviceName(aiven_pg.mypg().service_name())
                .databaseName("<DATABASE_NAME>")
                .build());
    
        }
    }
    
    variables:
      mydatabase:
        fn::invoke:
          Function: aiven:getPgDatabase
          Arguments:
            project: ${aiven_project.myproject.project}
            serviceName: ${aiven_pg.mypg.service_name}
            databaseName: <DATABASE_NAME>
    

    Using getPgDatabase

    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 getPgDatabase(args: GetPgDatabaseArgs, opts?: InvokeOptions): Promise<GetPgDatabaseResult>
    function getPgDatabaseOutput(args: GetPgDatabaseOutputArgs, opts?: InvokeOptions): Output<GetPgDatabaseResult>
    def get_pg_database(database_name: Optional[str] = None,
                        project: Optional[str] = None,
                        service_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPgDatabaseResult
    def get_pg_database_output(database_name: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        service_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPgDatabaseResult]
    func LookupPgDatabase(ctx *Context, args *LookupPgDatabaseArgs, opts ...InvokeOption) (*LookupPgDatabaseResult, error)
    func LookupPgDatabaseOutput(ctx *Context, args *LookupPgDatabaseOutputArgs, opts ...InvokeOption) LookupPgDatabaseResultOutput

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

    public static class GetPgDatabase 
    {
        public static Task<GetPgDatabaseResult> InvokeAsync(GetPgDatabaseArgs args, InvokeOptions? opts = null)
        public static Output<GetPgDatabaseResult> Invoke(GetPgDatabaseInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPgDatabaseResult> getPgDatabase(GetPgDatabaseArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aiven:index/getPgDatabase:getPgDatabase
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    DatabaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    databaseName String
    The name of the service database. Changing this property forces recreation of the resource.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    databaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    database_name str
    The name of the service database. Changing this property forces recreation of the resource.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    databaseName String
    The name of the service database. Changing this property forces recreation of the resource.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    getPgDatabase Result

    The following output properties are available:

    DatabaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    LcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    LcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    TerminationProtection bool
    DatabaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    LcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    LcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    TerminationProtection bool
    databaseName String
    The name of the service database. Changing this property forces recreation of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    lcCollate String
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype String
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    terminationProtection Boolean
    databaseName string
    The name of the service database. Changing this property forces recreation of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    lcCollate string
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype string
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    terminationProtection boolean
    database_name str
    The name of the service database. Changing this property forces recreation of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    lc_collate str
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lc_ctype str
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    termination_protection bool
    databaseName String
    The name of the service database. Changing this property forces recreation of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    lcCollate String
    Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    lcCtype String
    Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    terminationProtection Boolean

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.13.0 published on Monday, Mar 25, 2024 by Pulumi