Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. alloydb
  5. getSupportedDatabaseFlags
Google Cloud v8.19.1 published on Thursday, Feb 13, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.alloydb.getSupportedDatabaseFlags

Explore with Pulumi AI

gcp logo
Google Cloud v8.19.1 published on Thursday, Feb 13, 2025 by Pulumi
pulumi/pulumi-gcp

    Use this data source to get information about the supported alloydb database flags in a location.

    Example Usage

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

const qa = gcp.alloydb.getSupportedDatabaseFlags({
    location: "us-central1",
});

    import pulumi
import pulumi_gcp as gcp

qa = gcp.alloydb.get_supported_database_flags(location="us-central1")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/alloydb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := alloydb.GetSupportedDatabaseFlags(ctx, &alloydb.GetSupportedDatabaseFlagsArgs{
			Location: "us-central1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var qa = Gcp.Alloydb.GetSupportedDatabaseFlags.Invoke(new()
    {
        Location = "us-central1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.alloydb.AlloydbFunctions;
import com.pulumi.gcp.alloydb.inputs.GetSupportedDatabaseFlagsArgs;
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 qa = AlloydbFunctions.getSupportedDatabaseFlags(GetSupportedDatabaseFlagsArgs.builder()
            .location("us-central1")
            .build());

    }
}

    variables:
  qa:
    fn::invoke:
      function: gcp:alloydb:getSupportedDatabaseFlags
      arguments:
        location: us-central1

    Using getSupportedDatabaseFlags

    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 getSupportedDatabaseFlags(args: GetSupportedDatabaseFlagsArgs, opts?: InvokeOptions): Promise<GetSupportedDatabaseFlagsResult>
function getSupportedDatabaseFlagsOutput(args: GetSupportedDatabaseFlagsOutputArgs, opts?: InvokeOptions): Output<GetSupportedDatabaseFlagsResult>
    def get_supported_database_flags(location: Optional[str] = None,
                                 project: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetSupportedDatabaseFlagsResult
def get_supported_database_flags_output(location: Optional[pulumi.Input[str]] = None,
                                 project: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetSupportedDatabaseFlagsResult]
    func GetSupportedDatabaseFlags(ctx *Context, args *GetSupportedDatabaseFlagsArgs, opts ...InvokeOption) (*GetSupportedDatabaseFlagsResult, error)
func GetSupportedDatabaseFlagsOutput(ctx *Context, args *GetSupportedDatabaseFlagsOutputArgs, opts ...InvokeOption) GetSupportedDatabaseFlagsResultOutput

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

    public static class GetSupportedDatabaseFlags 
{
    public static Task<GetSupportedDatabaseFlagsResult> InvokeAsync(GetSupportedDatabaseFlagsArgs args, InvokeOptions? opts = null)
    public static Output<GetSupportedDatabaseFlagsResult> Invoke(GetSupportedDatabaseFlagsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSupportedDatabaseFlagsResult> getSupportedDatabaseFlags(GetSupportedDatabaseFlagsArgs args, InvokeOptions options)
public static Output<GetSupportedDatabaseFlagsResult> getSupportedDatabaseFlags(GetSupportedDatabaseFlagsArgs args, InvokeOptions options)

    fn::invoke:
  function: gcp:alloydb/getSupportedDatabaseFlags:getSupportedDatabaseFlags
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    The canonical id of the location. For example: us-east1.
    Project string
    The ID of the project.
    Location string
    The canonical id of the location. For example: us-east1.
    Project string
    The ID of the project.
    location String
    The canonical id of the location. For example: us-east1.
    project String
    The ID of the project.
    location string
    The canonical id of the location. For example: us-east1.
    project string
    The ID of the project.
    location str
    The canonical id of the location. For example: us-east1.
    project str
    The ID of the project.
    location String
    The canonical id of the location. For example: us-east1.
    project String
    The ID of the project.

    getSupportedDatabaseFlags Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    SupportedDatabaseFlags List<GetSupportedDatabaseFlagsSupportedDatabaseFlag>
    Contains a list of flag, which contains the details about a particular flag.
    Project string
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    SupportedDatabaseFlags []GetSupportedDatabaseFlagsSupportedDatabaseFlag
    Contains a list of flag, which contains the details about a particular flag.
    Project string
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    supportedDatabaseFlags List<GetSupportedDatabaseFlagsSupportedDatabaseFlag>
    Contains a list of flag, which contains the details about a particular flag.
    project String
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    supportedDatabaseFlags GetSupportedDatabaseFlagsSupportedDatabaseFlag[]
    Contains a list of flag, which contains the details about a particular flag.
    project string
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    supported_database_flags Sequence[GetSupportedDatabaseFlagsSupportedDatabaseFlag]
    Contains a list of flag, which contains the details about a particular flag.
    project str
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    supportedDatabaseFlags List<Property Map>
    Contains a list of flag, which contains the details about a particular flag.
    project String

    Supporting Types

    GetSupportedDatabaseFlagsSupportedDatabaseFlag

    AcceptsMultipleValues bool
    Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
    FlagName string
    The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.
    IntegerRestrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
    Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
    Name string
    The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
    RequiresDbRestart bool
    Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
    StringRestrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagStringRestrictions
    Restriction on STRING type value. The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    SupportedDbVersions List<string>
    Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
    ValueType string
    ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14". The supported values are VALUE_TYPE_UNSPECIFIED, STRING, INTEGER, FLOAT and NONE.
    AcceptsMultipleValues bool
    Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
    FlagName string
    The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.
    IntegerRestrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
    Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
    Name string
    The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
    RequiresDbRestart bool
    Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
    StringRestrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagStringRestrictions
    Restriction on STRING type value. The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    SupportedDbVersions []string
    Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
    ValueType string
    ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14". The supported values are VALUE_TYPE_UNSPECIFIED, STRING, INTEGER, FLOAT and NONE.
    acceptsMultipleValues Boolean
    Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
    flagName String
    The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.
    integerRestrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
    Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
    name String
    The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
    requiresDbRestart Boolean
    Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
    stringRestrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagStringRestrictions
    Restriction on STRING type value. The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    supportedDbVersions List<String>
    Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
    valueType String
    ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14". The supported values are VALUE_TYPE_UNSPECIFIED, STRING, INTEGER, FLOAT and NONE.
    acceptsMultipleValues boolean
    Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
    flagName string
    The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.
    integerRestrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
    Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
    name string
    The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
    requiresDbRestart boolean
    Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
    stringRestrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagStringRestrictions
    Restriction on STRING type value. The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    supportedDbVersions string[]
    Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
    valueType string
    ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14". The supported values are VALUE_TYPE_UNSPECIFIED, STRING, INTEGER, FLOAT and NONE.
    accepts_multiple_values bool
    Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
    flag_name str
    The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.
    integer_restrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
    Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
    name str
    The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
    requires_db_restart bool
    Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
    string_restrictions GetSupportedDatabaseFlagsSupportedDatabaseFlagStringRestrictions
    Restriction on STRING type value. The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    supported_db_versions Sequence[str]
    Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
    value_type str
    ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14". The supported values are VALUE_TYPE_UNSPECIFIED, STRING, INTEGER, FLOAT and NONE.
    acceptsMultipleValues Boolean
    Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
    flagName String
    The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.
    integerRestrictions Property Map
    Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
    name String
    The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
    requiresDbRestart Boolean
    Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
    stringRestrictions Property Map
    Restriction on STRING type value. The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    supportedDbVersions List<String>
    Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
    valueType String
    ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14". The supported values are VALUE_TYPE_UNSPECIFIED, STRING, INTEGER, FLOAT and NONE.

    GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions

    MaxValue string
    The maximum value that can be specified, if applicable.
    MinValue string
    The minimum value that can be specified, if applicable.
    MaxValue string
    The maximum value that can be specified, if applicable.
    MinValue string
    The minimum value that can be specified, if applicable.
    maxValue String
    The maximum value that can be specified, if applicable.
    minValue String
    The minimum value that can be specified, if applicable.
    maxValue string
    The maximum value that can be specified, if applicable.
    minValue string
    The minimum value that can be specified, if applicable.
    max_value str
    The maximum value that can be specified, if applicable.
    min_value str
    The minimum value that can be specified, if applicable.
    maxValue String
    The maximum value that can be specified, if applicable.
    minValue String
    The minimum value that can be specified, if applicable.

    GetSupportedDatabaseFlagsSupportedDatabaseFlagStringRestrictions

    AllowedValues List<string>
    The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    AllowedValues []string
    The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    allowedValues List<String>
    The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    allowedValues string[]
    The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    allowed_values Sequence[str]
    The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
    allowedValues List<String>
    The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.19.1 published on Thursday, Feb 13, 2025 by Pulumi
    pulumi/pulumi-gcp