Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getDatabase
Viewing docs for ibm 2.4.0
published on Wednesday, Jul 1, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getDatabase

Viewing docs for ibm 2.4.0
published on Wednesday, Jul 1, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Example Usage

    The following example retrieves information about the mydatabase instance in us-east.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const database = ibm.getDatabase({
    name: "mydatabase",
    location: "us-east",
});

    import pulumi
import pulumi_ibm as ibm

database = ibm.get_database(name="mydatabase",
    location="us-east")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupDatabase(ctx, &ibm.LookupDatabaseArgs{
			Name:     "mydatabase",
			Location: pulumi.StringRef("us-east"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var database = Ibm.GetDatabase.Invoke(new()
    {
        Name = "mydatabase",
        Location = "us-east",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDatabaseArgs;
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 = IbmFunctions.getDatabase(GetDatabaseArgs.builder()
            .name("mydatabase")
            .location("us-east")
            .build());

    }
}

    variables:
  database:
    fn::invoke:
      function: ibm:getDatabase
      arguments:
        name: mydatabase
        location: us-east

    Example coming soon!

    Gen2 Support

    This data source supports both Classic and Gen2 database instances. The backend is automatically selected based on the database plan.

    Gen2 Limitations

    The following attributes are not supported for Gen2 databases:

    • adminuser - Gen2 databases do not create a default admin user. Use ibm.ResourceKey to manage credentials.
    • adminpassword - Not available for Gen2 databases. Use ibm.ResourceKey to manage credentials.
    • users - User management is not supported. Use ibm.ResourceKey to manage credentials.
    • allowlist - IP allowlisting is not supported for Gen2 databases. Use Context-Based Restrictions (ibm.CbrRule) for IP allowlisting in Gen2.
    • auto_scaling - Auto-scaling configuration is not currently supported for Gen2 databases.
    • configuration_schema - Configuration schema is not available for Gen2 databases.
    • platform_options.backup_encryption_key_crn - Backup encryption key is not supported for Gen2 databases (only disk_encryption_key_crn is supported).

    Gen2 Example

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const postgresGen2 = ibm.getDatabase({
    name: "my-postgres-gen2",
    location: "us-south",
    service: "databases-for-postgresql",
});
// Use ibm_resource_key to manage credentials for Gen2 databases
const dbCredentials = new ibm.ResourceKey("db_credentials", {
    name: "my-db-credentials",
    resourceInstanceId: postgresGen2.then(postgresGen2 => postgresGen2.id),
    role: "Administrator",
});

    import pulumi
import pulumi_ibm as ibm

postgres_gen2 = ibm.get_database(name="my-postgres-gen2",
    location="us-south",
    service="databases-for-postgresql")
# Use ibm_resource_key to manage credentials for Gen2 databases
db_credentials = ibm.ResourceKey("db_credentials",
    name="my-db-credentials",
    resource_instance_id=postgres_gen2.id,
    role="Administrator")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		postgresGen2, err := ibm.LookupDatabase(ctx, &ibm.LookupDatabaseArgs{
			Name:     "my-postgres-gen2",
			Location: pulumi.StringRef("us-south"),
			Service:  pulumi.StringRef("databases-for-postgresql"),
		}, nil)
		if err != nil {
			return err
		}
		// Use ibm_resource_key to manage credentials for Gen2 databases
		_, err = ibm.NewResourceKey(ctx, "db_credentials", &ibm.ResourceKeyArgs{
			Name:               pulumi.String("my-db-credentials"),
			ResourceInstanceId: pulumi.String(postgresGen2.Id),
			Role:               pulumi.String("Administrator"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var postgresGen2 = Ibm.GetDatabase.Invoke(new()
    {
        Name = "my-postgres-gen2",
        Location = "us-south",
        Service = "databases-for-postgresql",
    });

    // Use ibm_resource_key to manage credentials for Gen2 databases
    var dbCredentials = new Ibm.ResourceKey("db_credentials", new()
    {
        Name = "my-db-credentials",
        ResourceInstanceId = postgresGen2.Apply(getDatabaseResult => getDatabaseResult.Id),
        Role = "Administrator",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDatabaseArgs;
import com.pulumi.ibm.ResourceKey;
import com.pulumi.ibm.ResourceKeyArgs;
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 postgresGen2 = IbmFunctions.getDatabase(GetDatabaseArgs.builder()
            .name("my-postgres-gen2")
            .location("us-south")
            .service("databases-for-postgresql")
            .build());

        // Use ibm_resource_key to manage credentials for Gen2 databases
        var dbCredentials = new ResourceKey("dbCredentials", ResourceKeyArgs.builder()
            .name("my-db-credentials")
            .resourceInstanceId(postgresGen2.id())
            .role("Administrator")
            .build());

    }
}

    resources:
  # Use ibm_resource_key to manage credentials for Gen2 databases
  dbCredentials:
    type: ibm:ResourceKey
    name: db_credentials
    properties:
      name: my-db-credentials
      resourceInstanceId: ${postgresGen2.id}
      role: Administrator
variables:
  postgresGen2:
    fn::invoke:
      function: ibm:getDatabase
      arguments:
        name: my-postgres-gen2
        location: us-south
        service: databases-for-postgresql

    Example coming soon!

    Using getDatabase

    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 getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>
    def get_database(id: Optional[str] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 resource_group_id: Optional[str] = None,
                 service: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(id: pulumi.Input[Optional[str]] = None,
                 location: pulumi.Input[Optional[str]] = None,
                 name: pulumi.Input[Optional[str]] = None,
                 resource_group_id: pulumi.Input[Optional[str]] = None,
                 service: pulumi.Input[Optional[str]] = None,
                 tags: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]
    func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

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

    public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getDatabase:getDatabase
  arguments:
    # arguments dictionary
    data "ibm_getdatabase" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Id string
    (String) The CRN of the IBM Cloud Databases instance.
    Location string
    The location where the IBM Cloud Databases instance is deployed into.
    ResourceGroupId string
    The ID of the resource group where the IBM Cloud Databases instance is deployed into. The default is default.
    Service string
    The service type of the instance. To retrieve this value, run ibmcloud catalog service-marketplace or ibmcloud catalog search.
    Tags List<string>
    Name string
    Id string
    (String) The CRN of the IBM Cloud Databases instance.
    Location string
    The location where the IBM Cloud Databases instance is deployed into.
    ResourceGroupId string
    The ID of the resource group where the IBM Cloud Databases instance is deployed into. The default is default.
    Service string
    The service type of the instance. To retrieve this value, run ibmcloud catalog service-marketplace or ibmcloud catalog search.
    Tags []string
    name string
    id string
    (String) The CRN of the IBM Cloud Databases instance.
    location string
    The location where the IBM Cloud Databases instance is deployed into.
    resource_group_id string
    The ID of the resource group where the IBM Cloud Databases instance is deployed into. The default is default.
    service string
    The service type of the instance. To retrieve this value, run ibmcloud catalog service-marketplace or ibmcloud catalog search.
    tags list(string)
    name String
    id String
    (String) The CRN of the IBM Cloud Databases instance.
    location String
    The location where the IBM Cloud Databases instance is deployed into.
    resourceGroupId String
    The ID of the resource group where the IBM Cloud Databases instance is deployed into. The default is default.
    service String
    The service type of the instance. To retrieve this value, run ibmcloud catalog service-marketplace or ibmcloud catalog search.
    tags List<String>
    name string
    id string
    (String) The CRN of the IBM Cloud Databases instance.
    location string
    The location where the IBM Cloud Databases instance is deployed into.
    resourceGroupId string
    The ID of the resource group where the IBM Cloud Databases instance is deployed into. The default is default.
    service string
    The service type of the instance. To retrieve this value, run ibmcloud catalog service-marketplace or ibmcloud catalog search.
    tags string[]
    name str
    id str
    (String) The CRN of the IBM Cloud Databases instance.
    location str
    The location where the IBM Cloud Databases instance is deployed into.
    resource_group_id str
    The ID of the resource group where the IBM Cloud Databases instance is deployed into. The default is default.
    service str
    The service type of the instance. To retrieve this value, run ibmcloud catalog service-marketplace or ibmcloud catalog search.
    tags Sequence[str]
    name String
    id String
    (String) The CRN of the IBM Cloud Databases instance.
    location String
    The location where the IBM Cloud Databases instance is deployed into.
    resourceGroupId String
    The ID of the resource group where the IBM Cloud Databases instance is deployed into. The default is default.
    service String
    The service type of the instance. To retrieve this value, run ibmcloud catalog service-marketplace or ibmcloud catalog search.
    tags List<String>

    getDatabase Result

    The following output properties are available:

    Adminpassword string
    Adminuser string
    (String) The user ID of the default administration user for the database, such as admin or root.
    Allowlists List<GetDatabaseAllowlist>
    (List) A list of allowed IP addresses or ranges.
    AutoScalings List<GetDatabaseAutoScaling>
    (List)Configure rules to allow your database to automatically increase its resources. Single block of autoscaling is allowed at once.
    ConfigurationSchema string
    (String) Database Configuration Schema in JSON format.
    Groups List<GetDatabaseGroup>
    Guid string
    (String) The unique identifier of the IBM Cloud Databases instance.
    Id string
    (String) The CRN of the IBM Cloud Databases instance.
    Name string
    Plan string
    (String) The service plan of the IBM Cloud Databases instance.
    PlatformOptions List<GetDatabasePlatformOption>
    (String) The CRN of key protect key.
    ResourceControllerUrl string
    ResourceCrn string
    ResourceGroupName string
    ResourceName string
    ResourceStatus string
    Status string
    (String) The status of the IBM Cloud Databases instance.
    Users List<GetDatabaseUser>
    (List) A list of users configured for the database.
    Version string
    (String) The database version.
    Location string
    (String) The location where the IBM Cloud Databases instance is deployed into.
    ResourceGroupId string
    Service string
    Tags List<string>
    Adminpassword string
    Adminuser string
    (String) The user ID of the default administration user for the database, such as admin or root.
    Allowlists []GetDatabaseAllowlist
    (List) A list of allowed IP addresses or ranges.
    AutoScalings []GetDatabaseAutoScaling
    (List)Configure rules to allow your database to automatically increase its resources. Single block of autoscaling is allowed at once.
    ConfigurationSchema string
    (String) Database Configuration Schema in JSON format.
    Groups []GetDatabaseGroup
    Guid string
    (String) The unique identifier of the IBM Cloud Databases instance.
    Id string
    (String) The CRN of the IBM Cloud Databases instance.
    Name string
    Plan string
    (String) The service plan of the IBM Cloud Databases instance.
    PlatformOptions []GetDatabasePlatformOption
    (String) The CRN of key protect key.
    ResourceControllerUrl string
    ResourceCrn string
    ResourceGroupName string
    ResourceName string
    ResourceStatus string
    Status string
    (String) The status of the IBM Cloud Databases instance.
    Users []GetDatabaseUser
    (List) A list of users configured for the database.
    Version string
    (String) The database version.
    Location string
    (String) The location where the IBM Cloud Databases instance is deployed into.
    ResourceGroupId string
    Service string
    Tags []string
    adminpassword string
    adminuser string
    (String) The user ID of the default administration user for the database, such as admin or root.
    allowlists list(object)
    (List) A list of allowed IP addresses or ranges.
    auto_scalings list(object)
    (List)Configure rules to allow your database to automatically increase its resources. Single block of autoscaling is allowed at once.
    configuration_schema string
    (String) Database Configuration Schema in JSON format.
    groups list(object)
    guid string
    (String) The unique identifier of the IBM Cloud Databases instance.
    id string
    (String) The CRN of the IBM Cloud Databases instance.
    name string
    plan string
    (String) The service plan of the IBM Cloud Databases instance.
    platform_options list(object)
    (String) The CRN of key protect key.
    resource_controller_url string
    resource_crn string
    resource_group_name string
    resource_name string
    resource_status string
    status string
    (String) The status of the IBM Cloud Databases instance.
    users list(object)
    (List) A list of users configured for the database.
    version string
    (String) The database version.
    location string
    (String) The location where the IBM Cloud Databases instance is deployed into.
    resource_group_id string
    service string
    tags list(string)
    adminpassword String
    adminuser String
    (String) The user ID of the default administration user for the database, such as admin or root.
    allowlists List<GetDatabaseAllowlist>
    (List) A list of allowed IP addresses or ranges.
    autoScalings List<GetDatabaseAutoScaling>
    (List)Configure rules to allow your database to automatically increase its resources. Single block of autoscaling is allowed at once.
    configurationSchema String
    (String) Database Configuration Schema in JSON format.
    groups List<GetDatabaseGroup>
    guid String
    (String) The unique identifier of the IBM Cloud Databases instance.
    id String
    (String) The CRN of the IBM Cloud Databases instance.
    name String
    plan String
    (String) The service plan of the IBM Cloud Databases instance.
    platformOptions List<GetDatabasePlatformOption>
    (String) The CRN of key protect key.
    resourceControllerUrl String
    resourceCrn String
    resourceGroupName String
    resourceName String
    resourceStatus String
    status String
    (String) The status of the IBM Cloud Databases instance.
    users List<GetDatabaseUser>
    (List) A list of users configured for the database.
    version String
    (String) The database version.
    location String
    (String) The location where the IBM Cloud Databases instance is deployed into.
    resourceGroupId String
    service String
    tags List<String>
    adminpassword string
    adminuser string
    (String) The user ID of the default administration user for the database, such as admin or root.
    allowlists GetDatabaseAllowlist[]
    (List) A list of allowed IP addresses or ranges.
    autoScalings GetDatabaseAutoScaling[]
    (List)Configure rules to allow your database to automatically increase its resources. Single block of autoscaling is allowed at once.
    configurationSchema string
    (String) Database Configuration Schema in JSON format.
    groups GetDatabaseGroup[]
    guid string
    (String) The unique identifier of the IBM Cloud Databases instance.
    id string
    (String) The CRN of the IBM Cloud Databases instance.
    name string
    plan string
    (String) The service plan of the IBM Cloud Databases instance.
    platformOptions GetDatabasePlatformOption[]
    (String) The CRN of key protect key.
    resourceControllerUrl string
    resourceCrn string
    resourceGroupName string
    resourceName string
    resourceStatus string
    status string
    (String) The status of the IBM Cloud Databases instance.
    users GetDatabaseUser[]
    (List) A list of users configured for the database.
    version string
    (String) The database version.
    location string
    (String) The location where the IBM Cloud Databases instance is deployed into.
    resourceGroupId string
    service string
    tags string[]
    adminpassword str
    adminuser str
    (String) The user ID of the default administration user for the database, such as admin or root.
    allowlists Sequence[GetDatabaseAllowlist]
    (List) A list of allowed IP addresses or ranges.
    auto_scalings Sequence[GetDatabaseAutoScaling]
    (List)Configure rules to allow your database to automatically increase its resources. Single block of autoscaling is allowed at once.
    configuration_schema str
    (String) Database Configuration Schema in JSON format.
    groups Sequence[GetDatabaseGroup]
    guid str
    (String) The unique identifier of the IBM Cloud Databases instance.
    id str
    (String) The CRN of the IBM Cloud Databases instance.
    name str
    plan str
    (String) The service plan of the IBM Cloud Databases instance.
    platform_options Sequence[GetDatabasePlatformOption]
    (String) The CRN of key protect key.
    resource_controller_url str
    resource_crn str
    resource_group_name str
    resource_name str
    resource_status str
    status str
    (String) The status of the IBM Cloud Databases instance.
    users Sequence[GetDatabaseUser]
    (List) A list of users configured for the database.
    version str
    (String) The database version.
    location str
    (String) The location where the IBM Cloud Databases instance is deployed into.
    resource_group_id str
    service str
    tags Sequence[str]
    adminpassword String
    adminuser String
    (String) The user ID of the default administration user for the database, such as admin or root.
    allowlists List<Property Map>
    (List) A list of allowed IP addresses or ranges.
    autoScalings List<Property Map>
    (List)Configure rules to allow your database to automatically increase its resources. Single block of autoscaling is allowed at once.
    configurationSchema String
    (String) Database Configuration Schema in JSON format.
    groups List<Property Map>
    guid String
    (String) The unique identifier of the IBM Cloud Databases instance.
    id String
    (String) The CRN of the IBM Cloud Databases instance.
    name String
    plan String
    (String) The service plan of the IBM Cloud Databases instance.
    platformOptions List<Property Map>
    (String) The CRN of key protect key.
    resourceControllerUrl String
    resourceCrn String
    resourceGroupName String
    resourceName String
    resourceStatus String
    status String
    (String) The status of the IBM Cloud Databases instance.
    users List<Property Map>
    (List) A list of users configured for the database.
    version String
    (String) The database version.
    location String
    (String) The location where the IBM Cloud Databases instance is deployed into.
    resourceGroupId String
    service String
    tags List<String>

    Supporting Types

    GetDatabaseAllowlist

    Address string
    Description string
    Address string
    Description string
    address string
    description string
    address String
    description String
    address string
    description string
    address String
    description String

    GetDatabaseAutoScaling

    cpus list(object)
    disks list(object)
    (List) Disk auto scaling.
    memories list(object)
    (List) Memory Auto Scaling.
    cpus List<Property Map>
    disks List<Property Map>
    (List) Disk auto scaling.
    memories List<Property Map>
    (List) Memory Auto Scaling.

    GetDatabaseAutoScalingCpus

    RateIncreasePercent double
    (Integer) Auto scaling rate in increase percent.
    RateLimitCountPerMember double
    RateLimitMbPerMember double
    (Integer) Auto scaling rate limit in megabytes per member.
    RatePeriodSeconds double
    (Integer) Auto scaling rate period in seconds.
    RateUnits string
    (String) Auto scaling rate in units.
    RateIncreasePercent float64
    (Integer) Auto scaling rate in increase percent.
    RateLimitCountPerMember float64
    RateLimitMbPerMember float64
    (Integer) Auto scaling rate limit in megabytes per member.
    RatePeriodSeconds float64
    (Integer) Auto scaling rate period in seconds.
    RateUnits string
    (String) Auto scaling rate in units.
    rate_increase_percent number
    (Integer) Auto scaling rate in increase percent.
    rate_limit_count_per_member number
    rate_limit_mb_per_member number
    (Integer) Auto scaling rate limit in megabytes per member.
    rate_period_seconds number
    (Integer) Auto scaling rate period in seconds.
    rate_units string
    (String) Auto scaling rate in units.
    rateIncreasePercent Double
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember Double
    rateLimitMbPerMember Double
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds Double
    (Integer) Auto scaling rate period in seconds.
    rateUnits String
    (String) Auto scaling rate in units.
    rateIncreasePercent number
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember number
    rateLimitMbPerMember number
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds number
    (Integer) Auto scaling rate period in seconds.
    rateUnits string
    (String) Auto scaling rate in units.
    rate_increase_percent float
    (Integer) Auto scaling rate in increase percent.
    rate_limit_count_per_member float
    rate_limit_mb_per_member float
    (Integer) Auto scaling rate limit in megabytes per member.
    rate_period_seconds float
    (Integer) Auto scaling rate period in seconds.
    rate_units str
    (String) Auto scaling rate in units.
    rateIncreasePercent Number
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember Number
    rateLimitMbPerMember Number
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds Number
    (Integer) Auto scaling rate period in seconds.
    rateUnits String
    (String) Auto scaling rate in units.

    GetDatabaseAutoScalingDisk

    CapacityEnabled bool
    (Boolean) Auto scaling scalar enables or disables the scalar capacity.
    FreeSpaceLessThanPercent double
    (Integer) Auto scaling scalar capacity free space less than percent.
    FreeSpaceRemainingPercent double
    IoAbovePercent double
    (Integer) Auto scaling scalar I/O utilization above percent.
    IoEnabled bool
    (Boolean) Auto scaling scalar I/O utilization enabled.
    IoOverPeriod string
    (String) Auto scaling scalar I/O utilization over period.
    RateIncreasePercent double
    (Integer) Auto scaling rate in increase percent.
    RateLimitCountPerMember double
    RateLimitMbPerMember double
    (Integer) Auto scaling rate limit in megabytes per member.
    RatePeriodSeconds double
    (Integer) Auto scaling rate period in seconds.
    RateUnits string
    (String) Auto scaling rate in units.
    CapacityEnabled bool
    (Boolean) Auto scaling scalar enables or disables the scalar capacity.
    FreeSpaceLessThanPercent float64
    (Integer) Auto scaling scalar capacity free space less than percent.
    FreeSpaceRemainingPercent float64
    IoAbovePercent float64
    (Integer) Auto scaling scalar I/O utilization above percent.
    IoEnabled bool
    (Boolean) Auto scaling scalar I/O utilization enabled.
    IoOverPeriod string
    (String) Auto scaling scalar I/O utilization over period.
    RateIncreasePercent float64
    (Integer) Auto scaling rate in increase percent.
    RateLimitCountPerMember float64
    RateLimitMbPerMember float64
    (Integer) Auto scaling rate limit in megabytes per member.
    RatePeriodSeconds float64
    (Integer) Auto scaling rate period in seconds.
    RateUnits string
    (String) Auto scaling rate in units.
    capacity_enabled bool
    (Boolean) Auto scaling scalar enables or disables the scalar capacity.
    free_space_less_than_percent number
    (Integer) Auto scaling scalar capacity free space less than percent.
    free_space_remaining_percent number
    io_above_percent number
    (Integer) Auto scaling scalar I/O utilization above percent.
    io_enabled bool
    (Boolean) Auto scaling scalar I/O utilization enabled.
    io_over_period string
    (String) Auto scaling scalar I/O utilization over period.
    rate_increase_percent number
    (Integer) Auto scaling rate in increase percent.
    rate_limit_count_per_member number
    rate_limit_mb_per_member number
    (Integer) Auto scaling rate limit in megabytes per member.
    rate_period_seconds number
    (Integer) Auto scaling rate period in seconds.
    rate_units string
    (String) Auto scaling rate in units.
    capacityEnabled Boolean
    (Boolean) Auto scaling scalar enables or disables the scalar capacity.
    freeSpaceLessThanPercent Double
    (Integer) Auto scaling scalar capacity free space less than percent.
    freeSpaceRemainingPercent Double
    ioAbovePercent Double
    (Integer) Auto scaling scalar I/O utilization above percent.
    ioEnabled Boolean
    (Boolean) Auto scaling scalar I/O utilization enabled.
    ioOverPeriod String
    (String) Auto scaling scalar I/O utilization over period.
    rateIncreasePercent Double
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember Double
    rateLimitMbPerMember Double
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds Double
    (Integer) Auto scaling rate period in seconds.
    rateUnits String
    (String) Auto scaling rate in units.
    capacityEnabled boolean
    (Boolean) Auto scaling scalar enables or disables the scalar capacity.
    freeSpaceLessThanPercent number
    (Integer) Auto scaling scalar capacity free space less than percent.
    freeSpaceRemainingPercent number
    ioAbovePercent number
    (Integer) Auto scaling scalar I/O utilization above percent.
    ioEnabled boolean
    (Boolean) Auto scaling scalar I/O utilization enabled.
    ioOverPeriod string
    (String) Auto scaling scalar I/O utilization over period.
    rateIncreasePercent number
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember number
    rateLimitMbPerMember number
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds number
    (Integer) Auto scaling rate period in seconds.
    rateUnits string
    (String) Auto scaling rate in units.
    capacity_enabled bool
    (Boolean) Auto scaling scalar enables or disables the scalar capacity.
    free_space_less_than_percent float
    (Integer) Auto scaling scalar capacity free space less than percent.
    free_space_remaining_percent float
    io_above_percent float
    (Integer) Auto scaling scalar I/O utilization above percent.
    io_enabled bool
    (Boolean) Auto scaling scalar I/O utilization enabled.
    io_over_period str
    (String) Auto scaling scalar I/O utilization over period.
    rate_increase_percent float
    (Integer) Auto scaling rate in increase percent.
    rate_limit_count_per_member float
    rate_limit_mb_per_member float
    (Integer) Auto scaling rate limit in megabytes per member.
    rate_period_seconds float
    (Integer) Auto scaling rate period in seconds.
    rate_units str
    (String) Auto scaling rate in units.
    capacityEnabled Boolean
    (Boolean) Auto scaling scalar enables or disables the scalar capacity.
    freeSpaceLessThanPercent Number
    (Integer) Auto scaling scalar capacity free space less than percent.
    freeSpaceRemainingPercent Number
    ioAbovePercent Number
    (Integer) Auto scaling scalar I/O utilization above percent.
    ioEnabled Boolean
    (Boolean) Auto scaling scalar I/O utilization enabled.
    ioOverPeriod String
    (String) Auto scaling scalar I/O utilization over period.
    rateIncreasePercent Number
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember Number
    rateLimitMbPerMember Number
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds Number
    (Integer) Auto scaling rate period in seconds.
    rateUnits String
    (String) Auto scaling rate in units.

    GetDatabaseAutoScalingMemory

    IoAbovePercent double
    (Integer) Auto scaling scalar I/O utilization above percent.
    IoEnabled bool
    (Boolean) Auto scaling scalar I/O utilization enabled.
    IoOverPeriod string
    (String) Auto scaling scalar I/O utilization over period.
    RateIncreasePercent double
    (Integer) Auto scaling rate in increase percent.
    RateLimitCountPerMember double
    RateLimitMbPerMember double
    (Integer) Auto scaling rate limit in megabytes per member.
    RatePeriodSeconds double
    (Integer) Auto scaling rate period in seconds.
    RateUnits string
    (String) Auto scaling rate in units.
    IoAbovePercent float64
    (Integer) Auto scaling scalar I/O utilization above percent.
    IoEnabled bool
    (Boolean) Auto scaling scalar I/O utilization enabled.
    IoOverPeriod string
    (String) Auto scaling scalar I/O utilization over period.
    RateIncreasePercent float64
    (Integer) Auto scaling rate in increase percent.
    RateLimitCountPerMember float64
    RateLimitMbPerMember float64
    (Integer) Auto scaling rate limit in megabytes per member.
    RatePeriodSeconds float64
    (Integer) Auto scaling rate period in seconds.
    RateUnits string
    (String) Auto scaling rate in units.
    io_above_percent number
    (Integer) Auto scaling scalar I/O utilization above percent.
    io_enabled bool
    (Boolean) Auto scaling scalar I/O utilization enabled.
    io_over_period string
    (String) Auto scaling scalar I/O utilization over period.
    rate_increase_percent number
    (Integer) Auto scaling rate in increase percent.
    rate_limit_count_per_member number
    rate_limit_mb_per_member number
    (Integer) Auto scaling rate limit in megabytes per member.
    rate_period_seconds number
    (Integer) Auto scaling rate period in seconds.
    rate_units string
    (String) Auto scaling rate in units.
    ioAbovePercent Double
    (Integer) Auto scaling scalar I/O utilization above percent.
    ioEnabled Boolean
    (Boolean) Auto scaling scalar I/O utilization enabled.
    ioOverPeriod String
    (String) Auto scaling scalar I/O utilization over period.
    rateIncreasePercent Double
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember Double
    rateLimitMbPerMember Double
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds Double
    (Integer) Auto scaling rate period in seconds.
    rateUnits String
    (String) Auto scaling rate in units.
    ioAbovePercent number
    (Integer) Auto scaling scalar I/O utilization above percent.
    ioEnabled boolean
    (Boolean) Auto scaling scalar I/O utilization enabled.
    ioOverPeriod string
    (String) Auto scaling scalar I/O utilization over period.
    rateIncreasePercent number
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember number
    rateLimitMbPerMember number
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds number
    (Integer) Auto scaling rate period in seconds.
    rateUnits string
    (String) Auto scaling rate in units.
    io_above_percent float
    (Integer) Auto scaling scalar I/O utilization above percent.
    io_enabled bool
    (Boolean) Auto scaling scalar I/O utilization enabled.
    io_over_period str
    (String) Auto scaling scalar I/O utilization over period.
    rate_increase_percent float
    (Integer) Auto scaling rate in increase percent.
    rate_limit_count_per_member float
    rate_limit_mb_per_member float
    (Integer) Auto scaling rate limit in megabytes per member.
    rate_period_seconds float
    (Integer) Auto scaling rate period in seconds.
    rate_units str
    (String) Auto scaling rate in units.
    ioAbovePercent Number
    (Integer) Auto scaling scalar I/O utilization above percent.
    ioEnabled Boolean
    (Boolean) Auto scaling scalar I/O utilization enabled.
    ioOverPeriod String
    (String) Auto scaling scalar I/O utilization over period.
    rateIncreasePercent Number
    (Integer) Auto scaling rate in increase percent.
    rateLimitCountPerMember Number
    rateLimitMbPerMember Number
    (Integer) Auto scaling rate limit in megabytes per member.
    ratePeriodSeconds Number
    (Integer) Auto scaling rate period in seconds.
    rateUnits String
    (String) Auto scaling rate in units.

    GetDatabaseGroup

    count number
    cpus list(object)
    disks list(object)
    (List) Disk auto scaling.
    group_id string
    host_flavors list(object)
    memories list(object)
    (List) Memory Auto Scaling.

    GetDatabaseGroupCpus

    GetDatabaseGroupDisk

    AllocationMb float64
    CanScaleDown bool
    IsAdjustable bool
    MinimumMb float64
    StepSizeMb float64
    Units string
    allocationMb Double
    canScaleDown Boolean
    isAdjustable Boolean
    minimumMb Double
    stepSizeMb Double
    units String
    allocationMb number
    canScaleDown boolean
    isAdjustable boolean
    minimumMb number
    stepSizeMb number
    units string
    allocationMb Number
    canScaleDown Boolean
    isAdjustable Boolean
    minimumMb Number
    stepSizeMb Number
    units String

    GetDatabaseGroupHostFlavor

    HostingSize string
    Id string
    (String) The CRN of the IBM Cloud Databases instance.
    Name string
    HostingSize string
    Id string
    (String) The CRN of the IBM Cloud Databases instance.
    Name string
    hosting_size string
    id string
    (String) The CRN of the IBM Cloud Databases instance.
    name string
    hostingSize String
    id String
    (String) The CRN of the IBM Cloud Databases instance.
    name String
    hostingSize string
    id string
    (String) The CRN of the IBM Cloud Databases instance.
    name string
    hosting_size str
    id str
    (String) The CRN of the IBM Cloud Databases instance.
    name str
    hostingSize String
    id String
    (String) The CRN of the IBM Cloud Databases instance.
    name String

    GetDatabaseGroupMemory

    AllocationMb float64
    CanScaleDown bool
    IsAdjustable bool
    MinimumMb float64
    StepSizeMb float64
    Units string
    allocationMb Double
    canScaleDown Boolean
    isAdjustable Boolean
    minimumMb Double
    stepSizeMb Double
    units String
    allocationMb number
    canScaleDown boolean
    isAdjustable boolean
    minimumMb number
    stepSizeMb number
    units string
    allocationMb Number
    canScaleDown Boolean
    isAdjustable Boolean
    minimumMb Number
    stepSizeMb Number
    units String

    GetDatabasePlatformOption

    BackupEncryptionKeyCrn string
    (String) The CRN of backup encryption key.
    DiskEncryptionKeyCrn string
    (String) The CRN of disk encryption key.
    BackupEncryptionKeyCrn string
    (String) The CRN of backup encryption key.
    DiskEncryptionKeyCrn string
    (String) The CRN of disk encryption key.
    backup_encryption_key_crn string
    (String) The CRN of backup encryption key.
    disk_encryption_key_crn string
    (String) The CRN of disk encryption key.
    backupEncryptionKeyCrn String
    (String) The CRN of backup encryption key.
    diskEncryptionKeyCrn String
    (String) The CRN of disk encryption key.
    backupEncryptionKeyCrn string
    (String) The CRN of backup encryption key.
    diskEncryptionKeyCrn string
    (String) The CRN of disk encryption key.
    backup_encryption_key_crn str
    (String) The CRN of backup encryption key.
    disk_encryption_key_crn str
    (String) The CRN of disk encryption key.
    backupEncryptionKeyCrn String
    (String) The CRN of backup encryption key.
    diskEncryptionKeyCrn String
    (String) The CRN of disk encryption key.

    GetDatabaseUser

    Name string
    Password string
    Name string
    Password string
    name string
    password string
    name String
    password String
    name string
    password string
    name str
    password str
    name String
    password String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    Viewing docs for ibm 2.4.0
    published on Wednesday, Jul 1, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial