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

gcp.alloydb.getSupportedDatabaseFlags

Explore with Pulumi AI

Google Cloud v8.27.0 published on Thursday, Apr 17, 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",
});
Copy
import pulumi
import pulumi_gcp as gcp

qa = gcp.alloydb.get_supported_database_flags(location="us-central1")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func GetSupportedDatabaseFlags(ctx *Context, args *GetSupportedDatabaseFlagsArgs, opts ...InvokeOption) (*GetSupportedDatabaseFlagsResult, error)
func GetSupportedDatabaseFlagsOutput(ctx *Context, args *GetSupportedDatabaseFlagsOutputArgs, opts ...InvokeOption) GetSupportedDatabaseFlagsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetSupportedDatabaseFlagsResult> getSupportedDatabaseFlags(GetSupportedDatabaseFlagsArgs args, InvokeOptions options)
public static Output<GetSupportedDatabaseFlagsResult> getSupportedDatabaseFlags(GetSupportedDatabaseFlagsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcp:alloydb/getSupportedDatabaseFlags:getSupportedDatabaseFlags
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
The canonical id of the location. For example: us-east1.
Project string
The ID of the project.
Location This property is required. string
The canonical id of the location. For example: us-east1.
Project string
The ID of the project.
location This property is required. String
The canonical id of the location. For example: us-east1.
project String
The ID of the project.
location This property is required. string
The canonical id of the location. For example: us-east1.
project string
The ID of the project.
location This property is required. str
The canonical id of the location. For example: us-east1.
project str
The ID of the project.
location This property is required. 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 This property is required. bool
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
FlagName This property is required. 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 This property is required. GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. List<string>
Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
ValueType This property is required. 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 This property is required. bool
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
FlagName This property is required. 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 This property is required. GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. []string
Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
ValueType This property is required. 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 This property is required. Boolean
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
flagName This property is required. 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 This property is required. GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. List<String>
Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
valueType This property is required. 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 This property is required. boolean
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
flagName This property is required. 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 This property is required. GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string[]
Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
valueType This property is required. 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 This property is required. bool
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
flag_name This property is required. 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 This property is required. GetSupportedDatabaseFlagsSupportedDatabaseFlagIntegerRestrictions
Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. Sequence[str]
Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
value_type This property is required. 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 This property is required. Boolean
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
flagName This property is required. 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 This property is required. Property Map
Restriction on INTEGER type value. Specifies the minimum value and the maximum value that can be specified, if applicable.
name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. List<String>
Major database engine versions for which this flag is supported. The supported values are POSTGRES_14 and DATABASE_VERSION_UNSPECIFIED.
valueType This property is required. 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 This property is required. string
The maximum value that can be specified, if applicable.
MinValue This property is required. string
The minimum value that can be specified, if applicable.
MaxValue This property is required. string
The maximum value that can be specified, if applicable.
MinValue This property is required. string
The minimum value that can be specified, if applicable.
maxValue This property is required. String
The maximum value that can be specified, if applicable.
minValue This property is required. String
The minimum value that can be specified, if applicable.
maxValue This property is required. string
The maximum value that can be specified, if applicable.
minValue This property is required. string
The minimum value that can be specified, if applicable.
max_value This property is required. str
The maximum value that can be specified, if applicable.
min_value This property is required. str
The minimum value that can be specified, if applicable.
maxValue This property is required. String
The maximum value that can be specified, if applicable.
minValue This property is required. String
The minimum value that can be specified, if applicable.

GetSupportedDatabaseFlagsSupportedDatabaseFlagStringRestrictions

AllowedValues This property is required. List<string>
The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
AllowedValues This property is required. []string
The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
allowedValues This property is required. List<String>
The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
allowedValues This property is required. string[]
The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
allowed_values This property is required. Sequence[str]
The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
allowedValues This property is required. 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.
Google Cloud v8.27.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-gcp