Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
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 d-abcd12345
Create EcsDisk Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EcsDisk(name: string, args?: EcsDiskArgs, opts?: CustomResourceOptions);
@overload
def EcsDisk(resource_name: str,
args: Optional[EcsDiskArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def EcsDisk(resource_name: str,
opts: Optional[ResourceOptions] = None,
advanced_features: Optional[str] = None,
availability_zone: Optional[str] = None,
category: Optional[str] = None,
delete_auto_snapshot: Optional[bool] = None,
delete_with_instance: Optional[bool] = None,
description: Optional[str] = None,
disk_name: Optional[str] = None,
dry_run: Optional[bool] = None,
enable_auto_snapshot: Optional[bool] = None,
encrypt_algorithm: Optional[str] = None,
encrypted: Optional[bool] = None,
instance_id: Optional[str] = None,
kms_key_id: Optional[str] = None,
name: Optional[str] = None,
payment_type: Optional[str] = None,
performance_level: Optional[str] = None,
resource_group_id: Optional[str] = None,
size: Optional[int] = None,
snapshot_id: Optional[str] = None,
storage_set_id: Optional[str] = None,
storage_set_partition_number: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
type: Optional[str] = None,
zone_id: Optional[str] = None)
func NewEcsDisk(ctx *Context, name string, args *EcsDiskArgs, opts ...ResourceOption) (*EcsDisk, error)
public EcsDisk(string name, EcsDiskArgs? args = null, CustomResourceOptions? opts = null)
public EcsDisk(String name, EcsDiskArgs args)
public EcsDisk(String name, EcsDiskArgs args, CustomResourceOptions options)
type: alicloud:ecs:EcsDisk
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args EcsDiskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EcsDiskArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EcsDiskArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EcsDiskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EcsDiskArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var ecsDiskResource = new AliCloud.Ecs.EcsDisk("ecsDiskResource", new()
{
AdvancedFeatures = "string",
Category = "string",
DeleteAutoSnapshot = false,
DeleteWithInstance = false,
Description = "string",
DiskName = "string",
DryRun = false,
EnableAutoSnapshot = false,
EncryptAlgorithm = "string",
Encrypted = false,
InstanceId = "string",
KmsKeyId = "string",
PaymentType = "string",
PerformanceLevel = "string",
ResourceGroupId = "string",
Size = 0,
SnapshotId = "string",
StorageSetId = "string",
StorageSetPartitionNumber = 0,
Tags =
{
{ "string", "string" },
},
Type = "string",
ZoneId = "string",
});
example, err := ecs.NewEcsDisk(ctx, "ecsDiskResource", &ecs.EcsDiskArgs{
AdvancedFeatures: pulumi.String("string"),
Category: pulumi.String("string"),
DeleteAutoSnapshot: pulumi.Bool(false),
DeleteWithInstance: pulumi.Bool(false),
Description: pulumi.String("string"),
DiskName: pulumi.String("string"),
DryRun: pulumi.Bool(false),
EnableAutoSnapshot: pulumi.Bool(false),
EncryptAlgorithm: pulumi.String("string"),
Encrypted: pulumi.Bool(false),
InstanceId: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
PaymentType: pulumi.String("string"),
PerformanceLevel: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
Size: pulumi.Int(0),
SnapshotId: pulumi.String("string"),
StorageSetId: pulumi.String("string"),
StorageSetPartitionNumber: pulumi.Int(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Type: pulumi.String("string"),
ZoneId: pulumi.String("string"),
})
var ecsDiskResource = new EcsDisk("ecsDiskResource", EcsDiskArgs.builder()
.advancedFeatures("string")
.category("string")
.deleteAutoSnapshot(false)
.deleteWithInstance(false)
.description("string")
.diskName("string")
.dryRun(false)
.enableAutoSnapshot(false)
.encryptAlgorithm("string")
.encrypted(false)
.instanceId("string")
.kmsKeyId("string")
.paymentType("string")
.performanceLevel("string")
.resourceGroupId("string")
.size(0)
.snapshotId("string")
.storageSetId("string")
.storageSetPartitionNumber(0)
.tags(Map.of("string", "string"))
.type("string")
.zoneId("string")
.build());
ecs_disk_resource = alicloud.ecs.EcsDisk("ecsDiskResource",
advanced_features="string",
category="string",
delete_auto_snapshot=False,
delete_with_instance=False,
description="string",
disk_name="string",
dry_run=False,
enable_auto_snapshot=False,
encrypt_algorithm="string",
encrypted=False,
instance_id="string",
kms_key_id="string",
payment_type="string",
performance_level="string",
resource_group_id="string",
size=0,
snapshot_id="string",
storage_set_id="string",
storage_set_partition_number=0,
tags={
"string": "string",
},
type="string",
zone_id="string")
const ecsDiskResource = new alicloud.ecs.EcsDisk("ecsDiskResource", {
advancedFeatures: "string",
category: "string",
deleteAutoSnapshot: false,
deleteWithInstance: false,
description: "string",
diskName: "string",
dryRun: false,
enableAutoSnapshot: false,
encryptAlgorithm: "string",
encrypted: false,
instanceId: "string",
kmsKeyId: "string",
paymentType: "string",
performanceLevel: "string",
resourceGroupId: "string",
size: 0,
snapshotId: "string",
storageSetId: "string",
storageSetPartitionNumber: 0,
tags: {
string: "string",
},
type: "string",
zoneId: "string",
});
type: alicloud:ecs:EcsDisk
properties:
advancedFeatures: string
category: string
deleteAutoSnapshot: false
deleteWithInstance: false
description: string
diskName: string
dryRun: false
enableAutoSnapshot: false
encryptAlgorithm: string
encrypted: false
instanceId: string
kmsKeyId: string
paymentType: string
performanceLevel: string
resourceGroupId: string
size: 0
snapshotId: string
storageSetId: string
storageSetPartitionNumber: 0
tags:
string: string
type: string
zoneId: string
EcsDisk Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The EcsDisk resource accepts the following input properties:
- Advanced
Features string - Availability
Zone string - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - Category string
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - Delete
Auto boolSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - Delete
With boolInstance - 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.
- Disk
Name 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://
orhttps://
. Default value isnull
. - 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 - Indicates whether to enable creating snapshot automatically.
- Encrypt
Algorithm string - Encrypted bool
- If true, the disk will be encrypted, conflict with
snapshot_id
. - Instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- Kms
Key stringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - Name string
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - Payment
Type string - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - Performance
Level 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.
- Resource
Group stringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- Size int
- The size of the disk 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 string - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - Storage
Set stringId - The ID of the storage set.
- Storage
Set 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
. - Zone
Id string - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- Advanced
Features string - Availability
Zone string - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - Category string
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - Delete
Auto boolSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - Delete
With boolInstance - 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.
- Disk
Name 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://
orhttps://
. Default value isnull
. - 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 - Indicates whether to enable creating snapshot automatically.
- Encrypt
Algorithm string - Encrypted bool
- If true, the disk will be encrypted, conflict with
snapshot_id
. - Instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- Kms
Key stringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - Name string
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - Payment
Type string - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - Performance
Level 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.
- Resource
Group stringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- Size int
- The size of the disk 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 string - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - Storage
Set stringId - The ID of the storage set.
- Storage
Set 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
. - Zone
Id string - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- advanced
Features String - availability
Zone String - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - category String
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - delete
Auto BooleanSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - delete
With BooleanInstance - 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.
- disk
Name 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://
orhttps://
. Default value isnull
. - dry
Run Boolean - Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enable
Auto BooleanSnapshot - Indicates whether to enable creating snapshot automatically.
- encrypt
Algorithm String - encrypted Boolean
- If true, the disk will be encrypted, conflict with
snapshot_id
. - instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- kms
Key StringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - name String
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - payment
Type String - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - performance
Level 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.
- resource
Group StringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- size Integer
- The size of the disk 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 String - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - storage
Set StringId - The ID of the storage set.
- storage
Set 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
. - zone
Id String - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- advanced
Features string - availability
Zone string - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - category string
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - delete
Auto booleanSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - delete
With booleanInstance - 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.
- disk
Name 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://
orhttps://
. Default value isnull
. - dry
Run boolean - Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enable
Auto booleanSnapshot - Indicates whether to enable creating snapshot automatically.
- encrypt
Algorithm string - encrypted boolean
- If true, the disk will be encrypted, conflict with
snapshot_id
. - instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- kms
Key stringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - name string
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - payment
Type string - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - performance
Level 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.
- resource
Group stringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- size number
- The size of the disk 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 string - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - storage
Set stringId - The ID of the storage set.
- storage
Set 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
. - zone
Id string - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_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 fieldzone_id
instead. - category str
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - delete_
auto_ boolsnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - delete_
with_ boolinstance - 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://
orhttps://
. Default value isnull
. - 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 - 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
, andkms_key_id
parameters are ignored. - One of the
zone_id
andinstance_id
must 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 KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - name str
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - payment_
type str - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - performance_
level str - Specifies the performance level of an ESSD when you create the ESSD. Valid values:
PL0
: A single ESSD delivers up to 10,000 random read/write IOPS.PL1
: A single ESSD delivers up to 50,000 random read/write IOPS.PL2
: A single ESSD delivers up to 100,000 random read/write IOPS.PL3
: A single ESSD delivers up to 1,000,000 random read/write IOPS.
- resource_
group_ strid - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- size int
- The size of the disk 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
, thesize
will be ignored, conflict withencrypted
. - 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_id
andinstance_id
must be set but can not be set at the same time.
- advanced
Features String - availability
Zone String - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - category String
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - delete
Auto BooleanSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - delete
With BooleanInstance - 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.
- disk
Name 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://
orhttps://
. Default value isnull
. - dry
Run Boolean - Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enable
Auto BooleanSnapshot - Indicates whether to enable creating snapshot automatically.
- encrypt
Algorithm String - encrypted Boolean
- If true, the disk will be encrypted, conflict with
snapshot_id
. - instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- kms
Key StringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - name String
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - payment
Type String - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - performance
Level 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.
- resource
Group StringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- size Number
- The size of the disk 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 String - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - storage
Set StringId - The ID of the storage set.
- storage
Set 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
. - zone
Id String - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_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:
Look up Existing EcsDisk Resource
Get an existing EcsDisk resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EcsDiskState, opts?: CustomResourceOptions): EcsDisk
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advanced_features: Optional[str] = None,
availability_zone: Optional[str] = None,
category: Optional[str] = None,
delete_auto_snapshot: Optional[bool] = None,
delete_with_instance: Optional[bool] = None,
description: Optional[str] = None,
disk_name: Optional[str] = None,
dry_run: Optional[bool] = None,
enable_auto_snapshot: Optional[bool] = None,
encrypt_algorithm: Optional[str] = None,
encrypted: Optional[bool] = None,
instance_id: Optional[str] = None,
kms_key_id: Optional[str] = None,
name: Optional[str] = None,
payment_type: Optional[str] = None,
performance_level: Optional[str] = None,
resource_group_id: Optional[str] = None,
size: Optional[int] = None,
snapshot_id: Optional[str] = None,
status: Optional[str] = None,
storage_set_id: Optional[str] = None,
storage_set_partition_number: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
type: Optional[str] = None,
zone_id: Optional[str] = None) -> EcsDisk
func GetEcsDisk(ctx *Context, name string, id IDInput, state *EcsDiskState, opts ...ResourceOption) (*EcsDisk, error)
public static EcsDisk Get(string name, Input<string> id, EcsDiskState? state, CustomResourceOptions? opts = null)
public static EcsDisk get(String name, Output<String> id, EcsDiskState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Advanced
Features string - Availability
Zone string - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - Category string
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - Delete
Auto boolSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - Delete
With boolInstance - 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.
- Disk
Name 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://
orhttps://
. Default value isnull
. - 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 - Indicates whether to enable creating snapshot automatically.
- Encrypt
Algorithm string - Encrypted bool
- If true, the disk will be encrypted, conflict with
snapshot_id
. - Instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- Kms
Key stringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - Name string
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - Payment
Type string - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - Performance
Level 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.
- Resource
Group stringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- Size int
- The size of the disk 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 string - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - Status string
- The disk status.
- Storage
Set stringId - The ID of the storage set.
- Storage
Set 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
. - Zone
Id string - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- Advanced
Features string - Availability
Zone string - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - Category string
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - Delete
Auto boolSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - Delete
With boolInstance - 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.
- Disk
Name 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://
orhttps://
. Default value isnull
. - 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 - Indicates whether to enable creating snapshot automatically.
- Encrypt
Algorithm string - Encrypted bool
- If true, the disk will be encrypted, conflict with
snapshot_id
. - Instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- Kms
Key stringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - Name string
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - Payment
Type string - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - Performance
Level 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.
- Resource
Group stringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- Size int
- The size of the disk 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 string - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - Status string
- The disk status.
- Storage
Set stringId - The ID of the storage set.
- Storage
Set 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
. - Zone
Id string - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- advanced
Features String - availability
Zone String - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - category String
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - delete
Auto BooleanSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - delete
With BooleanInstance - 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.
- disk
Name 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://
orhttps://
. Default value isnull
. - dry
Run Boolean - Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enable
Auto BooleanSnapshot - Indicates whether to enable creating snapshot automatically.
- encrypt
Algorithm String - encrypted Boolean
- If true, the disk will be encrypted, conflict with
snapshot_id
. - instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- kms
Key StringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - name String
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - payment
Type String - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - performance
Level 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.
- resource
Group StringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- size Integer
- The size of the disk 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 String - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - status String
- The disk status.
- storage
Set StringId - The ID of the storage set.
- storage
Set 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
. - zone
Id String - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- advanced
Features string - availability
Zone string - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - category string
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - delete
Auto booleanSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - delete
With booleanInstance - 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.
- disk
Name 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://
orhttps://
. Default value isnull
. - dry
Run boolean - Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enable
Auto booleanSnapshot - Indicates whether to enable creating snapshot automatically.
- encrypt
Algorithm string - encrypted boolean
- If true, the disk will be encrypted, conflict with
snapshot_id
. - instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- kms
Key stringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - name string
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - payment
Type string - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - performance
Level 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.
- resource
Group stringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- size number
- The size of the disk 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 string - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - status string
- The disk status.
- storage
Set stringId - The ID of the storage set.
- storage
Set 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
. - zone
Id string - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_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 fieldzone_id
instead. - category str
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - delete_
auto_ boolsnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - delete_
with_ boolinstance - 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://
orhttps://
. Default value isnull
. - 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 - 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
, andkms_key_id
parameters are ignored. - One of the
zone_id
andinstance_id
must 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 KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - name str
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - payment_
type str - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - performance_
level str - Specifies the performance level of an ESSD when you create the ESSD. Valid values:
PL0
: A single ESSD delivers up to 10,000 random read/write IOPS.PL1
: A single ESSD delivers up to 50,000 random read/write IOPS.PL2
: A single ESSD delivers up to 100,000 random read/write IOPS.PL3
: A single ESSD delivers up to 1,000,000 random read/write IOPS.
- resource_
group_ strid - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- size int
- The size of the disk 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
, thesize
will be ignored, conflict withencrypted
. - status str
- The disk status.
- 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_id
andinstance_id
must be set but can not be set at the same time.
- advanced
Features String - availability
Zone String - Field
availability_zone
has been deprecated from provider version 1.122.0. New fieldzone_id
instead. - category String
- Category of the disk. Valid values are
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
,cloud_essd_entry
,elastic_ephemeral_disk_standard
,elastic_ephemeral_disk_premium
. Default iscloud_efficiency
. - delete
Auto BooleanSnapshot - Indicates whether the automatic snapshot is deleted when the disk is released. Default value:
false
. - delete
With BooleanInstance - 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.
- disk
Name 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://
orhttps://
. Default value isnull
. - dry
Run Boolean - Specifies whether to check the validity of the request without actually making the request.request Default value: false. Valid values:
- enable
Auto BooleanSnapshot - Indicates whether to enable creating snapshot automatically.
- encrypt
Algorithm String - encrypted Boolean
- If true, the disk will be encrypted, conflict with
snapshot_id
. - instance
Id 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_id
parameters are ignored. - One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
- After you specify the instance ID, the specified
- kms
Key StringId - The ID of the KMS key corresponding to the data disk, The specified parameter
Encrypted
must betrue
when KmsKeyId is not empty. - name String
- Field
name
has been deprecated from provider version 1.122.0. New fielddisk_name
instead. - payment
Type String - Payment method for disk. Valid values:
PayAsYouGo
,Subscription
. Default toPayAsYouGo
. If you want to change the disk payment type, theinstance_id
is required. - performance
Level 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.
- resource
Group StringId - The Id of resource group which the disk belongs. This attribute only supports adding or updating, not destroying.
- size Number
- The size of the disk 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 String - A snapshot to base the disk off of. If the disk size required by snapshot is greater than
size
, thesize
will be ignored, conflict withencrypted
. - status String
- The disk status.
- storage
Set StringId - The ID of the storage set.
- storage
Set 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
. - zone
Id String - ID of the free zone to which the disk belongs. One of the
zone_id
andinstance_id
must be set but can not be set at the same time.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.