1. Pulumi Registry
  2. Alibaba Cloud
  3. API Docs
  4. ecs
  5. EcsDisk
alicloud logo
Alibaba Cloud v3.34.0, Mar 17 23

alicloud.ecs.EcsDisk

Provides a ECS Disk resource.

For information about ECS Disk and how to use it, see What is Disk.

NOTE: Available in v1.122.0+.

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var example = new AliCloud.Ecs.EcsDisk("example", new()
    {
        Category = "cloud_efficiency",
        Description = "Hello ecs disk.",
        DiskName = "tf-test",
        Encrypted = true,
        KmsKeyId = "2a6767f0-a16c-4679-a60f-13bf*****",
        Size = 30,
        Tags = 
        {
            { "Name", "TerraformTest" },
        },
        ZoneId = "cn-beijing-b",
    });

});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecs.NewEcsDisk(ctx, "example", &ecs.EcsDiskArgs{
			Category:    pulumi.String("cloud_efficiency"),
			Description: pulumi.String("Hello ecs disk."),
			DiskName:    pulumi.String("tf-test"),
			Encrypted:   pulumi.Bool(true),
			KmsKeyId:    pulumi.String("2a6767f0-a16c-4679-a60f-13bf*****"),
			Size:        pulumi.Int(30),
			Tags: pulumi.AnyMap{
				"Name": pulumi.Any("TerraformTest"),
			},
			ZoneId: pulumi.String("cn-beijing-b"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ecs.EcsDisk;
import com.pulumi.alicloud.ecs.EcsDiskArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new EcsDisk("example", EcsDiskArgs.builder()        
            .category("cloud_efficiency")
            .description("Hello ecs disk.")
            .diskName("tf-test")
            .encrypted(true)
            .kmsKeyId("2a6767f0-a16c-4679-a60f-13bf*****")
            .size("30")
            .tags(Map.of("Name", "TerraformTest"))
            .zoneId("cn-beijing-b")
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

example = alicloud.ecs.EcsDisk("example",
    category="cloud_efficiency",
    description="Hello ecs disk.",
    disk_name="tf-test",
    encrypted=True,
    kms_key_id="2a6767f0-a16c-4679-a60f-13bf*****",
    size=30,
    tags={
        "Name": "TerraformTest",
    },
    zone_id="cn-beijing-b")

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.ecs.EcsDisk("example", {
    category: "cloud_efficiency",
    description: "Hello ecs disk.",
    diskName: "tf-test",
    encrypted: true,
    kmsKeyId: "2a6767f0-a16c-4679-a60f-13bf*****",
    size: 30,
    tags: {
        Name: "TerraformTest",
    },
    zoneId: "cn-beijing-b",
});

resources:
  example:
    type: alicloud:ecs:EcsDisk
    properties:
      category: cloud_efficiency
      description: Hello ecs disk.
      diskName: tf-test
      encrypted: true
      kmsKeyId: 2a6767f0-a16c-4679-a60f-13bf*****
      size: '30'
      tags:
        Name: TerraformTest
      zoneId: cn-beijing-b

Create EcsDisk Resource

new EcsDisk(name: string, args?: EcsDiskArgs, opts?: CustomResourceOptions);
@overload
def EcsDisk(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            advanced_features: Optional[str] = None,
            availability_zone: Optional[str] = None,
            category: Optional[str] = None,
            dedicated_block_storage_cluster_id: 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, Any]] = None,
            type: Optional[str] = None,
            zone_id: Optional[str] = None)
@overload
def EcsDisk(resource_name: str,
            args: Optional[EcsDiskArgs] = None,
            opts: Optional[ResourceOptions] = 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.
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.

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

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

DedicatedBlockStorageClusterId string
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

ResourceGroupId string

The Id of resource group which the disk belongs.

Size int

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

SnapshotId string

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

StorageSetId string

The ID of the storage set.

StorageSetPartitionNumber int

The number of partitions in the storage set.

Tags Dictionary<string, object>

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

DedicatedBlockStorageClusterId string
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

ResourceGroupId string

The Id of resource group which the disk belongs.

Size int

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

SnapshotId string

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

StorageSetId string

The ID of the storage set.

StorageSetPartitionNumber int

The number of partitions in the storage set.

Tags map[string]interface{}

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

dedicatedBlockStorageClusterId String
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

resourceGroupId String

The Id of resource group which the disk belongs.

size Integer

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

snapshotId String

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

storageSetId String

The ID of the storage set.

storageSetPartitionNumber Integer

The number of partitions in the storage set.

tags Map<String,Object>

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

dedicatedBlockStorageClusterId string
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

resourceGroupId string

The Id of resource group which the disk belongs.

size number

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

snapshotId string

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

storageSetId string

The ID of the storage set.

storageSetPartitionNumber number

The number of partitions in the storage set.

tags {[key: string]: any}

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

dedicated_block_storage_cluster_id str
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

resource_group_id str

The Id of resource group which the disk belongs.

size int

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

snapshot_id str

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

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, Any]

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

dedicatedBlockStorageClusterId String
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

resourceGroupId String

The Id of resource group which the disk belongs.

size Number

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

snapshotId String

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

storageSetId String

The ID of the storage set.

storageSetPartitionNumber Number

The number of partitions in the storage set.

tags Map<Any>

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,
        dedicated_block_storage_cluster_id: 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, Any]] = 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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

DedicatedBlockStorageClusterId string
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

ResourceGroupId string

The Id of resource group which the disk belongs.

Size int

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

SnapshotId string

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

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, object>

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

DedicatedBlockStorageClusterId string
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

ResourceGroupId string

The Id of resource group which the disk belongs.

Size int

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

SnapshotId string

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

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]interface{}

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

dedicatedBlockStorageClusterId String
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

resourceGroupId String

The Id of resource group which the disk belongs.

size Integer

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

snapshotId String

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

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,Object>

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

dedicatedBlockStorageClusterId string
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

resourceGroupId string

The Id of resource group which the disk belongs.

size number

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

snapshotId string

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

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]: any}

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

dedicated_block_storage_cluster_id str
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

resource_group_id str

The Id of resource group which the disk belongs.

size int

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

snapshot_id str

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

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, Any]

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. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd, cloud_auto. Default is cloud_efficiency.

dedicatedBlockStorageClusterId String
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

If true, the disk will be encrypted, conflict with snapshot_id.

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:

resourceGroupId String

The Id of resource group which the disk belongs.

size Number

The size of the disk in GiBs. When resize the disk, the new size must be greater than the former value, or you would get an error InvalidDiskSize.TooSmall.

snapshotId String

A snapshot to base the disk off of. If the disk size required by snapshot is greater than size, the size will be ignored, conflict with encrypted.

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<Any>

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.

Import

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

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.