1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. databasefilesystem
  5. Instance
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

alicloud.databasefilesystem.Instance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

    Provides a DBFS Dbfs Instance resource. An instance of a database file system is equivalent to a file system and can store data of file types.

    For information about DBFS Dbfs Instance and how to use it, see What is Dbfs Instance.

    NOTE: Available since v1.136.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const example = new alicloud.databasefilesystem.Instance("example", {
        category: "standard",
        zoneId: "cn-hangzhou-i",
        performanceLevel: "PL1",
        instanceName: name,
        size: 100,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    example = alicloud.databasefilesystem.Instance("example",
        category="standard",
        zone_id="cn-hangzhou-i",
        performance_level="PL1",
        instance_name=name,
        size=100)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/databasefilesystem"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		name := "terraform-example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		_, err := databasefilesystem.NewInstance(ctx, "example", &databasefilesystem.InstanceArgs{
    			Category:         pulumi.String("standard"),
    			ZoneId:           pulumi.String("cn-hangzhou-i"),
    			PerformanceLevel: pulumi.String("PL1"),
    			InstanceName:     pulumi.String(name),
    			Size:             pulumi.Int(100),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var example = new AliCloud.DatabaseFilesystem.Instance("example", new()
        {
            Category = "standard",
            ZoneId = "cn-hangzhou-i",
            PerformanceLevel = "PL1",
            InstanceName = name,
            Size = 100,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.databasefilesystem.Instance;
    import com.pulumi.alicloud.databasefilesystem.InstanceArgs;
    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 config = ctx.config();
            final var name = config.get("name").orElse("terraform-example");
            var example = new Instance("example", InstanceArgs.builder()
                .category("standard")
                .zoneId("cn-hangzhou-i")
                .performanceLevel("PL1")
                .instanceName(name)
                .size(100)
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
    resources:
      example:
        type: alicloud:databasefilesystem:Instance
        properties:
          category: standard
          zoneId: cn-hangzhou-i
          performanceLevel: PL1
          instanceName: ${name}
          size: 100
    

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 size: Optional[int] = None,
                 category: Optional[str] = None,
                 zone_id: Optional[str] = None,
                 enable_raid: Optional[bool] = None,
                 performance_level: Optional[str] = None,
                 encryption: Optional[bool] = None,
                 fs_name: Optional[str] = None,
                 instance_name: Optional[str] = None,
                 instance_type: Optional[str] = None,
                 kms_key_id: Optional[str] = None,
                 advanced_features: Optional[str] = None,
                 raid_stripe_unit_number: Optional[int] = None,
                 ecs_lists: Optional[Sequence[InstanceEcsListArgs]] = None,
                 snapshot_id: Optional[str] = None,
                 tags: Optional[Mapping[str, Any]] = None,
                 used_scene: Optional[str] = None,
                 delete_snapshot: Optional[bool] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: alicloud:databasefilesystem:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromDatabasefilesysteminstance = new AliCloud.DatabaseFilesystem.Instance("exampleinstanceResourceResourceFromDatabasefilesysteminstance", new()
    {
        Size = 0,
        Category = "string",
        ZoneId = "string",
        EnableRaid = false,
        PerformanceLevel = "string",
        Encryption = false,
        FsName = "string",
        InstanceType = "string",
        KmsKeyId = "string",
        AdvancedFeatures = "string",
        RaidStripeUnitNumber = 0,
        SnapshotId = "string",
        Tags = 
        {
            { "string", "any" },
        },
        UsedScene = "string",
        DeleteSnapshot = false,
    });
    
    example, err := databasefilesystem.NewInstance(ctx, "exampleinstanceResourceResourceFromDatabasefilesysteminstance", &databasefilesystem.InstanceArgs{
    	Size:                 pulumi.Int(0),
    	Category:             pulumi.String("string"),
    	ZoneId:               pulumi.String("string"),
    	EnableRaid:           pulumi.Bool(false),
    	PerformanceLevel:     pulumi.String("string"),
    	Encryption:           pulumi.Bool(false),
    	FsName:               pulumi.String("string"),
    	InstanceType:         pulumi.String("string"),
    	KmsKeyId:             pulumi.String("string"),
    	AdvancedFeatures:     pulumi.String("string"),
    	RaidStripeUnitNumber: pulumi.Int(0),
    	SnapshotId:           pulumi.String("string"),
    	Tags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	UsedScene:      pulumi.String("string"),
    	DeleteSnapshot: pulumi.Bool(false),
    })
    
    var exampleinstanceResourceResourceFromDatabasefilesysteminstance = new Instance("exampleinstanceResourceResourceFromDatabasefilesysteminstance", InstanceArgs.builder()
        .size(0)
        .category("string")
        .zoneId("string")
        .enableRaid(false)
        .performanceLevel("string")
        .encryption(false)
        .fsName("string")
        .instanceType("string")
        .kmsKeyId("string")
        .advancedFeatures("string")
        .raidStripeUnitNumber(0)
        .snapshotId("string")
        .tags(Map.of("string", "any"))
        .usedScene("string")
        .deleteSnapshot(false)
        .build());
    
    exampleinstance_resource_resource_from_databasefilesysteminstance = alicloud.databasefilesystem.Instance("exampleinstanceResourceResourceFromDatabasefilesysteminstance",
        size=0,
        category="string",
        zone_id="string",
        enable_raid=False,
        performance_level="string",
        encryption=False,
        fs_name="string",
        instance_type="string",
        kms_key_id="string",
        advanced_features="string",
        raid_stripe_unit_number=0,
        snapshot_id="string",
        tags={
            "string": "any",
        },
        used_scene="string",
        delete_snapshot=False)
    
    const exampleinstanceResourceResourceFromDatabasefilesysteminstance = new alicloud.databasefilesystem.Instance("exampleinstanceResourceResourceFromDatabasefilesysteminstance", {
        size: 0,
        category: "string",
        zoneId: "string",
        enableRaid: false,
        performanceLevel: "string",
        encryption: false,
        fsName: "string",
        instanceType: "string",
        kmsKeyId: "string",
        advancedFeatures: "string",
        raidStripeUnitNumber: 0,
        snapshotId: "string",
        tags: {
            string: "any",
        },
        usedScene: "string",
        deleteSnapshot: false,
    });
    
    type: alicloud:databasefilesystem:Instance
    properties:
        advancedFeatures: string
        category: string
        deleteSnapshot: false
        enableRaid: false
        encryption: false
        fsName: string
        instanceType: string
        kmsKeyId: string
        performanceLevel: string
        raidStripeUnitNumber: 0
        size: 0
        snapshotId: string
        tags:
            string: any
        usedScene: string
        zoneId: string
    

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Instance resource accepts the following input properties:

    Category string
    Category of database file system.
    Size int
    Size of database file system, unit GiB.
    ZoneId string
    The ID of the zone to which the database file system belongs.
    AdvancedFeatures string
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    DeleteSnapshot bool
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    EcsLists List<Pulumi.AliCloud.DatabaseFilesystem.Inputs.InstanceEcsList>
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    EnableRaid bool
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    Encryption bool
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    FsName string
    Database file system name.
    InstanceName string

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    InstanceType string
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    KmsKeyId string
    The ID of the KMS key used by DBFS.
    PerformanceLevel string
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    RaidStripeUnitNumber int
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    SnapshotId string
    The ID of the snapshot used to create the DBFS instance.
    Tags Dictionary<string, object>
    A mapping of tags to assign to the resource.
    UsedScene string
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    Category string
    Category of database file system.
    Size int
    Size of database file system, unit GiB.
    ZoneId string
    The ID of the zone to which the database file system belongs.
    AdvancedFeatures string
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    DeleteSnapshot bool
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    EcsLists []InstanceEcsListArgs
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    EnableRaid bool
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    Encryption bool
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    FsName string
    Database file system name.
    InstanceName string

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    InstanceType string
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    KmsKeyId string
    The ID of the KMS key used by DBFS.
    PerformanceLevel string
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    RaidStripeUnitNumber int
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    SnapshotId string
    The ID of the snapshot used to create the DBFS instance.
    Tags map[string]interface{}
    A mapping of tags to assign to the resource.
    UsedScene string
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    category String
    Category of database file system.
    size Integer
    Size of database file system, unit GiB.
    zoneId String
    The ID of the zone to which the database file system belongs.
    advancedFeatures String
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    deleteSnapshot Boolean
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    ecsLists List<InstanceEcsList>
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    enableRaid Boolean
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    encryption Boolean
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    fsName String
    Database file system name.
    instanceName String

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    instanceType String
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    kmsKeyId String
    The ID of the KMS key used by DBFS.
    performanceLevel String
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    raidStripeUnitNumber Integer
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    snapshotId String
    The ID of the snapshot used to create the DBFS instance.
    tags Map<String,Object>
    A mapping of tags to assign to the resource.
    usedScene String
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    category string
    Category of database file system.
    size number
    Size of database file system, unit GiB.
    zoneId string
    The ID of the zone to which the database file system belongs.
    advancedFeatures string
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    deleteSnapshot boolean
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    ecsLists InstanceEcsList[]
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    enableRaid boolean
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    encryption boolean
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    fsName string
    Database file system name.
    instanceName string

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    instanceType string
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    kmsKeyId string
    The ID of the KMS key used by DBFS.
    performanceLevel string
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    raidStripeUnitNumber number
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    snapshotId string
    The ID of the snapshot used to create the DBFS instance.
    tags {[key: string]: any}
    A mapping of tags to assign to the resource.
    usedScene string
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    category str
    Category of database file system.
    size int
    Size of database file system, unit GiB.
    zone_id str
    The ID of the zone to which the database file system belongs.
    advanced_features str
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    delete_snapshot bool
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    ecs_lists Sequence[InstanceEcsListArgs]
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    enable_raid bool
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    encryption bool
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    fs_name str
    Database file system name.
    instance_name str

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    instance_type str
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    kms_key_id str
    The ID of the KMS key used by DBFS.
    performance_level str
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    raid_stripe_unit_number int
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    snapshot_id str
    The ID of the snapshot used to create the DBFS instance.
    tags Mapping[str, Any]
    A mapping of tags to assign to the resource.
    used_scene str
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    category String
    Category of database file system.
    size Number
    Size of database file system, unit GiB.
    zoneId String
    The ID of the zone to which the database file system belongs.
    advancedFeatures String
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    deleteSnapshot Boolean
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    ecsLists List<Property Map>
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    enableRaid Boolean
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    encryption Boolean
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    fsName String
    Database file system name.
    instanceName String

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    instanceType String
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    kmsKeyId String
    The ID of the KMS key used by DBFS.
    performanceLevel String
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    raidStripeUnitNumber Number
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    snapshotId String
    The ID of the snapshot used to create the DBFS instance.
    tags Map<Any>
    A mapping of tags to assign to the resource.
    usedScene String
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    CreateTime string
    The creation time of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource.
    CreateTime string
    The creation time of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource.
    createTime String
    The creation time of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource.
    createTime string
    The creation time of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the resource.
    create_time str
    The creation time of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the resource.
    createTime String
    The creation time of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource.

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            advanced_features: Optional[str] = None,
            category: Optional[str] = None,
            create_time: Optional[str] = None,
            delete_snapshot: Optional[bool] = None,
            ecs_lists: Optional[Sequence[InstanceEcsListArgs]] = None,
            enable_raid: Optional[bool] = None,
            encryption: Optional[bool] = None,
            fs_name: Optional[str] = None,
            instance_name: Optional[str] = None,
            instance_type: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            performance_level: Optional[str] = None,
            raid_stripe_unit_number: Optional[int] = None,
            size: Optional[int] = None,
            snapshot_id: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, Any]] = None,
            used_scene: Optional[str] = None,
            zone_id: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdvancedFeatures string
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    Category string
    Category of database file system.
    CreateTime string
    The creation time of the resource.
    DeleteSnapshot bool
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    EcsLists List<Pulumi.AliCloud.DatabaseFilesystem.Inputs.InstanceEcsList>
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    EnableRaid bool
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    Encryption bool
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    FsName string
    Database file system name.
    InstanceName string

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    InstanceType string
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    KmsKeyId string
    The ID of the KMS key used by DBFS.
    PerformanceLevel string
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    RaidStripeUnitNumber int
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    Size int
    Size of database file system, unit GiB.
    SnapshotId string
    The ID of the snapshot used to create the DBFS instance.
    Status string
    The status of the resource.
    Tags Dictionary<string, object>
    A mapping of tags to assign to the resource.
    UsedScene string
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    ZoneId string
    The ID of the zone to which the database file system belongs.
    AdvancedFeatures string
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    Category string
    Category of database file system.
    CreateTime string
    The creation time of the resource.
    DeleteSnapshot bool
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    EcsLists []InstanceEcsListArgs
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    EnableRaid bool
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    Encryption bool
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    FsName string
    Database file system name.
    InstanceName string

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    InstanceType string
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    KmsKeyId string
    The ID of the KMS key used by DBFS.
    PerformanceLevel string
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    RaidStripeUnitNumber int
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    Size int
    Size of database file system, unit GiB.
    SnapshotId string
    The ID of the snapshot used to create the DBFS instance.
    Status string
    The status of the resource.
    Tags map[string]interface{}
    A mapping of tags to assign to the resource.
    UsedScene string
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    ZoneId string
    The ID of the zone to which the database file system belongs.
    advancedFeatures String
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    category String
    Category of database file system.
    createTime String
    The creation time of the resource.
    deleteSnapshot Boolean
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    ecsLists List<InstanceEcsList>
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    enableRaid Boolean
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    encryption Boolean
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    fsName String
    Database file system name.
    instanceName String

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    instanceType String
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    kmsKeyId String
    The ID of the KMS key used by DBFS.
    performanceLevel String
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    raidStripeUnitNumber Integer
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    size Integer
    Size of database file system, unit GiB.
    snapshotId String
    The ID of the snapshot used to create the DBFS instance.
    status String
    The status of the resource.
    tags Map<String,Object>
    A mapping of tags to assign to the resource.
    usedScene String
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    zoneId String
    The ID of the zone to which the database file system belongs.
    advancedFeatures string
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    category string
    Category of database file system.
    createTime string
    The creation time of the resource.
    deleteSnapshot boolean
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    ecsLists InstanceEcsList[]
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    enableRaid boolean
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    encryption boolean
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    fsName string
    Database file system name.
    instanceName string

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    instanceType string
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    kmsKeyId string
    The ID of the KMS key used by DBFS.
    performanceLevel string
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    raidStripeUnitNumber number
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    size number
    Size of database file system, unit GiB.
    snapshotId string
    The ID of the snapshot used to create the DBFS instance.
    status string
    The status of the resource.
    tags {[key: string]: any}
    A mapping of tags to assign to the resource.
    usedScene string
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    zoneId string
    The ID of the zone to which the database file system belongs.
    advanced_features str
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    category str
    Category of database file system.
    create_time str
    The creation time of the resource.
    delete_snapshot bool
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    ecs_lists Sequence[InstanceEcsListArgs]
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    enable_raid bool
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    encryption bool
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    fs_name str
    Database file system name.
    instance_name str

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    instance_type str
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    kms_key_id str
    The ID of the KMS key used by DBFS.
    performance_level str
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    raid_stripe_unit_number int
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    size int
    Size of database file system, unit GiB.
    snapshot_id str
    The ID of the snapshot used to create the DBFS instance.
    status str
    The status of the resource.
    tags Mapping[str, Any]
    A mapping of tags to assign to the resource.
    used_scene str
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    zone_id str
    The ID of the zone to which the database file system belongs.
    advancedFeatures String
    The number of CPU cores and the upper limit of memory used by the database file storage instance.
    category String
    Category of database file system.
    createTime String
    The creation time of the resource.
    deleteSnapshot Boolean
    Whether to delete the original snapshot after creating DBFS using the snapshot.
    ecsLists List<Property Map>
    The collection of ECS instances mounted to the Database file system. See ecs_list below. NOTE: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS. See ecs_list below.

    Deprecated: Field 'ecs_list' has been deprecated from provider version 1.156.0 and it will be removed in the future version. Please use the new resource 'alicloud_dbfs_instance_attachment' to attach ECS and DBFS.

    enableRaid Boolean
    Whether to create DBFS in RAID mode. If created in RAID mode, the capacity is at least 66GB.Valid values: true or false. Default value: false.
    encryption Boolean
    Whether to encrypt DBFS.Valid values: true or false. Default value: false.
    fsName String
    Database file system name.
    instanceName String

    Deprecated: Field 'instance_name' has been deprecated since provider version 1.212.0. New field 'fs_name' instead.

    instanceType String
    Instance type. Value range:

    • dbfs.small
    • dbfs.medium
    • dbfs.large (default)
    kmsKeyId String
    The ID of the KMS key used by DBFS.
    performanceLevel String
    When you create a DBFS instance, set the performance level of the DBFS instance. Value range:

    • PL0: single disk maximum random read-write IOPS 10000
    • PL1: highest random read-write IOPS 50000 per disk (default)
    • PL2: single disk maximum random read-write IOPS 100000
    • PL3: single disk maximum random read-write IOPS 1 million.
    raidStripeUnitNumber Number
    Number of strips. Required when the EnableRaid parameter is true.Value range: Currently, only 8 stripes are supported.
    size Number
    Size of database file system, unit GiB.
    snapshotId String
    The ID of the snapshot used to create the DBFS instance.
    status String
    The status of the resource.
    tags Map<Any>
    A mapping of tags to assign to the resource.
    usedScene String
    The usage scenario of DBFS. Value range:

    • MySQL 5.7
    • PostgreSQL
    • MongoDB.
    zoneId String
    The ID of the zone to which the database file system belongs.

    Supporting Types

    InstanceEcsList, InstanceEcsListArgs

    EcsId string

    The ID of the ECS instance.

    The following arguments will be discarded. Please use new fields as soon as possible:

    EcsId string

    The ID of the ECS instance.

    The following arguments will be discarded. Please use new fields as soon as possible:

    ecsId String

    The ID of the ECS instance.

    The following arguments will be discarded. Please use new fields as soon as possible:

    ecsId string

    The ID of the ECS instance.

    The following arguments will be discarded. Please use new fields as soon as possible:

    ecs_id str

    The ID of the ECS instance.

    The following arguments will be discarded. Please use new fields as soon as possible:

    ecsId String

    The ID of the ECS instance.

    The following arguments will be discarded. Please use new fields as soon as possible:

    Import

    DBFS Dbfs Instance can be imported using the id, e.g.

    $ pulumi import alicloud:databasefilesystem/instance:Instance example <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.59.0 published on Friday, Jul 12, 2024 by Pulumi