1. Packages
  2. Vkcs Provider
  3. API Docs
  4. getDbDatastoreCapabilities
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.getDbDatastoreCapabilities

Explore with Pulumi AI

vkcs logo
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

    Use this data source to get capabilities supported for a VKCS datastore.

    New since v0.2.0.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vkcs from "@pulumi/vkcs";
    
    const postgresCaps = vkcs.getDbDatastoreCapabilities({
        datastoreName: data.vkcs_db_datastore.postgres,
        datastoreVersionId: local.pg_v14_version_id,
    });
    export const postgresqlCapabilities = postgresCaps.then(postgresCaps => postgresCaps.capabilities);
    
    import pulumi
    import pulumi_vkcs as vkcs
    
    postgres_caps = vkcs.get_db_datastore_capabilities(datastore_name=data["vkcs_db_datastore"]["postgres"],
        datastore_version_id=local["pg_v14_version_id"])
    pulumi.export("postgresqlCapabilities", postgres_caps.capabilities)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		postgresCaps, err := vkcs.GetDbDatastoreCapabilities(ctx, &vkcs.GetDbDatastoreCapabilitiesArgs{
    			DatastoreName:      data.Vkcs_db_datastore.Postgres,
    			DatastoreVersionId: local.Pg_v14_version_id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("postgresqlCapabilities", postgresCaps.Capabilities)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vkcs = Pulumi.Vkcs;
    
    return await Deployment.RunAsync(() => 
    {
        var postgresCaps = Vkcs.GetDbDatastoreCapabilities.Invoke(new()
        {
            DatastoreName = data.Vkcs_db_datastore.Postgres,
            DatastoreVersionId = local.Pg_v14_version_id,
        });
    
        return new Dictionary<string, object?>
        {
            ["postgresqlCapabilities"] = postgresCaps.Apply(getDbDatastoreCapabilitiesResult => getDbDatastoreCapabilitiesResult.Capabilities),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vkcs.VkcsFunctions;
    import com.pulumi.vkcs.inputs.GetDbDatastoreCapabilitiesArgs;
    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 postgresCaps = VkcsFunctions.getDbDatastoreCapabilities(GetDbDatastoreCapabilitiesArgs.builder()
                .datastoreName(data.vkcs_db_datastore().postgres())
                .datastoreVersionId(local.pg_v14_version_id())
                .build());
    
            ctx.export("postgresqlCapabilities", postgresCaps.applyValue(getDbDatastoreCapabilitiesResult -> getDbDatastoreCapabilitiesResult.capabilities()));
        }
    }
    
    variables:
      postgresCaps:
        fn::invoke:
          function: vkcs:getDbDatastoreCapabilities
          arguments:
            datastoreName: ${data.vkcs_db_datastore.postgres}
            datastoreVersionId: ${local.pg_v14_version_id}
    outputs:
      postgresqlCapabilities: ${postgresCaps.capabilities}
    

    Using getDbDatastoreCapabilities

    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 getDbDatastoreCapabilities(args: GetDbDatastoreCapabilitiesArgs, opts?: InvokeOptions): Promise<GetDbDatastoreCapabilitiesResult>
    function getDbDatastoreCapabilitiesOutput(args: GetDbDatastoreCapabilitiesOutputArgs, opts?: InvokeOptions): Output<GetDbDatastoreCapabilitiesResult>
    def get_db_datastore_capabilities(datastore_name: Optional[str] = None,
                                      datastore_version_id: Optional[str] = None,
                                      region: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetDbDatastoreCapabilitiesResult
    def get_db_datastore_capabilities_output(datastore_name: Optional[pulumi.Input[str]] = None,
                                      datastore_version_id: Optional[pulumi.Input[str]] = None,
                                      region: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetDbDatastoreCapabilitiesResult]
    func GetDbDatastoreCapabilities(ctx *Context, args *GetDbDatastoreCapabilitiesArgs, opts ...InvokeOption) (*GetDbDatastoreCapabilitiesResult, error)
    func GetDbDatastoreCapabilitiesOutput(ctx *Context, args *GetDbDatastoreCapabilitiesOutputArgs, opts ...InvokeOption) GetDbDatastoreCapabilitiesResultOutput

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

    public static class GetDbDatastoreCapabilities 
    {
        public static Task<GetDbDatastoreCapabilitiesResult> InvokeAsync(GetDbDatastoreCapabilitiesArgs args, InvokeOptions? opts = null)
        public static Output<GetDbDatastoreCapabilitiesResult> Invoke(GetDbDatastoreCapabilitiesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDbDatastoreCapabilitiesResult> getDbDatastoreCapabilities(GetDbDatastoreCapabilitiesArgs args, InvokeOptions options)
    public static Output<GetDbDatastoreCapabilitiesResult> getDbDatastoreCapabilities(GetDbDatastoreCapabilitiesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vkcs:index/getDbDatastoreCapabilities:getDbDatastoreCapabilities
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatastoreName string
    required string → Name of the data store.
    DatastoreVersionId string
    required string → ID of the version of the data store.
    Region string
    optional string → The region to fetch availability zones from, defaults to the provider's region.
    DatastoreName string
    required string → Name of the data store.
    DatastoreVersionId string
    required string → ID of the version of the data store.
    Region string
    optional string → The region to fetch availability zones from, defaults to the provider's region.
    datastoreName String
    required string → Name of the data store.
    datastoreVersionId String
    required string → ID of the version of the data store.
    region String
    optional string → The region to fetch availability zones from, defaults to the provider's region.
    datastoreName string
    required string → Name of the data store.
    datastoreVersionId string
    required string → ID of the version of the data store.
    region string
    optional string → The region to fetch availability zones from, defaults to the provider's region.
    datastore_name str
    required string → Name of the data store.
    datastore_version_id str
    required string → ID of the version of the data store.
    region str
    optional string → The region to fetch availability zones from, defaults to the provider's region.
    datastoreName String
    required string → Name of the data store.
    datastoreVersionId String
    required string → ID of the version of the data store.
    region String
    optional string → The region to fetch availability zones from, defaults to the provider's region.

    getDbDatastoreCapabilities Result

    The following output properties are available:

    Capabilities List<GetDbDatastoreCapabilitiesCapability>
    list → Capabilities of the datastore.
    DatastoreName string
    DatastoreVersionId string
    Id string
    string → ID of the resource
    Region string
    Capabilities []GetDbDatastoreCapabilitiesCapability
    list → Capabilities of the datastore.
    DatastoreName string
    DatastoreVersionId string
    Id string
    string → ID of the resource
    Region string
    capabilities List<GetDbDatastoreCapabilitiesCapability>
    list → Capabilities of the datastore.
    datastoreName String
    datastoreVersionId String
    id String
    string → ID of the resource
    region String
    capabilities GetDbDatastoreCapabilitiesCapability[]
    list → Capabilities of the datastore.
    datastoreName string
    datastoreVersionId string
    id string
    string → ID of the resource
    region string
    capabilities Sequence[GetDbDatastoreCapabilitiesCapability]
    list → Capabilities of the datastore.
    datastore_name str
    datastore_version_id str
    id str
    string → ID of the resource
    region str
    capabilities List<Property Map>
    list → Capabilities of the datastore.
    datastoreName String
    datastoreVersionId String
    id String
    string → ID of the resource
    region String

    Supporting Types

    GetDbDatastoreCapabilitiesCapability

    AllowMajorUpgrade bool
    boolean → This attribute indicates whether a capability can be applied in the next major version of data store.
    AllowUpgradeFromBackup bool
    boolean → This attribute indicates whether a capability can be applied to upgrade from backup.
    Description string
    string → Description of data store capability.
    Name string
    string → Name of a parameter.
    Params List<GetDbDatastoreCapabilitiesCapabilityParam>
    list
    ShouldBeOnMaster bool
    boolean → This attribute indicates whether a capability applies only to the master node.
    AllowMajorUpgrade bool
    boolean → This attribute indicates whether a capability can be applied in the next major version of data store.
    AllowUpgradeFromBackup bool
    boolean → This attribute indicates whether a capability can be applied to upgrade from backup.
    Description string
    string → Description of data store capability.
    Name string
    string → Name of a parameter.
    Params []GetDbDatastoreCapabilitiesCapabilityParam
    list
    ShouldBeOnMaster bool
    boolean → This attribute indicates whether a capability applies only to the master node.
    allowMajorUpgrade Boolean
    boolean → This attribute indicates whether a capability can be applied in the next major version of data store.
    allowUpgradeFromBackup Boolean
    boolean → This attribute indicates whether a capability can be applied to upgrade from backup.
    description String
    string → Description of data store capability.
    name String
    string → Name of a parameter.
    params List<GetDbDatastoreCapabilitiesCapabilityParam>
    list
    shouldBeOnMaster Boolean
    boolean → This attribute indicates whether a capability applies only to the master node.
    allowMajorUpgrade boolean
    boolean → This attribute indicates whether a capability can be applied in the next major version of data store.
    allowUpgradeFromBackup boolean
    boolean → This attribute indicates whether a capability can be applied to upgrade from backup.
    description string
    string → Description of data store capability.
    name string
    string → Name of a parameter.
    params GetDbDatastoreCapabilitiesCapabilityParam[]
    list
    shouldBeOnMaster boolean
    boolean → This attribute indicates whether a capability applies only to the master node.
    allow_major_upgrade bool
    boolean → This attribute indicates whether a capability can be applied in the next major version of data store.
    allow_upgrade_from_backup bool
    boolean → This attribute indicates whether a capability can be applied to upgrade from backup.
    description str
    string → Description of data store capability.
    name str
    string → Name of a parameter.
    params Sequence[GetDbDatastoreCapabilitiesCapabilityParam]
    list
    should_be_on_master bool
    boolean → This attribute indicates whether a capability applies only to the master node.
    allowMajorUpgrade Boolean
    boolean → This attribute indicates whether a capability can be applied in the next major version of data store.
    allowUpgradeFromBackup Boolean
    boolean → This attribute indicates whether a capability can be applied to upgrade from backup.
    description String
    string → Description of data store capability.
    name String
    string → Name of a parameter.
    params List<Property Map>
    list
    shouldBeOnMaster Boolean
    boolean → This attribute indicates whether a capability applies only to the master node.

    GetDbDatastoreCapabilitiesCapabilityParam

    DefaultValue string
    string → Default value for a parameter.
    ElementType string
    string → Type of element value for a parameter of list type.
    EnumValues List<string>
    string → Supported values for a parameter.
    Masked bool
    boolean → Masked indicates whether a parameter value must be a boolean mask.
    Max double
    number → Maximum value for a parameter.
    Min double
    number → Minimum value for a parameter.
    Name string
    string → Name of a parameter.
    Regex string
    string → Regular expression that a parameter value must match.
    Required bool
    boolean → Required indicates whether a parameter value must be set.
    Type string
    string → Type of value for a parameter.
    DefaultValue string
    string → Default value for a parameter.
    ElementType string
    string → Type of element value for a parameter of list type.
    EnumValues []string
    string → Supported values for a parameter.
    Masked bool
    boolean → Masked indicates whether a parameter value must be a boolean mask.
    Max float64
    number → Maximum value for a parameter.
    Min float64
    number → Minimum value for a parameter.
    Name string
    string → Name of a parameter.
    Regex string
    string → Regular expression that a parameter value must match.
    Required bool
    boolean → Required indicates whether a parameter value must be set.
    Type string
    string → Type of value for a parameter.
    defaultValue String
    string → Default value for a parameter.
    elementType String
    string → Type of element value for a parameter of list type.
    enumValues List<String>
    string → Supported values for a parameter.
    masked Boolean
    boolean → Masked indicates whether a parameter value must be a boolean mask.
    max Double
    number → Maximum value for a parameter.
    min Double
    number → Minimum value for a parameter.
    name String
    string → Name of a parameter.
    regex String
    string → Regular expression that a parameter value must match.
    required Boolean
    boolean → Required indicates whether a parameter value must be set.
    type String
    string → Type of value for a parameter.
    defaultValue string
    string → Default value for a parameter.
    elementType string
    string → Type of element value for a parameter of list type.
    enumValues string[]
    string → Supported values for a parameter.
    masked boolean
    boolean → Masked indicates whether a parameter value must be a boolean mask.
    max number
    number → Maximum value for a parameter.
    min number
    number → Minimum value for a parameter.
    name string
    string → Name of a parameter.
    regex string
    string → Regular expression that a parameter value must match.
    required boolean
    boolean → Required indicates whether a parameter value must be set.
    type string
    string → Type of value for a parameter.
    default_value str
    string → Default value for a parameter.
    element_type str
    string → Type of element value for a parameter of list type.
    enum_values Sequence[str]
    string → Supported values for a parameter.
    masked bool
    boolean → Masked indicates whether a parameter value must be a boolean mask.
    max float
    number → Maximum value for a parameter.
    min float
    number → Minimum value for a parameter.
    name str
    string → Name of a parameter.
    regex str
    string → Regular expression that a parameter value must match.
    required bool
    boolean → Required indicates whether a parameter value must be set.
    type str
    string → Type of value for a parameter.
    defaultValue String
    string → Default value for a parameter.
    elementType String
    string → Type of element value for a parameter of list type.
    enumValues List<String>
    string → Supported values for a parameter.
    masked Boolean
    boolean → Masked indicates whether a parameter value must be a boolean mask.
    max Number
    number → Maximum value for a parameter.
    min Number
    number → Minimum value for a parameter.
    name String
    string → Name of a parameter.
    regex String
    string → Regular expression that a parameter value must match.
    required Boolean
    boolean → Required indicates whether a parameter value must be set.
    type String
    string → Type of value for a parameter.

    Package Details

    Repository
    vkcs vk-cs/terraform-provider-vkcs
    License
    Notes
    This Pulumi package is based on the vkcs Terraform Provider.
    vkcs logo
    vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs