1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. databasefilesystem
  5. getInstances
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.databasefilesystem.getInstances

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    This data source provides the DBFS Instances of the current Alibaba Cloud user.

    NOTE: Available in v1.136.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const ids = alicloud.databasefilesystem.getInstances({
        ids: ["example_id"],
    });
    export const dbfsInstanceId1 = ids.then(ids => ids.instances?.[0]?.id);
    const nameRegex = alicloud.databasefilesystem.getInstances({
        nameRegex: "^my-Instance",
    });
    export const dbfsInstanceId2 = nameRegex.then(nameRegex => nameRegex.instances?.[0]?.id);
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    ids = alicloud.databasefilesystem.get_instances(ids=["example_id"])
    pulumi.export("dbfsInstanceId1", ids.instances[0].id)
    name_regex = alicloud.databasefilesystem.get_instances(name_regex="^my-Instance")
    pulumi.export("dbfsInstanceId2", name_regex.instances[0].id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/databasefilesystem"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		ids, err := databasefilesystem.GetInstances(ctx, &databasefilesystem.GetInstancesArgs{
    			Ids: []string{
    				"example_id",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dbfsInstanceId1", ids.Instances[0].Id)
    		nameRegex, err := databasefilesystem.GetInstances(ctx, &databasefilesystem.GetInstancesArgs{
    			NameRegex: pulumi.StringRef("^my-Instance"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dbfsInstanceId2", nameRegex.Instances[0].Id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var ids = AliCloud.DatabaseFilesystem.GetInstances.Invoke(new()
        {
            Ids = new[]
            {
                "example_id",
            },
        });
    
        var nameRegex = AliCloud.DatabaseFilesystem.GetInstances.Invoke(new()
        {
            NameRegex = "^my-Instance",
        });
    
        return new Dictionary<string, object?>
        {
            ["dbfsInstanceId1"] = ids.Apply(getInstancesResult => getInstancesResult.Instances[0]?.Id),
            ["dbfsInstanceId2"] = nameRegex.Apply(getInstancesResult => getInstancesResult.Instances[0]?.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.databasefilesystem.DatabasefilesystemFunctions;
    import com.pulumi.alicloud.databasefilesystem.inputs.GetInstancesArgs;
    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 ids = DatabasefilesystemFunctions.getInstances(GetInstancesArgs.builder()
                .ids("example_id")
                .build());
    
            ctx.export("dbfsInstanceId1", ids.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()));
            final var nameRegex = DatabasefilesystemFunctions.getInstances(GetInstancesArgs.builder()
                .nameRegex("^my-Instance")
                .build());
    
            ctx.export("dbfsInstanceId2", nameRegex.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()));
        }
    }
    
    variables:
      ids:
        fn::invoke:
          Function: alicloud:databasefilesystem:getInstances
          Arguments:
            ids:
              - example_id
      nameRegex:
        fn::invoke:
          Function: alicloud:databasefilesystem:getInstances
          Arguments:
            nameRegex: ^my-Instance
    outputs:
      dbfsInstanceId1: ${ids.instances[0].id}
      dbfsInstanceId2: ${nameRegex.instances[0].id}
    

    Using getInstances

    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 getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
    function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>
    def get_instances(ids: Optional[Sequence[str]] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      status: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetInstancesResult
    def get_instances_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      status: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]
    func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
    func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

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

    public static class GetInstances 
    {
        public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
        public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: alicloud:databasefilesystem/getInstances:getInstances
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Instance IDs.
    NameRegex string
    A regex string to filter results by Instance name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    Status string
    Database file system state. Valid values: attached, attaching, creating, deleted, deleting, detaching, resizing, snapshotting, unattached, upgrading.
    Ids []string
    A list of Instance IDs.
    NameRegex string
    A regex string to filter results by Instance name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    Status string
    Database file system state. Valid values: attached, attaching, creating, deleted, deleting, detaching, resizing, snapshotting, unattached, upgrading.
    ids List<String>
    A list of Instance IDs.
    nameRegex String
    A regex string to filter results by Instance name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    status String
    Database file system state. Valid values: attached, attaching, creating, deleted, deleting, detaching, resizing, snapshotting, unattached, upgrading.
    ids string[]
    A list of Instance IDs.
    nameRegex string
    A regex string to filter results by Instance name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    status string
    Database file system state. Valid values: attached, attaching, creating, deleted, deleting, detaching, resizing, snapshotting, unattached, upgrading.
    ids Sequence[str]
    A list of Instance IDs.
    name_regex str
    A regex string to filter results by Instance name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    status str
    Database file system state. Valid values: attached, attaching, creating, deleted, deleting, detaching, resizing, snapshotting, unattached, upgrading.
    ids List<String>
    A list of Instance IDs.
    nameRegex String
    A regex string to filter results by Instance name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    status String
    Database file system state. Valid values: attached, attaching, creating, deleted, deleting, detaching, resizing, snapshotting, unattached, upgrading.

    getInstances Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    Instances List<Pulumi.AliCloud.DatabaseFilesystem.Outputs.GetInstancesInstance>
    Names List<string>
    NameRegex string
    OutputFile string
    Status string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    Instances []GetInstancesInstance
    Names []string
    NameRegex string
    OutputFile string
    Status string
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    instances List<GetInstancesInstance>
    names List<String>
    nameRegex String
    outputFile String
    status String
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    instances GetInstancesInstance[]
    names string[]
    nameRegex string
    outputFile string
    status string
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    instances Sequence[GetInstancesInstance]
    names Sequence[str]
    name_regex str
    output_file str
    status str
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    instances List<Property Map>
    names List<String>
    nameRegex String
    outputFile String
    status String

    Supporting Types

    GetInstancesInstance

    AttachNodeNumber int
    the number of nodes of the Database file system.
    Category string
    The type of the Database file system. Valid values: standard.
    CreateTime string
    The create time of the Database file system.
    DbfsClusterId string
    The cluster ID of the Database file system.
    EcsLists List<Pulumi.AliCloud.DatabaseFilesystem.Inputs.GetInstancesInstanceEcsList>
    The collection of ECS instances mounted to the Database file system.
    EnableRaid bool
    Whether to create the Database file system in RAID way. Valid values : true anf false.
    Encryption bool
    Whether to encrypt the Database file system. Valid values: true and false.
    Id string
    The ID of the Instance.
    InstanceId string
    The ID of the Database File System
    InstanceName string
    The name of the Database file system.
    KmsKeyId string
    The KMS key ID of the Database file system used. This parameter is valid When encryption parameter is set to true.
    PaymentType string
    Thr payment type of the Database file system. Valid value: PayAsYouGo.
    PerformanceLevel string
    The performance level of the Database file system. Valid values: PL0, PL1, PL2, PL3.
    RaidStripeUnitNumber string
    The number of strip . When enable_raid parameter is set to true will transfer. This parameter is valid When enable_raid parameter is set to true.
    Size int
    The size Of the Database file system. Unit: GiB.
    Status string
    The status of the Database file system.
    ZoneId string
    The Zone ID of the Database file system.
    AttachNodeNumber int
    the number of nodes of the Database file system.
    Category string
    The type of the Database file system. Valid values: standard.
    CreateTime string
    The create time of the Database file system.
    DbfsClusterId string
    The cluster ID of the Database file system.
    EcsLists []GetInstancesInstanceEcsList
    The collection of ECS instances mounted to the Database file system.
    EnableRaid bool
    Whether to create the Database file system in RAID way. Valid values : true anf false.
    Encryption bool
    Whether to encrypt the Database file system. Valid values: true and false.
    Id string
    The ID of the Instance.
    InstanceId string
    The ID of the Database File System
    InstanceName string
    The name of the Database file system.
    KmsKeyId string
    The KMS key ID of the Database file system used. This parameter is valid When encryption parameter is set to true.
    PaymentType string
    Thr payment type of the Database file system. Valid value: PayAsYouGo.
    PerformanceLevel string
    The performance level of the Database file system. Valid values: PL0, PL1, PL2, PL3.
    RaidStripeUnitNumber string
    The number of strip . When enable_raid parameter is set to true will transfer. This parameter is valid When enable_raid parameter is set to true.
    Size int
    The size Of the Database file system. Unit: GiB.
    Status string
    The status of the Database file system.
    ZoneId string
    The Zone ID of the Database file system.
    attachNodeNumber Integer
    the number of nodes of the Database file system.
    category String
    The type of the Database file system. Valid values: standard.
    createTime String
    The create time of the Database file system.
    dbfsClusterId String
    The cluster ID of the Database file system.
    ecsLists List<GetInstancesInstanceEcsList>
    The collection of ECS instances mounted to the Database file system.
    enableRaid Boolean
    Whether to create the Database file system in RAID way. Valid values : true anf false.
    encryption Boolean
    Whether to encrypt the Database file system. Valid values: true and false.
    id String
    The ID of the Instance.
    instanceId String
    The ID of the Database File System
    instanceName String
    The name of the Database file system.
    kmsKeyId String
    The KMS key ID of the Database file system used. This parameter is valid When encryption parameter is set to true.
    paymentType String
    Thr payment type of the Database file system. Valid value: PayAsYouGo.
    performanceLevel String
    The performance level of the Database file system. Valid values: PL0, PL1, PL2, PL3.
    raidStripeUnitNumber String
    The number of strip . When enable_raid parameter is set to true will transfer. This parameter is valid When enable_raid parameter is set to true.
    size Integer
    The size Of the Database file system. Unit: GiB.
    status String
    The status of the Database file system.
    zoneId String
    The Zone ID of the Database file system.
    attachNodeNumber number
    the number of nodes of the Database file system.
    category string
    The type of the Database file system. Valid values: standard.
    createTime string
    The create time of the Database file system.
    dbfsClusterId string
    The cluster ID of the Database file system.
    ecsLists GetInstancesInstanceEcsList[]
    The collection of ECS instances mounted to the Database file system.
    enableRaid boolean
    Whether to create the Database file system in RAID way. Valid values : true anf false.
    encryption boolean
    Whether to encrypt the Database file system. Valid values: true and false.
    id string
    The ID of the Instance.
    instanceId string
    The ID of the Database File System
    instanceName string
    The name of the Database file system.
    kmsKeyId string
    The KMS key ID of the Database file system used. This parameter is valid When encryption parameter is set to true.
    paymentType string
    Thr payment type of the Database file system. Valid value: PayAsYouGo.
    performanceLevel string
    The performance level of the Database file system. Valid values: PL0, PL1, PL2, PL3.
    raidStripeUnitNumber string
    The number of strip . When enable_raid parameter is set to true will transfer. This parameter is valid When enable_raid parameter is set to true.
    size number
    The size Of the Database file system. Unit: GiB.
    status string
    The status of the Database file system.
    zoneId string
    The Zone ID of the Database file system.
    attach_node_number int
    the number of nodes of the Database file system.
    category str
    The type of the Database file system. Valid values: standard.
    create_time str
    The create time of the Database file system.
    dbfs_cluster_id str
    The cluster ID of the Database file system.
    ecs_lists Sequence[GetInstancesInstanceEcsList]
    The collection of ECS instances mounted to the Database file system.
    enable_raid bool
    Whether to create the Database file system in RAID way. Valid values : true anf false.
    encryption bool
    Whether to encrypt the Database file system. Valid values: true and false.
    id str
    The ID of the Instance.
    instance_id str
    The ID of the Database File System
    instance_name str
    The name of the Database file system.
    kms_key_id str
    The KMS key ID of the Database file system used. This parameter is valid When encryption parameter is set to true.
    payment_type str
    Thr payment type of the Database file system. Valid value: PayAsYouGo.
    performance_level str
    The performance level of the Database file system. Valid values: PL0, PL1, PL2, PL3.
    raid_stripe_unit_number str
    The number of strip . When enable_raid parameter is set to true will transfer. This parameter is valid When enable_raid parameter is set to true.
    size int
    The size Of the Database file system. Unit: GiB.
    status str
    The status of the Database file system.
    zone_id str
    The Zone ID of the Database file system.
    attachNodeNumber Number
    the number of nodes of the Database file system.
    category String
    The type of the Database file system. Valid values: standard.
    createTime String
    The create time of the Database file system.
    dbfsClusterId String
    The cluster ID of the Database file system.
    ecsLists List<Property Map>
    The collection of ECS instances mounted to the Database file system.
    enableRaid Boolean
    Whether to create the Database file system in RAID way. Valid values : true anf false.
    encryption Boolean
    Whether to encrypt the Database file system. Valid values: true and false.
    id String
    The ID of the Instance.
    instanceId String
    The ID of the Database File System
    instanceName String
    The name of the Database file system.
    kmsKeyId String
    The KMS key ID of the Database file system used. This parameter is valid When encryption parameter is set to true.
    paymentType String
    Thr payment type of the Database file system. Valid value: PayAsYouGo.
    performanceLevel String
    The performance level of the Database file system. Valid values: PL0, PL1, PL2, PL3.
    raidStripeUnitNumber String
    The number of strip . When enable_raid parameter is set to true will transfer. This parameter is valid When enable_raid parameter is set to true.
    size Number
    The size Of the Database file system. Unit: GiB.
    status String
    The status of the Database file system.
    zoneId String
    The Zone ID of the Database file system.

    GetInstancesInstanceEcsList

    EcsId string
    The ID of the ECS instance.
    EcsId string
    The ID of the ECS instance.
    ecsId String
    The ID of the ECS instance.
    ecsId string
    The ID of the ECS instance.
    ecs_id str
    The ID of the ECS instance.
    ecsId String
    The ID of the ECS instance.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi