alicloud.ecs.EcsDisk
Explore with Pulumi AI
Import
ECS Disk can be imported using the id, e.g.
$ pulumi import alicloud:ecs/ecsDisk:EcsDisk example <id>
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,
            bursting_enabled: Optional[bool] = 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,
            multi_attach: Optional[str] = None,
            name: Optional[str] = None,
            payment_type: Optional[str] = None,
            performance_level: Optional[str] = None,
            provisioned_iops: Optional[int] = 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",
    BurstingEnabled = false,
    Category = "string",
    DeleteAutoSnapshot = false,
    DeleteWithInstance = false,
    Description = "string",
    DiskName = "string",
    DryRun = false,
    EnableAutoSnapshot = false,
    EncryptAlgorithm = "string",
    Encrypted = false,
    InstanceId = "string",
    KmsKeyId = "string",
    MultiAttach = "string",
    PaymentType = "string",
    PerformanceLevel = "string",
    ProvisionedIops = 0,
    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"),
	BurstingEnabled:           pulumi.Bool(false),
	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"),
	MultiAttach:               pulumi.String("string"),
	PaymentType:               pulumi.String("string"),
	PerformanceLevel:          pulumi.String("string"),
	ProvisionedIops:           pulumi.Int(0),
	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")
    .burstingEnabled(false)
    .category("string")
    .deleteAutoSnapshot(false)
    .deleteWithInstance(false)
    .description("string")
    .diskName("string")
    .dryRun(false)
    .enableAutoSnapshot(false)
    .encryptAlgorithm("string")
    .encrypted(false)
    .instanceId("string")
    .kmsKeyId("string")
    .multiAttach("string")
    .paymentType("string")
    .performanceLevel("string")
    .provisionedIops(0)
    .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",
    bursting_enabled=False,
    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",
    multi_attach="string",
    payment_type="string",
    performance_level="string",
    provisioned_iops=0,
    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",
    burstingEnabled: false,
    category: "string",
    deleteAutoSnapshot: false,
    deleteWithInstance: false,
    description: "string",
    diskName: "string",
    dryRun: false,
    enableAutoSnapshot: false,
    encryptAlgorithm: "string",
    encrypted: false,
    instanceId: "string",
    kmsKeyId: "string",
    multiAttach: "string",
    paymentType: "string",
    performanceLevel: "string",
    provisionedIops: 0,
    resourceGroupId: "string",
    size: 0,
    snapshotId: "string",
    storageSetId: "string",
    storageSetPartitionNumber: 0,
    tags: {
        string: "string",
    },
    type: "string",
    zoneId: "string",
});
type: alicloud:ecs:EcsDisk
properties:
    advancedFeatures: string
    burstingEnabled: false
    category: string
    deleteAutoSnapshot: false
    deleteWithInstance: false
    description: string
    diskName: string
    dryRun: false
    enableAutoSnapshot: false
    encryptAlgorithm: string
    encrypted: false
    instanceId: string
    kmsKeyId: string
    multiAttach: string
    paymentType: string
    performanceLevel: string
    provisionedIops: 0
    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_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- BurstingEnabled bool
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- Category string
- The category of the data 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.
- DeleteAuto boolSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- DeleteWith boolInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- Description string
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- DiskName string
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- DryRun bool
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- EnableAuto boolSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- KmsKey stringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- MultiAttach string
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- Name string
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- PaymentType string
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- ProvisionedIops int
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- ResourceGroup stringId 
- The ID of the resource group to which to add the disk.
- Size int
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- SnapshotId string
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- StorageSet stringId 
- The ID of the storage set.
- StorageSet intPartition Number 
- The number of partitions in the storage set.
- 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 tooffline.
- ZoneId string
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- AdvancedFeatures string
- AvailabilityZone string
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- BurstingEnabled bool
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- Category string
- The category of the data 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.
- DeleteAuto boolSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- DeleteWith boolInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- Description string
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- DiskName string
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- DryRun bool
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- EnableAuto boolSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- KmsKey stringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- MultiAttach string
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- Name string
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- PaymentType string
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- ProvisionedIops int
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- ResourceGroup stringId 
- The ID of the resource group to which to add the disk.
- Size int
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- SnapshotId string
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- StorageSet stringId 
- The ID of the storage set.
- StorageSet intPartition Number 
- The number of partitions in the storage set.
- 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 tooffline.
- ZoneId string
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- advancedFeatures String
- availabilityZone String
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- burstingEnabled Boolean
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- category String
- The category of the data 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.
- deleteAuto BooleanSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- deleteWith BooleanInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- description String
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- diskName String
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- dryRun Boolean
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enableAuto BooleanSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- kmsKey StringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- multiAttach String
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- name String
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- paymentType String
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- provisionedIops Integer
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- resourceGroup StringId 
- The ID of the resource group to which to add the disk.
- size Integer
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- snapshotId String
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- storageSet StringId 
- The ID of the storage set.
- storageSet IntegerPartition Number 
- The number of partitions in the storage set.
- 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 tooffline.
- zoneId String
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- advancedFeatures string
- availabilityZone string
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- burstingEnabled boolean
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- category string
- The category of the data 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.
- deleteAuto booleanSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- deleteWith booleanInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- description string
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- diskName string
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- dryRun boolean
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enableAuto booleanSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- kmsKey stringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- multiAttach string
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- name string
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- paymentType string
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- provisionedIops number
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- resourceGroup stringId 
- The ID of the resource group to which to add the disk.
- size number
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- snapshotId string
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- storageSet stringId 
- The ID of the storage set.
- storageSet numberPartition Number 
- The number of partitions in the storage set.
- {[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 tooffline.
- zoneId string
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- advanced_features str
- availability_zone str
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- bursting_enabled bool
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- category str
- The category of the data 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_ boolsnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- delete_with_ boolinstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- description str
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- disk_name str
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- 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_ boolsnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- kms_key_ strid 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- multi_attach str
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- name str
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- payment_type str
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- provisioned_iops int
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- resource_group_ strid 
- The ID of the resource group to which to add the disk.
- size int
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- snapshot_id str
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- storage_set_ strid 
- The ID of the storage set.
- storage_set_ intpartition_ number 
- The number of partitions in the storage set.
- 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 tooffline.
- zone_id str
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- advancedFeatures String
- availabilityZone String
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- burstingEnabled Boolean
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- category String
- The category of the data 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.
- deleteAuto BooleanSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- deleteWith BooleanInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- description String
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- diskName String
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- dryRun Boolean
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enableAuto BooleanSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- kmsKey StringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- multiAttach String
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- name String
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- paymentType String
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- provisionedIops Number
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- resourceGroup StringId 
- The ID of the resource group to which to add the disk.
- size Number
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- snapshotId String
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- storageSet StringId 
- The ID of the storage set.
- storageSet NumberPartition Number 
- The number of partitions in the storage set.
- Map<String>
- A mapping of tags to assign to the resource.
- type String
- The type to expand cloud disks. Valid Values: online,offline. Default tooffline.
- zoneId String
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust 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:
- CreateTime string
- (Available since v1.237.0) The time when the disk was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- RegionId string
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- Status string
- The status of the disk.
- CreateTime string
- (Available since v1.237.0) The time when the disk was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- RegionId string
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- Status string
- The status of the disk.
- createTime String
- (Available since v1.237.0) The time when the disk was created.
- id String
- The provider-assigned unique ID for this managed resource.
- regionId String
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- status String
- The status of the disk.
- createTime string
- (Available since v1.237.0) The time when the disk was created.
- id string
- The provider-assigned unique ID for this managed resource.
- regionId string
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- status string
- The status of the disk.
- create_time str
- (Available since v1.237.0) The time when the disk was created.
- id str
- The provider-assigned unique ID for this managed resource.
- region_id str
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- status str
- The status of the disk.
- createTime String
- (Available since v1.237.0) The time when the disk was created.
- id String
- The provider-assigned unique ID for this managed resource.
- regionId String
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- status String
- The status of the disk.
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,
        bursting_enabled: Optional[bool] = None,
        category: Optional[str] = None,
        create_time: 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,
        multi_attach: Optional[str] = None,
        name: Optional[str] = None,
        payment_type: Optional[str] = None,
        performance_level: Optional[str] = None,
        provisioned_iops: Optional[int] = None,
        region_id: 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) -> EcsDiskfunc 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)resources:  _:    type: alicloud:ecs:EcsDisk    get:      id: ${id}- 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.
- AdvancedFeatures string
- AvailabilityZone string
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- BurstingEnabled bool
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- Category string
- The category of the data 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.
- CreateTime string
- (Available since v1.237.0) The time when the disk was created.
- DeleteAuto boolSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- DeleteWith boolInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- Description string
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- DiskName string
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- DryRun bool
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- EnableAuto boolSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- KmsKey stringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- MultiAttach string
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- Name string
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- PaymentType string
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- ProvisionedIops int
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- RegionId string
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- ResourceGroup stringId 
- The ID of the resource group to which to add the disk.
- Size int
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- SnapshotId string
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- Status string
- The status of the disk.
- StorageSet stringId 
- The ID of the storage set.
- StorageSet intPartition Number 
- The number of partitions in the storage set.
- 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 tooffline.
- ZoneId string
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- AdvancedFeatures string
- AvailabilityZone string
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- BurstingEnabled bool
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- Category string
- The category of the data 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.
- CreateTime string
- (Available since v1.237.0) The time when the disk was created.
- DeleteAuto boolSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- DeleteWith boolInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- Description string
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- DiskName string
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- DryRun bool
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- EnableAuto boolSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- KmsKey stringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- MultiAttach string
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- Name string
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- PaymentType string
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- ProvisionedIops int
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- RegionId string
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- ResourceGroup stringId 
- The ID of the resource group to which to add the disk.
- Size int
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- SnapshotId string
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- Status string
- The status of the disk.
- StorageSet stringId 
- The ID of the storage set.
- StorageSet intPartition Number 
- The number of partitions in the storage set.
- 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 tooffline.
- ZoneId string
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- advancedFeatures String
- availabilityZone String
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- burstingEnabled Boolean
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- category String
- The category of the data 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.
- createTime String
- (Available since v1.237.0) The time when the disk was created.
- deleteAuto BooleanSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- deleteWith BooleanInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- description String
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- diskName String
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- dryRun Boolean
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enableAuto BooleanSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- kmsKey StringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- multiAttach String
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- name String
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- paymentType String
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- provisionedIops Integer
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- regionId String
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- resourceGroup StringId 
- The ID of the resource group to which to add the disk.
- size Integer
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- snapshotId String
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- status String
- The status of the disk.
- storageSet StringId 
- The ID of the storage set.
- storageSet IntegerPartition Number 
- The number of partitions in the storage set.
- 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 tooffline.
- zoneId String
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- advancedFeatures string
- availabilityZone string
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- burstingEnabled boolean
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- category string
- The category of the data 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.
- createTime string
- (Available since v1.237.0) The time when the disk was created.
- deleteAuto booleanSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- deleteWith booleanInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- description string
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- diskName string
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- dryRun boolean
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enableAuto booleanSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- kmsKey stringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- multiAttach string
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- name string
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- paymentType string
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- provisionedIops number
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- regionId string
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- resourceGroup stringId 
- The ID of the resource group to which to add the disk.
- size number
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- snapshotId string
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- status string
- The status of the disk.
- storageSet stringId 
- The ID of the storage set.
- storageSet numberPartition Number 
- The number of partitions in the storage set.
- {[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 tooffline.
- zoneId string
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- advanced_features str
- availability_zone str
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- bursting_enabled bool
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- category str
- The category of the data 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.
- create_time str
- (Available since v1.237.0) The time when the disk was created.
- delete_auto_ boolsnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- delete_with_ boolinstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- description str
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- disk_name str
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- 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_ boolsnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- kms_key_ strid 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- multi_attach str
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- name str
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- payment_type str
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- provisioned_iops int
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- region_id str
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- resource_group_ strid 
- The ID of the resource group to which to add the disk.
- size int
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- snapshot_id str
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- status str
- The status of the disk.
- storage_set_ strid 
- The ID of the storage set.
- storage_set_ intpartition_ number 
- The number of partitions in the storage set.
- 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 tooffline.
- zone_id str
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust be set but can not be set at the same time.
- advancedFeatures String
- availabilityZone String
- Field availability_zonehas been deprecated from provider version 1.122.0. New fieldzone_idinstead.
- burstingEnabled Boolean
- Specifies whether to enable the performance burst feature. Valid values: true,false. NOTE:bursting_enabledis only valid whencategoryiscloud_auto.
- category String
- The category of the data 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.
- createTime String
- (Available since v1.237.0) The time when the disk was created.
- deleteAuto BooleanSnapshot 
- Specifies whether to delete the automatic snapshots of the disk when the disk is released. Default value: false.
- deleteWith BooleanInstance 
- Specifies whether to release the disk along with its associated instance. Default value: false.
- description String
- The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
- diskName String
- The name of the data disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The name must start with a letter.
- dryRun Boolean
- Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enableAuto BooleanSnapshot 
- Specifies whether to enable the automatic snapshot policy feature for the cloud disk. Valid values: true,false.
- 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, andkms_key_idparameters are ignored.
- One of the zone_idandinstance_idmust be set but can not be set at the same time.
 
- After you specify the instance ID, the specified 
- kmsKey StringId 
- The ID of the Key Management Service (KMS) key that is used for the disk. NOTE: kms_key_idis only valid whenencryptedistrue.
- multiAttach String
- Specifies whether to enable the multi-attach feature for the disk. Default value: Disabled. Valid values:Enabled,Disabled. NOTE: Currently,multi_attachcan only be set toEnabledwhencategoryis set tocloud_essd.
- name String
- Field - namehas been deprecated from provider version 1.122.0. New field- disk_nameinstead.- NOTE: Disk category - cloudhas been outdated, and it only can be used none I/O Optimized ECS instances. Recommend- cloud_efficiencyand- cloud_ssddisk.
- paymentType String
- The payment type of the disk. Default to PayAsYouGo. Valid values:PayAsYouGo,Subscription. If you want to change the disk payment type, theinstance_idis 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.
 
- provisionedIops Number
- The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. NOTE: provisioned_iopsis only valid whencategoryiscloud_auto.
- regionId String
- (Available since v1.237.0) The ID of the region to which the disk belongs.
- resourceGroup StringId 
- The ID of the resource group to which to add the disk.
- size Number
- The size of the disk. Unit: GiB. This parameter is required. Valid values:- If categoryis set tocloud. Valid values:5to2000.
- If categoryis set tocloud_efficiency. Valid values:20to32768.
- If categoryis set tocloud_ssd. Valid values:20to32768.
- If categoryis set tocloud_auto. Valid values:1to65536.
- If categoryis set tocloud_essd_entry. Valid values:10to32768.
- If categoryis set toelastic_ephemeral_disk_standard. Valid values:64to8192.
- If categoryis set toelastic_ephemeral_disk_premium. Valid values:64to8192.
- If categoryis set tocloud_essd, the valid values are related toperformance_level. Valid values:
- If performance_levelis set toPL0. Valid values:1to65536.
- If performance_levelis set toPL1. Valid values:20to65536.
- If performance_levelis set toPL2. Valid values:461to65536.
- If performance_levelis set toPL3. Valid values:1261to65536.
 
- If 
- snapshotId String
- The ID of the snapshot to use to create the disk. NOTE: If the size of the snapshot specified by snapshot_idis larger than the value ofsize, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified bysnapshot_idis smaller than the value ofsize, the size of the created disk is equal to the value ofsize.
- status String
- The status of the disk.
- storageSet StringId 
- The ID of the storage set.
- storageSet NumberPartition Number 
- The number of partitions in the storage set.
- Map<String>
- A mapping of tags to assign to the resource.
- type String
- The type to expand cloud disks. Valid Values: online,offline. Default tooffline.
- zoneId String
- ID of the free zone to which the disk belongs. One of the zone_idandinstance_idmust 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 alicloudTerraform Provider.