1. Packages
  2. Aiven Provider
  3. API Docs
  4. getMysqlDatabase
Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi

    Gets information about an Aiven for MySQL® database.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const exampleDatabase = aiven.getMysqlDatabase({
        project: exampleProject.project,
        serviceName: exampleMysql.serviceName,
        databaseName: "example-database",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example_database = aiven.get_mysql_database(project=example_project["project"],
        service_name=example_mysql["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.LookupMysqlDatabase(ctx, &aiven.LookupMysqlDatabaseArgs{
    			Project:      exampleProject.Project,
    			ServiceName:  exampleMysql.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 exampleDatabase = Aiven.GetMysqlDatabase.Invoke(new()
        {
            Project = exampleProject.Project,
            ServiceName = exampleMysql.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.GetMysqlDatabaseArgs;
    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 exampleDatabase = AivenFunctions.getMysqlDatabase(GetMysqlDatabaseArgs.builder()
                .project(exampleProject.project())
                .serviceName(exampleMysql.serviceName())
                .databaseName("example-database")
                .build());
    
        }
    }
    
    variables:
      exampleDatabase:
        fn::invoke:
          function: aiven:getMysqlDatabase
          arguments:
            project: ${exampleProject.project}
            serviceName: ${exampleMysql.serviceName}
            databaseName: example-database
    

    Using getMysqlDatabase

    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 getMysqlDatabase(args: GetMysqlDatabaseArgs, opts?: InvokeOptions): Promise<GetMysqlDatabaseResult>
    function getMysqlDatabaseOutput(args: GetMysqlDatabaseOutputArgs, opts?: InvokeOptions): Output<GetMysqlDatabaseResult>
    def get_mysql_database(database_name: Optional[str] = None,
                           project: Optional[str] = None,
                           service_name: Optional[str] = None,
                           timeouts: Optional[GetMysqlDatabaseTimeouts] = None,
                           opts: Optional[InvokeOptions] = None) -> GetMysqlDatabaseResult
    def get_mysql_database_output(database_name: Optional[pulumi.Input[str]] = None,
                           project: Optional[pulumi.Input[str]] = None,
                           service_name: Optional[pulumi.Input[str]] = None,
                           timeouts: Optional[pulumi.Input[GetMysqlDatabaseTimeoutsArgs]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetMysqlDatabaseResult]
    func LookupMysqlDatabase(ctx *Context, args *LookupMysqlDatabaseArgs, opts ...InvokeOption) (*LookupMysqlDatabaseResult, error)
    func LookupMysqlDatabaseOutput(ctx *Context, args *LookupMysqlDatabaseOutputArgs, opts ...InvokeOption) LookupMysqlDatabaseResultOutput

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

    public static class GetMysqlDatabase 
    {
        public static Task<GetMysqlDatabaseResult> InvokeAsync(GetMysqlDatabaseArgs args, InvokeOptions? opts = null)
        public static Output<GetMysqlDatabaseResult> Invoke(GetMysqlDatabaseInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMysqlDatabaseResult> getMysqlDatabase(GetMysqlDatabaseArgs args, InvokeOptions options)
    public static Output<GetMysqlDatabaseResult> getMysqlDatabase(GetMysqlDatabaseArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getMysqlDatabase:getMysqlDatabase
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    Service database name.
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetMysqlDatabaseTimeouts
    DatabaseName string
    Service database name.
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetMysqlDatabaseTimeouts
    databaseName String
    Service database name.
    project String
    Project name.
    serviceName String
    Service name.
    timeouts GetMysqlDatabaseTimeouts
    databaseName string
    Service database name.
    project string
    Project name.
    serviceName string
    Service name.
    timeouts GetMysqlDatabaseTimeouts
    database_name str
    Service database name.
    project str
    Project name.
    service_name str
    Service name.
    timeouts GetMysqlDatabaseTimeouts
    databaseName String
    Service database name.
    project String
    Project name.
    serviceName String
    Service name.
    timeouts Property Map

    getMysqlDatabase Result

    The following output properties are available:

    DatabaseName string
    Service database name.
    Id string
    Resource ID composed as: project/service_name/database_name.
    Project string
    Project name.
    ServiceName string
    Service name.
    TerminationProtection bool
    Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy

    Deprecated: Instead, use prevent_destroy

    Timeouts GetMysqlDatabaseTimeouts
    DatabaseName string
    Service database name.
    Id string
    Resource ID composed as: project/service_name/database_name.
    Project string
    Project name.
    ServiceName string
    Service name.
    TerminationProtection bool
    Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy

    Deprecated: Instead, use prevent_destroy

    Timeouts GetMysqlDatabaseTimeouts
    databaseName String
    Service database name.
    id String
    Resource ID composed as: project/service_name/database_name.
    project String
    Project name.
    serviceName String
    Service name.
    terminationProtection Boolean
    Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy

    Deprecated: Instead, use prevent_destroy

    timeouts GetMysqlDatabaseTimeouts
    databaseName string
    Service database name.
    id string
    Resource ID composed as: project/service_name/database_name.
    project string
    Project name.
    serviceName string
    Service name.
    terminationProtection boolean
    Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy

    Deprecated: Instead, use prevent_destroy

    timeouts GetMysqlDatabaseTimeouts
    database_name str
    Service database name.
    id str
    Resource ID composed as: project/service_name/database_name.
    project str
    Project name.
    service_name str
    Service name.
    termination_protection bool
    Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy

    Deprecated: Instead, use prevent_destroy

    timeouts GetMysqlDatabaseTimeouts
    databaseName String
    Service database name.
    id String
    Resource ID composed as: project/service_name/database_name.
    project String
    Project name.
    serviceName String
    Service name.
    terminationProtection Boolean
    Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use prevent_destroy

    Deprecated: Instead, use prevent_destroy

    timeouts Property Map

    Supporting Types

    GetMysqlDatabaseTimeouts

    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v6.51.0
    published on Tuesday, Mar 17, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.