Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
aiven.getPgDatabase
Explore with Pulumi AI
Gets information about a database in an Aiven for PostgreSQL® service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const main = aiven.getPgDatabase({
project: exampleProject.project,
serviceName: examplePostgres.serviceName,
databaseName: "example-database",
});
import pulumi
import pulumi_aiven as aiven
main = aiven.get_pg_database(project=example_project["project"],
service_name=example_postgres["serviceName"],
database_name="example-database")
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: exampleProject.Project,
ServiceName: examplePostgres.ServiceName,
DatabaseName: "example-database",
}, 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 main = Aiven.GetPgDatabase.Invoke(new()
{
Project = exampleProject.Project,
ServiceName = examplePostgres.ServiceName,
DatabaseName = "example-database",
});
});
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 main = AivenFunctions.getPgDatabase(GetPgDatabaseArgs.builder()
.project(exampleProject.project())
.serviceName(examplePostgres.serviceName())
.databaseName("example-database")
.build());
}
}
variables:
main:
fn::invoke:
Function: aiven:getPgDatabase
Arguments:
project: ${exampleProject.project}
serviceName: ${examplePostgres.serviceName}
databaseName: example-database
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:
- Database
Name string - The name of the service database. Changing this property forces recreation of the resource.
- Project string
- The name of 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 string - 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 string - The name of the service database. Changing this property forces recreation of the resource.
- Project string
- The name of 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 string - 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 String - The name of the service database. Changing this property forces recreation of the resource.
- project String
- The name of 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 String - 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 string - The name of the service database. Changing this property forces recreation of the resource.
- project string
- The name of 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 string - 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
- The name of 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 - 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 String - The name of the service database. Changing this property forces recreation of the resource.
- project String
- The name of 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 String - 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:
- Database
Name 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.
- Lc
Collate string - Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Lc
Ctype string - Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Project string
- The name of 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 string - 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
- Database
Name 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.
- Lc
Collate string - Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Lc
Ctype string - Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Project string
- The name of 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 string - 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
- database
Name 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.
- lc
Collate String - Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype String - Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - project String
- The name of 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 String - 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 Boolean
- database
Name 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.
- lc
Collate string - Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype string - Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - project string
- The name of 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 string - 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 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 isen_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 isen_US.UTF-8
. Changing this property forces recreation of the resource. - project str
- The name of 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 - 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
- database
Name 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.
- lc
Collate String - Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype String - Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - project String
- The name of 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 String - 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 Boolean
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aiven
Terraform Provider.