Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. ecs
  5. EcsDisk
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.ecs.EcsDisk

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    Import

    ECS Disk can be imported using the id, e.g.

    $ pulumi import alicloud:ecs/ecsDisk:EcsDisk example d-abcd12345

    Create EcsDisk Resource

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

    Constructor syntax

    new EcsDisk(name: string, args?: EcsDiskArgs, opts?: CustomResourceOptions);
    @overload
def EcsDisk(resource_name: str,
            args: Optional[EcsDiskArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def EcsDisk(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            advanced_features: Optional[str] = None,
            availability_zone: Optional[str] = None,
            category: Optional[str] = None,
            delete_auto_snapshot: Optional[bool] = None,
            delete_with_instance: Optional[bool] = None,
            description: Optional[str] = None,
            disk_name: Optional[str] = None,
            dry_run: Optional[bool] = None,
            enable_auto_snapshot: Optional[bool] = None,
            encrypt_algorithm: Optional[str] = None,
            encrypted: Optional[bool] = None,
            instance_id: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            name: Optional[str] = None,
            payment_type: Optional[str] = None,
            performance_level: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            size: Optional[int] = None,
            snapshot_id: Optional[str] = None,
            storage_set_id: Optional[str] = None,
            storage_set_partition_number: Optional[int] = None,
            tags: Optional[Mapping[str, str]] = None,
            type: Optional[str] = None,
            zone_id: Optional[str] = None)
    func NewEcsDisk(ctx *Context, name string, args *EcsDiskArgs, opts ...ResourceOption) (*EcsDisk, error)
    public EcsDisk(string name, EcsDiskArgs? args = null, CustomResourceOptions? opts = null)
    public EcsDisk(String name, EcsDiskArgs args)
public EcsDisk(String name, EcsDiskArgs args, CustomResourceOptions options)

    type: alicloud:ecs:EcsDisk
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 EcsDiskArgs
    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 EcsDiskArgs
    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 EcsDiskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EcsDiskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EcsDiskArgs
    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 ecsDiskResource = new AliCloud.Ecs.EcsDisk("ecsDiskResource", new()
{
    AdvancedFeatures = "string",
    Category = "string",
    DeleteAutoSnapshot = false,
    DeleteWithInstance = false,
    Description = "string",
    DiskName = "string",
    DryRun = false,
    EnableAutoSnapshot = false,
    EncryptAlgorithm = "string",
    Encrypted = false,
    InstanceId = "string",
    KmsKeyId = "string",
    PaymentType = "string",
    PerformanceLevel = "string",
    ResourceGroupId = "string",
    Size = 0,
    SnapshotId = "string",
    StorageSetId = "string",
    StorageSetPartitionNumber = 0,
    Tags = 
    {
        { "string", "string" },
    },
    Type = "string",
    ZoneId = "string",
});

    example, err := ecs.NewEcsDisk(ctx, "ecsDiskResource", &ecs.EcsDiskArgs{
	AdvancedFeatures:          pulumi.String("string"),
	Category:                  pulumi.String("string"),
	DeleteAutoSnapshot:        pulumi.Bool(false),
	DeleteWithInstance:        pulumi.Bool(false),
	Description:               pulumi.String("string"),
	DiskName:                  pulumi.String("string"),
	DryRun:                    pulumi.Bool(false),
	EnableAutoSnapshot:        pulumi.Bool(false),
	EncryptAlgorithm:          pulumi.String("string"),
	Encrypted:                 pulumi.Bool(false),
	InstanceId:                pulumi.String("string"),
	KmsKeyId:                  pulumi.String("string"),
	PaymentType:               pulumi.String("string"),
	PerformanceLevel:          pulumi.String("string"),
	ResourceGroupId:           pulumi.String("string"),
	Size:                      pulumi.Int(0),
	SnapshotId:                pulumi.String("string"),
	StorageSetId:              pulumi.String("string"),
	StorageSetPartitionNumber: pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Type:   pulumi.String("string"),
	ZoneId: pulumi.String("string"),
})

    var ecsDiskResource = new EcsDisk("ecsDiskResource", EcsDiskArgs.builder()
    .advancedFeatures("string")
    .category("string")
    .deleteAutoSnapshot(false)
    .deleteWithInstance(false)
    .description("string")
    .diskName("string")
    .dryRun(false)
    .enableAutoSnapshot(false)
    .encryptAlgorithm("string")
    .encrypted(false)
    .instanceId("string")
    .kmsKeyId("string")
    .paymentType("string")
    .performanceLevel("string")
    .resourceGroupId("string")
    .size(0)
    .snapshotId("string")
    .storageSetId("string")
    .storageSetPartitionNumber(0)
    .tags(Map.of("string", "string"))
    .type("string")
    .zoneId("string")
    .build());

    ecs_disk_resource = alicloud.ecs.EcsDisk("ecsDiskResource",
    advanced_features="string",
    category="string",
    delete_auto_snapshot=False,
    delete_with_instance=False,
    description="string",
    disk_name="string",
    dry_run=False,
    enable_auto_snapshot=False,
    encrypt_algorithm="string",
    encrypted=False,
    instance_id="string",
    kms_key_id="string",
    payment_type="string",
    performance_level="string",
    resource_group_id="string",
    size=0,
    snapshot_id="string",
    storage_set_id="string",
    storage_set_partition_number=0,
    tags={
        "string": "string",
    },
    type="string",
    zone_id="string")

    const ecsDiskResource = new alicloud.ecs.EcsDisk("ecsDiskResource", {
    advancedFeatures: "string",
    category: "string",
    deleteAutoSnapshot: false,
    deleteWithInstance: false,
    description: "string",
    diskName: "string",
    dryRun: false,
    enableAutoSnapshot: false,
    encryptAlgorithm: "string",
    encrypted: false,
    instanceId: "string",
    kmsKeyId: "string",
    paymentType: "string",
    performanceLevel: "string",
    resourceGroupId: "string",
    size: 0,
    snapshotId: "string",
    storageSetId: "string",
    storageSetPartitionNumber: 0,
    tags: {
        string: "string",
    },
    type: "string",
    zoneId: "string",
});

    type: alicloud:ecs:EcsDisk
properties:
    advancedFeatures: string
    category: string
    deleteAutoSnapshot: false
    deleteWithInstance: false
    description: string
    diskName: string
    dryRun: false
    enableAutoSnapshot: false
    encryptAlgorithm: string
    encrypted: false
    instanceId: string
    kmsKeyId: string
    paymentType: string
    performanceLevel: string
    resourceGroupId: string
    size: 0
    snapshotId: string
    storageSetId: string
    storageSetPartitionNumber: 0
    tags:
        string: string
    type: string
    zoneId: string

    EcsDisk Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EcsDisk resource accepts the following input properties:

    AdvancedFeatures string
    AvailabilityZone string
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    Category string
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    DeleteAutoSnapshot bool
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    DeleteWithInstance bool
    Indicates whether the disk is released together with the instance. Default value: false.
    Description string
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    DiskName string
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    DryRun bool
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    EnableAutoSnapshot bool
    Indicates whether to enable creating snapshot automatically.
    EncryptAlgorithm string
    Encrypted bool
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    InstanceId string
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    KmsKeyId string
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    Name string
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    PaymentType string
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    PerformanceLevel string
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    ResourceGroupId string
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    Size int
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    SnapshotId string
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    StorageSetId string
    The ID of the storage set.
    StorageSetPartitionNumber int
    The number of partitions in the storage set.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Type string
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    ZoneId string
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    AdvancedFeatures string
    AvailabilityZone string
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    Category string
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    DeleteAutoSnapshot bool
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    DeleteWithInstance bool
    Indicates whether the disk is released together with the instance. Default value: false.
    Description string
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    DiskName string
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    DryRun bool
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    EnableAutoSnapshot bool
    Indicates whether to enable creating snapshot automatically.
    EncryptAlgorithm string
    Encrypted bool
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    InstanceId string
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    KmsKeyId string
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    Name string
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    PaymentType string
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    PerformanceLevel string
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    ResourceGroupId string
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    Size int
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    SnapshotId string
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    StorageSetId string
    The ID of the storage set.
    StorageSetPartitionNumber int
    The number of partitions in the storage set.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Type string
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    ZoneId string
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    advancedFeatures String
    availabilityZone String
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    category String
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    deleteAutoSnapshot Boolean
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    deleteWithInstance Boolean
    Indicates whether the disk is released together with the instance. Default value: false.
    description String
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    diskName String
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    dryRun Boolean
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    enableAutoSnapshot Boolean
    Indicates whether to enable creating snapshot automatically.
    encryptAlgorithm String
    encrypted Boolean
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    instanceId String
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    kmsKeyId String
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    name String
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    paymentType String
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    performanceLevel String
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    resourceGroupId String
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    size Integer
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    snapshotId String
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    storageSetId String
    The ID of the storage set.
    storageSetPartitionNumber Integer
    The number of partitions in the storage set.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    type String
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    zoneId String
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    advancedFeatures string
    availabilityZone string
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    category string
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    deleteAutoSnapshot boolean
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    deleteWithInstance boolean
    Indicates whether the disk is released together with the instance. Default value: false.
    description string
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    diskName string
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    dryRun boolean
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    enableAutoSnapshot boolean
    Indicates whether to enable creating snapshot automatically.
    encryptAlgorithm string
    encrypted boolean
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    instanceId string
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    kmsKeyId string
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    name string
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    paymentType string
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    performanceLevel string
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    resourceGroupId string
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    size number
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    snapshotId string
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    storageSetId string
    The ID of the storage set.
    storageSetPartitionNumber number
    The number of partitions in the storage set.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    type string
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    zoneId string
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    advanced_features str
    availability_zone str
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    category str
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    delete_auto_snapshot bool
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    delete_with_instance bool
    Indicates whether the disk is released together with the instance. Default value: false.
    description str
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    disk_name str
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    dry_run bool
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    enable_auto_snapshot bool
    Indicates whether to enable creating snapshot automatically.
    encrypt_algorithm str
    encrypted bool
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    instance_id str
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    kms_key_id str
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    name str
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    payment_type str
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    performance_level str
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    resource_group_id str
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    size int
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    snapshot_id str
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    storage_set_id str
    The ID of the storage set.
    storage_set_partition_number int
    The number of partitions in the storage set.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    type str
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    zone_id str
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    advancedFeatures String
    availabilityZone String
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    category String
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    deleteAutoSnapshot Boolean
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    deleteWithInstance Boolean
    Indicates whether the disk is released together with the instance. Default value: false.
    description String
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    diskName String
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    dryRun Boolean
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    enableAutoSnapshot Boolean
    Indicates whether to enable creating snapshot automatically.
    encryptAlgorithm String
    encrypted Boolean
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    instanceId String
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    kmsKeyId String
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    name String
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    paymentType String
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    performanceLevel String
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    resourceGroupId String
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    size Number
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    snapshotId String
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    storageSetId String
    The ID of the storage set.
    storageSetPartitionNumber Number
    The number of partitions in the storage set.
    tags Map<String>
    A mapping of tags to assign to the resource.
    type String
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    zoneId String
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The disk status.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The disk status.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The disk status.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The disk status.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The disk status.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The disk status.

    Look up Existing EcsDisk Resource

    Get an existing EcsDisk 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?: EcsDiskState, opts?: CustomResourceOptions): EcsDisk
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advanced_features: Optional[str] = None,
        availability_zone: Optional[str] = None,
        category: Optional[str] = None,
        delete_auto_snapshot: Optional[bool] = None,
        delete_with_instance: Optional[bool] = None,
        description: Optional[str] = None,
        disk_name: Optional[str] = None,
        dry_run: Optional[bool] = None,
        enable_auto_snapshot: Optional[bool] = None,
        encrypt_algorithm: Optional[str] = None,
        encrypted: Optional[bool] = None,
        instance_id: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        name: Optional[str] = None,
        payment_type: Optional[str] = None,
        performance_level: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        size: Optional[int] = None,
        snapshot_id: Optional[str] = None,
        status: Optional[str] = None,
        storage_set_id: Optional[str] = None,
        storage_set_partition_number: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None,
        zone_id: Optional[str] = None) -> EcsDisk
    func GetEcsDisk(ctx *Context, name string, id IDInput, state *EcsDiskState, opts ...ResourceOption) (*EcsDisk, error)
    public static EcsDisk Get(string name, Input<string> id, EcsDiskState? state, CustomResourceOptions? opts = null)
    public static EcsDisk get(String name, Output<String> id, EcsDiskState 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
    AvailabilityZone string
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    Category string
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    DeleteAutoSnapshot bool
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    DeleteWithInstance bool
    Indicates whether the disk is released together with the instance. Default value: false.
    Description string
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    DiskName string
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    DryRun bool
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    EnableAutoSnapshot bool
    Indicates whether to enable creating snapshot automatically.
    EncryptAlgorithm string
    Encrypted bool
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    InstanceId string
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    KmsKeyId string
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    Name string
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    PaymentType string
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    PerformanceLevel string
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    ResourceGroupId string
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    Size int
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    SnapshotId string
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    Status string
    The disk status.
    StorageSetId string
    The ID of the storage set.
    StorageSetPartitionNumber int
    The number of partitions in the storage set.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Type string
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    ZoneId string
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    AdvancedFeatures string
    AvailabilityZone string
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    Category string
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    DeleteAutoSnapshot bool
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    DeleteWithInstance bool
    Indicates whether the disk is released together with the instance. Default value: false.
    Description string
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    DiskName string
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    DryRun bool
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    EnableAutoSnapshot bool
    Indicates whether to enable creating snapshot automatically.
    EncryptAlgorithm string
    Encrypted bool
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    InstanceId string
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    KmsKeyId string
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    Name string
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    PaymentType string
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    PerformanceLevel string
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    ResourceGroupId string
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    Size int
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    SnapshotId string
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    Status string
    The disk status.
    StorageSetId string
    The ID of the storage set.
    StorageSetPartitionNumber int
    The number of partitions in the storage set.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Type string
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    ZoneId string
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    advancedFeatures String
    availabilityZone String
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    category String
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    deleteAutoSnapshot Boolean
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    deleteWithInstance Boolean
    Indicates whether the disk is released together with the instance. Default value: false.
    description String
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    diskName String
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    dryRun Boolean
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    enableAutoSnapshot Boolean
    Indicates whether to enable creating snapshot automatically.
    encryptAlgorithm String
    encrypted Boolean
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    instanceId String
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    kmsKeyId String
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    name String
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    paymentType String
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    performanceLevel String
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    resourceGroupId String
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    size Integer
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    snapshotId String
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    status String
    The disk status.
    storageSetId String
    The ID of the storage set.
    storageSetPartitionNumber Integer
    The number of partitions in the storage set.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    type String
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    zoneId String
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    advancedFeatures string
    availabilityZone string
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    category string
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    deleteAutoSnapshot boolean
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    deleteWithInstance boolean
    Indicates whether the disk is released together with the instance. Default value: false.
    description string
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    diskName string
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    dryRun boolean
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    enableAutoSnapshot boolean
    Indicates whether to enable creating snapshot automatically.
    encryptAlgorithm string
    encrypted boolean
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    instanceId string
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    kmsKeyId string
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    name string
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    paymentType string
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    performanceLevel string
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    resourceGroupId string
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    size number
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    snapshotId string
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    status string
    The disk status.
    storageSetId string
    The ID of the storage set.
    storageSetPartitionNumber number
    The number of partitions in the storage set.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    type string
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    zoneId string
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    advanced_features str
    availability_zone str
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    category str
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    delete_auto_snapshot bool
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    delete_with_instance bool
    Indicates whether the disk is released together with the instance. Default value: false.
    description str
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    disk_name str
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    dry_run bool
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    enable_auto_snapshot bool
    Indicates whether to enable creating snapshot automatically.
    encrypt_algorithm str
    encrypted bool
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    instance_id str
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    kms_key_id str
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    name str
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    payment_type str
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    performance_level str
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    resource_group_id str
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    size int
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    snapshot_id str
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    status str
    The disk status.
    storage_set_id str
    The ID of the storage set.
    storage_set_partition_number int
    The number of partitions in the storage set.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    type str
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    zone_id str
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.
    advancedFeatures String
    availabilityZone String
    Field availability_zone has been deprecated from provider version 1.122.0. New field zone_id instead.

    Deprecated: Field 'availability_zone' has been deprecated from provider version 1.122.0. New field 'zone_id' instead

    category String
    Category of the disk. Default value: cloud_efficiency. Valid Values: cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto, cloud_essd_entry, elastic_ephemeral_disk_standard, elastic_ephemeral_disk_premium.
    deleteAutoSnapshot Boolean
    Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.
    deleteWithInstance Boolean
    Indicates whether the disk is released together with the instance. Default value: false.
    description String
    Description of the disk. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.
    diskName String
    Name of the ECS disk. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.
    dryRun Boolean
    Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
    enableAutoSnapshot Boolean
    Indicates whether to enable creating snapshot automatically.
    encryptAlgorithm String
    encrypted Boolean
    Specifies whether to encrypt the disk. Default value: false. Valid values:
    instanceId String
    The ID of the instance to which the created subscription disk is automatically attached.

    • After you specify the instance ID, the specified resource_group_id, tags, and kms_key_id parameters are ignored.
    • One of the zone_id and instance_id must be set but can not be set at the same time.
    kmsKeyId String
    The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.
    name String
    Field name has been deprecated from provider version 1.122.0. New field disk_name instead.

    Deprecated: Field 'name' has been deprecated from provider version 1.122.0. New field 'disk_name' instead.

    paymentType String
    Payment method for disk. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo. If you want to change the disk payment type, the instance_id is required.
    performanceLevel String
    Specifies the performance level of an ESSD when you create the ESSD. Valid values:

    • PL0: A single ESSD delivers up to 10,000 random read/write IOPS.
    • PL1: A single ESSD delivers up to 50,000 random read/write IOPS.
    • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
    • PL3: A single ESSD delivers up to 1,000,000 random read/write IOPS.
    resourceGroupId String
    The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
    size Number
    The size of the disk. Unit: GiB. This parameter is required. Valid values:

    • If category is set to cloud. Valid values: 5 to 2000.
    • If category is set to cloud_efficiency. Valid values: 20 to 32768.
    • If category is set to cloud_ssd. Valid values: 20 to 32768.
    • If category is set to cloud_auto. Valid values: 1 to 65536.
    • If category is set to cloud_essd_entry. Valid values: 10 to 32768.
    • If category is set to elastic_ephemeral_disk_standard. Valid values: 64 to 8192.
    • If category is set to elastic_ephemeral_disk_premium. Valid values: 64 to 8192.
    • If category is set to cloud_essd, the valid values are related to performance_level. Valid values:
    • If performance_level is set to PL0. Valid values: 1 to 65536.
    • If performance_level is set to PL1. Valid values: 20 to 65536.
    • If performance_level is set to PL2. Valid values: 461 to 65536.
    • If performance_level is set to PL3. Valid values: 1261 to 65536.
    snapshotId String
    The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_id is larger than the value of size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by snapshot_id is smaller than the value of size, the size of the created disk is equal to the value of size.
    status String
    The disk status.
    storageSetId String
    The ID of the storage set.
    storageSetPartitionNumber Number
    The number of partitions in the storage set.
    tags Map<String>
    A mapping of tags to assign to the resource.
    type String
    The type to expand cloud disks. Valid Values: online, offline. Default to offline.
    zoneId String
    ID of the free zone to which the disk belongs. One of the zone_id and instance_id must be set but can not be set at the same time.

    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.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud