ecs¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.ecs.AutoProvisioningGroup(resource_name, opts=None, auto_provisioning_group_name=None, auto_provisioning_group_type=None, default_target_capacity_type=None, description=None, excess_capacity_termination_policy=None, launch_template_configs=None, launch_template_id=None, launch_template_version=None, max_spot_price=None, pay_as_you_go_allocation_strategy=None, pay_as_you_go_target_capacity=None, spot_allocation_strategy=None, spot_instance_interruption_behavior=None, spot_instance_pools_to_use_count=None, spot_target_capacity=None, terminate_instances=None, terminate_instances_with_expiration=None, total_target_capacity=None, valid_from=None, valid_until=None, __props__=None, __name__=None, __opts__=None)¶

Provides a ECS auto provisioning group resource which is a solution that uses preemptive instances and pay_as_you_go instances to rapidly deploy clusters.

NOTE: Available in 1.79.0+

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "auto_provisioning_group"
default_zones = alicloud.get_zones(available_disk_category="cloud_efficiency",
    available_resource_creation="VSwitch")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_security_group = alicloud.ecs.SecurityGroup("defaultSecurityGroup", vpc_id=default_network.id)
default_images = alicloud.ecs.get_images(most_recent=True,
    name_regex="^ubuntu_18.*64",
    owners="system")
template = alicloud.ecs.LaunchTemplate("template",
    image_id=default_images.images[0]["id"],
    instance_type="ecs.n1.tiny",
    security_group_id=default_security_group.id)
default_auto_provisioning_group = alicloud.ecs.AutoProvisioningGroup("defaultAutoProvisioningGroup",
    launch_template_configs=[{
        "instance_type": "ecs.n1.small",
        "vswitch_id": default_switch.id,
    }],
    launch_template_id=template.id,
    pay_as_you_go_target_capacity="1",
    spot_target_capacity="2",
    total_target_capacity="4")

The config mapping supports the following:

• instance_type - (Optional) The instance type of the Nth extended configurations of the launch template.

• max_price - (Required) The maximum price of the instance type specified in the Nth extended configurations of the launch template.

• vswitch_id - (Required) The ID of the VSwitch in the Nth extended configurations of the launch template.

• weighted_capacity - (Optional) The weight of the instance type specified in the Nth extended configurations of the launch template.

• priority - (Optional) The priority of the instance type specified in the Nth extended configurations of the launch template. A value of 0 indicates the highest priority.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• default_target_capacity_type (pulumi.Input[str]) – The type of supplemental instances. When the total value of PayAsYouGoTargetCapacity and SpotTargetCapacity is smaller than the value of TotalTargetCapacity, the auto provisioning group will create instances of the specified type to meet the capacity requirements. Valid values:PayAsYouGo: Pay-as-you-go instances; Spot: Preemptible instances, Default value: Spot.

• description (pulumi.Input[str]) – The description of the auto provisioning group.

• excess_capacity_termination_policy (pulumi.Input[str]) – The shutdown policy for excess preemptible instances followed when the capacity of the auto provisioning group exceeds the target capacity. Valid values: no-termination and termination,Default value: no-termination.

• launch_template_configs (pulumi.Input[list]) – DataDisk mappings to attach to ecs instance. See Block config below for details.

• launch_template_id (pulumi.Input[str]) – The ID of the instance launch template associated with the auto provisioning group.

• launch_template_version (pulumi.Input[str]) – The version of the instance launch template associated with the auto provisioning group.

• max_spot_price (pulumi.Input[float]) – The global maximum price for preemptible instances in the auto provisioning group. If both the MaxSpotPrice and LaunchTemplateConfig.N.MaxPrice parameters are specified, the maximum price is the lower value of the two.

• pay_as_you_go_allocation_strategy (pulumi.Input[str]) – The scale-out policy for pay-as-you-go instances. Valid values: lowest-price and prioritized,Default value: lowest-price.

• pay_as_you_go_target_capacity (pulumi.Input[str]) – The target capacity of pay-as-you-go instances in the auto provisioning group.

• spot_allocation_strategy (pulumi.Input[str]) – The scale-out policy for preemptible instances. Valid values:lowest-price and diversified,Default value: lowest-price.

• spot_instance_interruption_behavior (pulumi.Input[str]) – The default behavior after preemptible instances are shut down. Value values: stop and terminate,Default value: stop.

• spot_instance_pools_to_use_count (pulumi.Input[float]) – This parameter takes effect when the SpotAllocationStrategy parameter is set to lowest-price. The auto provisioning group selects instance types of the lowest cost to create instances.

• spot_target_capacity (pulumi.Input[str]) – The target capacity of preemptible instances in the auto provisioning group.

• terminate_instances (pulumi.Input[bool]) – Specifies whether to release instances of the auto provisioning group. Valid values:false and true, default value: false.

• terminate_instances_with_expiration (pulumi.Input[bool]) – The shutdown policy for preemptible instances when the auto provisioning group expires. Valid values: false and true, default value: false.

• total_target_capacity (pulumi.Input[str]) – The total target capacity of the auto provisioning group. The target capacity consists of the following three parts:PayAsYouGoTargetCapacity,SpotTargetCapacity and the supplemental capacity besides PayAsYouGoTargetCapacity and SpotTargetCapacity.

• valid_from (pulumi.Input[str]) – The time when the auto provisioning group is started. The period of time between this point in time and the point in time specified by the valid_until parameter is the effective time period of the auto provisioning group.By default, an auto provisioning group is immediately started after creation.

• valid_until (pulumi.Input[str]) – The time when the auto provisioning group expires. The period of time between this point in time and the point in time specified by the valid_from parameter is the effective time period of the auto provisioning group.By default, an auto provisioning group never expires.

The launch_template_configs object supports the following:

• instance_type (pulumi.Input[str])

• maxPrice (pulumi.Input[str])

• priority (pulumi.Input[str])

• vswitch_id (pulumi.Input[str])

• weightedCapacity (pulumi.Input[str])

default_target_capacity_type: pulumi.Output[str] = None¶

The type of supplemental instances. When the total value of PayAsYouGoTargetCapacity and SpotTargetCapacity is smaller than the value of TotalTargetCapacity, the auto provisioning group will create instances of the specified type to meet the capacity requirements. Valid values:PayAsYouGo: Pay-as-you-go instances; Spot: Preemptible instances, Default value: Spot.

description: pulumi.Output[str] = None¶

The description of the auto provisioning group.

excess_capacity_termination_policy: pulumi.Output[str] = None¶

The shutdown policy for excess preemptible instances followed when the capacity of the auto provisioning group exceeds the target capacity. Valid values: no-termination and termination,Default value: no-termination.

launch_template_configs: pulumi.Output[list] = None¶

DataDisk mappings to attach to ecs instance. See Block config below for details.

• instance_type (str)

• maxPrice (str)

• priority (str)

• vswitch_id (str)

• weightedCapacity (str)

launch_template_id: pulumi.Output[str] = None¶

The ID of the instance launch template associated with the auto provisioning group.

launch_template_version: pulumi.Output[str] = None¶

The version of the instance launch template associated with the auto provisioning group.

max_spot_price: pulumi.Output[float] = None¶

The global maximum price for preemptible instances in the auto provisioning group. If both the MaxSpotPrice and LaunchTemplateConfig.N.MaxPrice parameters are specified, the maximum price is the lower value of the two.

pay_as_you_go_allocation_strategy: pulumi.Output[str] = None¶

The scale-out policy for pay-as-you-go instances. Valid values: lowest-price and prioritized,Default value: lowest-price.

pay_as_you_go_target_capacity: pulumi.Output[str] = None¶

The target capacity of pay-as-you-go instances in the auto provisioning group.

spot_allocation_strategy: pulumi.Output[str] = None¶

The scale-out policy for preemptible instances. Valid values:lowest-price and diversified,Default value: lowest-price.

spot_instance_interruption_behavior: pulumi.Output[str] = None¶

The default behavior after preemptible instances are shut down. Value values: stop and terminate,Default value: stop.

spot_instance_pools_to_use_count: pulumi.Output[float] = None¶

This parameter takes effect when the SpotAllocationStrategy parameter is set to lowest-price. The auto provisioning group selects instance types of the lowest cost to create instances.

spot_target_capacity: pulumi.Output[str] = None¶

The target capacity of preemptible instances in the auto provisioning group.

terminate_instances: pulumi.Output[bool] = None¶

Specifies whether to release instances of the auto provisioning group. Valid values:false and true, default value: false.

terminate_instances_with_expiration: pulumi.Output[bool] = None¶

The shutdown policy for preemptible instances when the auto provisioning group expires. Valid values: false and true, default value: false.

total_target_capacity: pulumi.Output[str] = None¶

The total target capacity of the auto provisioning group. The target capacity consists of the following three parts:PayAsYouGoTargetCapacity,SpotTargetCapacity and the supplemental capacity besides PayAsYouGoTargetCapacity and SpotTargetCapacity.

valid_from: pulumi.Output[str] = None¶

The time when the auto provisioning group is started. The period of time between this point in time and the point in time specified by the valid_until parameter is the effective time period of the auto provisioning group.By default, an auto provisioning group is immediately started after creation.

valid_until: pulumi.Output[str] = None¶

The time when the auto provisioning group expires. The period of time between this point in time and the point in time specified by the valid_from parameter is the effective time period of the auto provisioning group.By default, an auto provisioning group never expires.

static get(resource_name, id, opts=None, auto_provisioning_group_name=None, auto_provisioning_group_type=None, default_target_capacity_type=None, description=None, excess_capacity_termination_policy=None, launch_template_configs=None, launch_template_id=None, launch_template_version=None, max_spot_price=None, pay_as_you_go_allocation_strategy=None, pay_as_you_go_target_capacity=None, spot_allocation_strategy=None, spot_instance_interruption_behavior=None, spot_instance_pools_to_use_count=None, spot_target_capacity=None, terminate_instances=None, terminate_instances_with_expiration=None, total_target_capacity=None, valid_from=None, valid_until=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• default_target_capacity_type (pulumi.Input[str]) – The type of supplemental instances. When the total value of PayAsYouGoTargetCapacity and SpotTargetCapacity is smaller than the value of TotalTargetCapacity, the auto provisioning group will create instances of the specified type to meet the capacity requirements. Valid values:PayAsYouGo: Pay-as-you-go instances; Spot: Preemptible instances, Default value: Spot.

• description (pulumi.Input[str]) – The description of the auto provisioning group.

• excess_capacity_termination_policy (pulumi.Input[str]) – The shutdown policy for excess preemptible instances followed when the capacity of the auto provisioning group exceeds the target capacity. Valid values: no-termination and termination,Default value: no-termination.

• launch_template_configs (pulumi.Input[list]) – DataDisk mappings to attach to ecs instance. See Block config below for details.

• launch_template_id (pulumi.Input[str]) – The ID of the instance launch template associated with the auto provisioning group.

• launch_template_version (pulumi.Input[str]) – The version of the instance launch template associated with the auto provisioning group.

• max_spot_price (pulumi.Input[float]) – The global maximum price for preemptible instances in the auto provisioning group. If both the MaxSpotPrice and LaunchTemplateConfig.N.MaxPrice parameters are specified, the maximum price is the lower value of the two.

• pay_as_you_go_allocation_strategy (pulumi.Input[str]) – The scale-out policy for pay-as-you-go instances. Valid values: lowest-price and prioritized,Default value: lowest-price.

• pay_as_you_go_target_capacity (pulumi.Input[str]) – The target capacity of pay-as-you-go instances in the auto provisioning group.

• spot_allocation_strategy (pulumi.Input[str]) – The scale-out policy for preemptible instances. Valid values:lowest-price and diversified,Default value: lowest-price.

• spot_instance_interruption_behavior (pulumi.Input[str]) – The default behavior after preemptible instances are shut down. Value values: stop and terminate,Default value: stop.

• spot_instance_pools_to_use_count (pulumi.Input[float]) – This parameter takes effect when the SpotAllocationStrategy parameter is set to lowest-price. The auto provisioning group selects instance types of the lowest cost to create instances.

• spot_target_capacity (pulumi.Input[str]) – The target capacity of preemptible instances in the auto provisioning group.

• terminate_instances (pulumi.Input[bool]) – Specifies whether to release instances of the auto provisioning group. Valid values:false and true, default value: false.

• terminate_instances_with_expiration (pulumi.Input[bool]) – The shutdown policy for preemptible instances when the auto provisioning group expires. Valid values: false and true, default value: false.

• total_target_capacity (pulumi.Input[str]) – The total target capacity of the auto provisioning group. The target capacity consists of the following three parts:PayAsYouGoTargetCapacity,SpotTargetCapacity and the supplemental capacity besides PayAsYouGoTargetCapacity and SpotTargetCapacity.

• valid_from (pulumi.Input[str]) – The time when the auto provisioning group is started. The period of time between this point in time and the point in time specified by the valid_until parameter is the effective time period of the auto provisioning group.By default, an auto provisioning group is immediately started after creation.

• valid_until (pulumi.Input[str]) – The time when the auto provisioning group expires. The period of time between this point in time and the point in time specified by the valid_from parameter is the effective time period of the auto provisioning group.By default, an auto provisioning group never expires.

The launch_template_configs object supports the following:

• instance_type (pulumi.Input[str])

• maxPrice (pulumi.Input[str])

• priority (pulumi.Input[str])

• vswitch_id (pulumi.Input[str])

• weightedCapacity (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.AwaitableGetDisksResult(category=None, disks=None, encrypted=None, id=None, ids=None, instance_id=None, name_regex=None, output_file=None, resource_group_id=None, tags=None, type=None)¶

class pulumi_alicloud.ecs.AwaitableGetEipsResult(eips=None, id=None, ids=None, in_use=None, ip_addresses=None, names=None, output_file=None, resource_group_id=None, tags=None)¶

class pulumi_alicloud.ecs.AwaitableGetImagesResult(id=None, ids=None, images=None, most_recent=None, name_regex=None, output_file=None, owners=None)¶

class pulumi_alicloud.ecs.AwaitableGetInstanceTypeFamiliesResult(families=None, generation=None, id=None, ids=None, instance_charge_type=None, output_file=None, spot_strategy=None, zone_id=None)¶

class pulumi_alicloud.ecs.AwaitableGetInstanceTypesResult(availability_zone=None, cpu_core_count=None, eni_amount=None, gpu_amount=None, gpu_spec=None, id=None, ids=None, instance_charge_type=None, instance_type_family=None, instance_types=None, is_outdated=None, kubernetes_node_role=None, memory_size=None, network_type=None, output_file=None, sorted_by=None, spot_strategy=None)¶

class pulumi_alicloud.ecs.AwaitableGetInstancesResult(availability_zone=None, id=None, ids=None, image_id=None, instances=None, name_regex=None, names=None, output_file=None, ram_role_name=None, resource_group_id=None, status=None, tags=None, vpc_id=None, vswitch_id=None)¶

class pulumi_alicloud.ecs.AwaitableGetKeyPairsResult(finger_print=None, id=None, ids=None, key_pairs=None, name_regex=None, names=None, output_file=None, resource_group_id=None, tags=None)¶

class pulumi_alicloud.ecs.AwaitableGetNetworkInterfacesResult(id=None, ids=None, instance_id=None, interfaces=None, name_regex=None, names=None, output_file=None, private_ip=None, resource_group_id=None, security_group_id=None, tags=None, type=None, vpc_id=None, vswitch_id=None)¶

class pulumi_alicloud.ecs.AwaitableGetSecurityGroupRulesResult(direction=None, group_desc=None, group_id=None, group_name=None, id=None, ip_protocol=None, nic_type=None, output_file=None, policy=None, rules=None)¶

class pulumi_alicloud.ecs.AwaitableGetSecurityGroupsResult(groups=None, id=None, ids=None, name_regex=None, names=None, output_file=None, resource_group_id=None, tags=None, vpc_id=None)¶

class pulumi_alicloud.ecs.AwaitableGetSnapshotsResult(disk_id=None, encrypted=None, id=None, ids=None, instance_id=None, name_regex=None, names=None, output_file=None, snapshots=None, source_disk_type=None, status=None, tags=None, type=None, usage=None)¶

class pulumi_alicloud.ecs.CopyImage(resource_name, opts=None, description=None, encrypted=None, force=None, image_name=None, kms_key_id=None, name=None, source_image_id=None, source_region_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Create a CopyImage resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, description=None, encrypted=None, force=None, image_name=None, kms_key_id=None, name=None, source_image_id=None, source_region_id=None, tags=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.Disk(resource_name, opts=None, availability_zone=None, category=None, delete_auto_snapshot=None, delete_with_instance=None, description=None, enable_auto_snapshot=None, encrypted=None, kms_key_id=None, name=None, resource_group_id=None, size=None, snapshot_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Create a Disk resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] availability_zone: The Zone to create the disk in. :param pulumi.Input[str] category: Category of the disk. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd. Default is cloud_efficiency. :param pulumi.Input[bool] delete_auto_snapshot: Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false. :param pulumi.Input[bool] delete_with_instance: Indicates whether the disk is released together with the instance: Default value: false. :param pulumi.Input[str] description: 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. :param pulumi.Input[bool] enable_auto_snapshot: Indicates whether to apply a created automatic snapshot policy to the disk. Default value: false. :param pulumi.Input[bool] encrypted: If true, the disk will be encrypted, conflict with snapshot_id. :param pulumi.Input[str] kms_keyid: The ID of the KMS key corresponding to the data disk, The specified parameter ``Encrypted`` must be ``true`` when KmsKeyId is not empty. :param pulumi.Input[str] name: 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. :param pulumi.Input[str] resource_group_id: The Id of resource group which the disk belongs.

> **NOTE:** Disk category `cloud` has been outdated and it only can be used none I/O Optimized ECS instances. Recommend `cloud_efficiency` and `cloud_ssd` disk.

Parameters

• size (pulumi.Input[float]) – 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 (pulumi.Input[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.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

availability_zone: pulumi.Output[str] = None¶

The Zone to create the disk in.

category: pulumi.Output[str] = None¶

Category of the disk. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd. Default is cloud_efficiency.

delete_auto_snapshot: pulumi.Output[bool] = None¶

Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.

delete_with_instance: pulumi.Output[bool] = None¶

Indicates whether the disk is released together with the instance: Default value: false.

description: pulumi.Output[str] = None¶

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.

enable_auto_snapshot: pulumi.Output[bool] = None¶

Indicates whether to apply a created automatic snapshot policy to the disk. Default value: false.

encrypted: pulumi.Output[bool] = None¶

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

kms_key_id: pulumi.Output[str] = None¶

The ID of the KMS key corresponding to the data disk, The specified parameter Encrypted must be true when KmsKeyId is not empty.

name: pulumi.Output[str] = None¶

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.

resource_group_id: pulumi.Output[str] = None¶

The Id of resource group which the disk belongs.

NOTE: Disk category cloud has been outdated and it only can be used none I/O Optimized ECS instances. Recommend cloud_efficiency and cloud_ssd disk.

size: pulumi.Output[float] = None¶

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: pulumi.Output[str] = None¶

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: pulumi.Output[str] = None¶

The disk status.

tags: pulumi.Output[dict] = None¶

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, availability_zone=None, category=None, delete_auto_snapshot=None, delete_with_instance=None, description=None, enable_auto_snapshot=None, encrypted=None, kms_key_id=None, name=None, resource_group_id=None, size=None, snapshot_id=None, status=None, tags=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• availability_zone (pulumi.Input[str]) – The Zone to create the disk in.

• category (pulumi.Input[str]) – Category of the disk. Valid values are cloud, cloud_efficiency, cloud_ssd, cloud_essd. Default is cloud_efficiency.

• delete_auto_snapshot (pulumi.Input[bool]) – Indicates whether the automatic snapshot is deleted when the disk is released. Default value: false.

• delete_with_instance (pulumi.Input[bool]) – Indicates whether the disk is released together with the instance: Default value: false.

• description (pulumi.Input[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.

• enable_auto_snapshot (pulumi.Input[bool]) – Indicates whether to apply a created automatic snapshot policy to the disk. Default value: false.

• encrypted (pulumi.Input[bool]) – If true, the disk will be encrypted, conflict with snapshot_id.

• kms_key*id (pulumi.Input[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 (pulumi.Input[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.

• resource_group_id (pulumi.Input[str]) – The Id of resource group which the disk belongs.

> **NOTE:** Disk category `cloud` has been outdated and it only can be used none I/O Optimized ECS instances. Recommend `cloud_efficiency` and `cloud_ssd` disk.

Parameters

• size (pulumi.Input[float]) – 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 (pulumi.Input[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 (pulumi.Input[str]) – The disk status.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.DiskAttachment(resource_name, opts=None, device_name=None, disk_id=None, instance_id=None, __props__=None, __name__=None, __opts__=None)¶

Create a DiskAttachment resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] device_name: The device name has been deprecated, and when attaching disk, it will be allocated automatically by system according to default order from /dev/xvdb to /dev/xvdz. :param pulumi.Input[str] disk_id: ID of the Disk to be attached. :param pulumi.Input[str] instance_id: ID of the Instance to attach to.

device_name: pulumi.Output[str] = None¶

The device name has been deprecated, and when attaching disk, it will be allocated automatically by system according to default order from /dev/xvdb to /dev/xvdz.

disk_id: pulumi.Output[str] = None¶

ID of the Disk to be attached.

instance_id: pulumi.Output[str] = None¶

ID of the Instance to attach to.

static get(resource_name, id, opts=None, device_name=None, disk_id=None, instance_id=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• device_name (pulumi.Input[str]) – The device name has been deprecated, and when attaching disk, it will be allocated automatically by system according to default order from /dev/xvdb to /dev/xvdz.

• disk_id (pulumi.Input[str]) – ID of the Disk to be attached.

• instance_id (pulumi.Input[str]) – ID of the Instance to attach to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.Eip(resource_name, opts=None, bandwidth=None, description=None, instance_charge_type=None, internet_charge_type=None, isp=None, name=None, period=None, resource_group_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Create a Eip resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[float] bandwidth: Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). If this value is not specified, then automatically sets it to 5 Mbps. :param pulumi.Input[str] description: Description of the EIP instance, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null. :param pulumi.Input[str] instance_charge_type: Elastic IP instance charge type. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. :param pulumi.Input[str] internet_charge_type: Internet charge type of the EIP, Valid values are PayByBandwidth, PayByTraffic. Default to PayByBandwidth. From version 1.7.1, default to PayByTraffic. It is only PayByBandwidth when instance_charge_type is PrePaid. :param pulumi.Input[str] isp: The line type of the Elastic IP instance. Default to BGP. Other type of the isp need to open a whitelist. :param pulumi.Input[str] name: The name of the EIP instance. 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://. :param pulumi.Input[float] period: The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid.

Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

Parameters

• resource_group_id (pulumi.Input[str]) – The Id of resource group which the eip belongs.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

bandwidth: pulumi.Output[float] = None¶

Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). If this value is not specified, then automatically sets it to 5 Mbps.

description: pulumi.Output[str] = None¶

Description of the EIP instance, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.

instance_charge_type: pulumi.Output[str] = None¶

Elastic IP instance charge type. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

internet_charge_type: pulumi.Output[str] = None¶

Internet charge type of the EIP, Valid values are PayByBandwidth, PayByTraffic. Default to PayByBandwidth. From version 1.7.1, default to PayByTraffic. It is only PayByBandwidth when instance_charge_type is PrePaid.

ip_address: pulumi.Output[str] = None¶

The elastic ip address

isp: pulumi.Output[str] = None¶

The line type of the Elastic IP instance. Default to BGP. Other type of the isp need to open a whitelist.

name: pulumi.Output[str] = None¶

The name of the EIP instance. 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://.

period: pulumi.Output[float] = None¶

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

resource_group_id: pulumi.Output[str] = None¶

The Id of resource group which the eip belongs.

status: pulumi.Output[str] = None¶

The EIP current status.

tags: pulumi.Output[dict] = None¶

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, bandwidth=None, description=None, instance_charge_type=None, internet_charge_type=None, ip_address=None, isp=None, name=None, period=None, resource_group_id=None, status=None, tags=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• bandwidth (pulumi.Input[float]) – Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). If this value is not specified, then automatically sets it to 5 Mbps.

• description (pulumi.Input[str]) – Description of the EIP instance, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.

• instance_charge_type (pulumi.Input[str]) – Elastic IP instance charge type. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

• internet_charge_type (pulumi.Input[str]) – Internet charge type of the EIP, Valid values are PayByBandwidth, PayByTraffic. Default to PayByBandwidth. From version 1.7.1, default to PayByTraffic. It is only PayByBandwidth when instance_charge_type is PrePaid.

• ip*address (pulumi.Input[str]) –

  The elastic ip address

• isp (pulumi.Input[str]) – The line type of the Elastic IP instance. Default to BGP. Other type of the isp need to open a whitelist.

• name (pulumi.Input[str]) – The name of the EIP instance. 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://.

• period (pulumi.Input[float]) – The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

• resource_group_id (pulumi.Input[str]) – The Id of resource group which the eip belongs.

• status (pulumi.Input[str]) – The EIP current status.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.EipAssociation(resource_name, opts=None, allocation_id=None, instance_id=None, instance_type=None, private_ip_address=None, __props__=None, __name__=None, __opts__=None)¶

Create a EipAssociation resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] allocation_id: The allocation EIP ID. :param pulumi.Input[str] instance_id: The ID of the ECS or SLB instance or Nat Gateway. :param pulumi.Input[str] instance_type: The type of cloud product that the eip instance to bind. :param pulumi.Input[str] private_ip_address: The private IP address in the network segment of the vswitch which has been assigned.

allocation_id: pulumi.Output[str] = None¶

The allocation EIP ID.

instance_id: pulumi.Output[str] = None¶

The ID of the ECS or SLB instance or Nat Gateway.

instance_type: pulumi.Output[str] = None¶

The type of cloud product that the eip instance to bind.

private_ip_address: pulumi.Output[str] = None¶

The private IP address in the network segment of the vswitch which has been assigned.

static get(resource_name, id, opts=None, allocation_id=None, instance_id=None, instance_type=None, private_ip_address=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• allocation_id (pulumi.Input[str]) – The allocation EIP ID.

• instance_id (pulumi.Input[str]) – The ID of the ECS or SLB instance or Nat Gateway.

• instance_type (pulumi.Input[str]) – The type of cloud product that the eip instance to bind.

• private_ip_address (pulumi.Input[str]) – The private IP address in the network segment of the vswitch which has been assigned.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.GetDisksResult(category=None, disks=None, encrypted=None, id=None, ids=None, instance_id=None, name_regex=None, output_file=None, resource_group_id=None, tags=None, type=None)¶

A collection of values returned by getDisks.

category = None¶

Disk category. Possible values: cloud (basic cloud disk), cloud_efficiency (ultra cloud disk), ephemeral_ssd (local SSD cloud disk), cloud_ssd (SSD cloud disk), and cloud_essd (ESSD cloud disk).

disks = None¶

A list of disks. Each element contains the following attributes:

encrypted = None¶

Indicate whether the disk is encrypted or not. Possible values: on and off.

id = None¶

The provider-assigned unique ID for this managed resource.

instance_id = None¶

ID of the related instance. It is null unless the status is In_use.

resource_group_id = None¶

The Id of resource group.

tags = None¶

A map of tags assigned to the disk.

type = None¶

Disk type. Possible values: system and data.

class pulumi_alicloud.ecs.GetEipsResult(eips=None, id=None, ids=None, in_use=None, ip_addresses=None, names=None, output_file=None, resource_group_id=None, tags=None)¶

A collection of values returned by getEips.

eips = None¶

A list of EIPs. Each element contains the following attributes:

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

(Optional) A list of EIP IDs.

names = None¶

(Optional) A list of EIP names.

resource_group_id = None¶

The Id of resource group which the eips belongs.

class pulumi_alicloud.ecs.GetImagesResult(id=None, ids=None, images=None, most_recent=None, name_regex=None, output_file=None, owners=None)¶

A collection of values returned by getImages.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of image IDs.

images = None¶

A list of images. Each element contains the following attributes:

class pulumi_alicloud.ecs.GetInstanceTypeFamiliesResult(families=None, generation=None, id=None, ids=None, instance_charge_type=None, output_file=None, spot_strategy=None, zone_id=None)¶

A collection of values returned by getInstanceTypeFamilies.

generation = None¶

The generation of the instance type family.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of instance type family IDs.

class pulumi_alicloud.ecs.GetInstanceTypesResult(availability_zone=None, cpu_core_count=None, eni_amount=None, gpu_amount=None, gpu_spec=None, id=None, ids=None, instance_charge_type=None, instance_type_family=None, instance_types=None, is_outdated=None, kubernetes_node_role=None, memory_size=None, network_type=None, output_file=None, sorted_by=None, spot_strategy=None)¶

A collection of values returned by getInstanceTypes.

cpu_core_count = None¶

Number of CPU cores.

eni_amount = None¶

The maximum number of network interfaces that an instance type can be attached to.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of instance type IDs.

instance_types = None¶

A list of image types. Each element contains the following attributes:

memory_size = None¶

Size of memory, measured in GB.

class pulumi_alicloud.ecs.GetInstancesResult(availability_zone=None, id=None, ids=None, image_id=None, instances=None, name_regex=None, names=None, output_file=None, ram_role_name=None, resource_group_id=None, status=None, tags=None, vpc_id=None, vswitch_id=None)¶

A collection of values returned by getInstances.

availability_zone = None¶

Availability zone the instance belongs to.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of ECS instance IDs.

image_id = None¶

Image ID the instance is using.

instances = None¶

A list of instances. Each element contains the following attributes:

names = None¶

A list of instances names.

ram_role_name = None¶

The Ram role name.

resource_group_id = None¶

The Id of resource group.

status = None¶

Instance current status.

tags = None¶

A map of tags assigned to the ECS instance.

vpc_id = None¶

ID of the VPC the instance belongs to.

vswitch_id = None¶

ID of the VSwitch the instance belongs to.

class pulumi_alicloud.ecs.GetKeyPairsResult(finger_print=None, id=None, ids=None, key_pairs=None, name_regex=None, names=None, output_file=None, resource_group_id=None, tags=None)¶

A collection of values returned by getKeyPairs.

finger_print = None¶

Finger print of the key pair.

id = None¶

The provider-assigned unique ID for this managed resource.

key_pairs = None¶

A list of key pairs. Each element contains the following attributes:

names = None¶

A list of key pair names.

resource_group_id = None¶

The Id of resource group.

tags = None¶

(Optional, Available in v1.66.0+) A mapping of tags to assign to the resource.

class pulumi_alicloud.ecs.GetNetworkInterfacesResult(id=None, ids=None, instance_id=None, interfaces=None, name_regex=None, names=None, output_file=None, private_ip=None, resource_group_id=None, security_group_id=None, tags=None, type=None, vpc_id=None, vswitch_id=None)¶

A collection of values returned by getNetworkInterfaces.

id = None¶

The provider-assigned unique ID for this managed resource.

instance_id = None¶

ID of the instance that the ENI is attached to.

interfaces = None¶

A list of ENIs. Each element contains the following attributes:

private_ip = None¶

Primary private IP of the ENI.

resource_group_id = None¶

The Id of resource group.

tags = None¶

A map of tags assigned to the ENI.

vpc_id = None¶

ID of the VPC that the ENI belongs to.

vswitch_id = None¶

ID of the VSwitch that the ENI is linked to.

class pulumi_alicloud.ecs.GetSecurityGroupRulesResult(direction=None, group_desc=None, group_id=None, group_name=None, id=None, ip_protocol=None, nic_type=None, output_file=None, policy=None, rules=None)¶

A collection of values returned by getSecurityGroupRules.

direction = None¶

Authorization direction, ingress or egress.

group_desc = None¶

The description of the security group that owns the rules.

group_name = None¶

The name of the security group that owns the rules.

id = None¶

The provider-assigned unique ID for this managed resource.

ip_protocol = None¶

The protocol. Can be tcp, udp, icmp, gre or all.

nic_type = None¶

Network type, internet or intranet.

policy = None¶

Authorization policy. Can be either accept or drop.

rules = None¶

A list of security group rules. Each element contains the following attributes:

class pulumi_alicloud.ecs.GetSecurityGroupsResult(groups=None, id=None, ids=None, name_regex=None, names=None, output_file=None, resource_group_id=None, tags=None, vpc_id=None)¶

A collection of values returned by getSecurityGroups.

groups = None¶

A list of Security Groups. Each element contains the following attributes:

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of Security Group IDs.

names = None¶

A list of Security Group names.

resource_group_id = None¶

The Id of resource group which the security_group belongs.

tags = None¶

A map of tags assigned to the ECS instance.

vpc_id = None¶

The ID of the VPC that owns the security group.

class pulumi_alicloud.ecs.GetSnapshotsResult(disk_id=None, encrypted=None, id=None, ids=None, instance_id=None, name_regex=None, names=None, output_file=None, snapshots=None, source_disk_type=None, status=None, tags=None, type=None, usage=None)¶

A collection of values returned by getSnapshots.

encrypted = None¶

Whether the snapshot is encrypted or not.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of snapshot IDs.

names = None¶

A list of snapshots names.

snapshots = None¶

A list of snapshots. Each element contains the following attributes:

source_disk_type = None¶

Source disk attribute. Value range:

• System

• Data

status = None¶

The snapshot status. Value range:

• progressing

• accomplished

• failed

tags = None¶

A map of tags assigned to the snapshot.

usage = None¶

Whether the snapshots are used to create resources or not. Value range:

• image

• disk

• image_disk

• none

class pulumi_alicloud.ecs.Image(resource_name, opts=None, architecture=None, description=None, disk_device_mappings=None, force=None, image_name=None, instance_id=None, name=None, platform=None, resource_group_id=None, snapshot_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Creates a custom image. You can then use a custom image to create ECS instances (RunInstances) or change the system disk for an existing instance (ReplaceSystemDisk).

NOTE: If you want to create a template from an ECS instance, you can specify the instance ID (InstanceId) to create a custom image. You must make sure that the status of the specified instance is Running or Stopped. After a successful invocation, each disk of the specified instance has a new snapshot created.

NOTE: If you want to create a custom image based on the system disk of your ECS instance, you can specify one of the system disk snapshots (SnapshotId) to create a custom image. However, the specified snapshot cannot be created on or before July 15, 2013.

NOTE: If you want to combine snapshots of multiple disks into an image template, you can specify DiskDeviceMapping to create a custom image.

NOTE: Available in 1.64.0+

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.ecs.Image("default",
    architecture="x86_64",
    description="test-image",
    image_name="test-image",
    instance_id="i-bp1g6zv0ce8oghu7k***",
    platform="CentOS",
    resource_group_id="rg-bp67acfmxazb4ph***",
    tags={
        "FinanceDept": "FinanceDeptJoshua",
    })

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• architecture (pulumi.Input[str]) – Specifies the architecture of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: i386 , Default is x86_64.

• description (pulumi.Input[str]) – The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.

• disk_device_mappings (pulumi.Input[list]) – Description of the system with disks and snapshots under the image.

• force (pulumi.Input[bool]) – Indicates whether to force delete the custom image, Default is false.

- true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
- false：Verifies that the image is not currently in use by any other instances before deleting the image.

Parameters

• image*name (pulumi.Input[str]) –

  The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (*), or hyphens (-). Default value: null.

• instance_id (pulumi.Input[str]) – The instance ID.

• platform (pulumi.Input[str]) – Specifies the operating system platform of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: CentOS, Ubuntu, SUSE, OpenSUSE, RedHat, Debian, CoreOS, Aliyun Linux, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows 7, Default is Others Linux, Customized Linux.

• resource_group_id (pulumi.Input[str]) – The ID of the enterprise resource group to which a custom image belongs

• snapshot_id (pulumi.Input[str]) – Specifies a snapshot that is used to create a combined custom image.

• tags (pulumi.Input[dict]) – The tag value of an image. The value of N ranges from 1 to 20.

The disk_device_mappings object supports the following:

• device (pulumi.Input[str]) - Specifies the name of a disk in the combined custom image. Value range: /dev/xvda to /dev/xvdz.

• disk_type (pulumi.Input[str]) - Specifies the type of a disk in the combined custom image. If you specify this parameter, you can use a data disk snapshot as the data source of a system disk for creating an image. If it is not specified, the disk type is determined by the corresponding snapshot. Valid values: system, data,

• size (pulumi.Input[float]) - Specifies the size of a disk in the combined custom image, in GiB. Value range: 5 to 2000.

• snapshot_id (pulumi.Input[str]) - Specifies a snapshot that is used to create a combined custom image.

architecture: pulumi.Output[str] = None¶

Specifies the architecture of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: i386 , Default is x86_64.

description: pulumi.Output[str] = None¶

The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.

disk_device_mappings: pulumi.Output[list] = None¶

Description of the system with disks and snapshots under the image.

• device (str) - Specifies the name of a disk in the combined custom image. Value range: /dev/xvda to /dev/xvdz.

• disk_type (str) - Specifies the type of a disk in the combined custom image. If you specify this parameter, you can use a data disk snapshot as the data source of a system disk for creating an image. If it is not specified, the disk type is determined by the corresponding snapshot. Valid values: system, data,

• size (float) - Specifies the size of a disk in the combined custom image, in GiB. Value range: 5 to 2000.

• snapshot_id (str) - Specifies a snapshot that is used to create a combined custom image.

force: pulumi.Output[bool] = None¶

Indicates whether to force delete the custom image, Default is false.

• true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.

• false：Verifies that the image is not currently in use by any other instances before deleting the image.

image_name: pulumi.Output[str] = None¶

The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.

instance_id: pulumi.Output[str] = None¶

The instance ID.

platform: pulumi.Output[str] = None¶

Specifies the operating system platform of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: CentOS, Ubuntu, SUSE, OpenSUSE, RedHat, Debian, CoreOS, Aliyun Linux, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows 7, Default is Others Linux, Customized Linux.

resource_group_id: pulumi.Output[str] = None¶

The ID of the enterprise resource group to which a custom image belongs

snapshot_id: pulumi.Output[str] = None¶

Specifies a snapshot that is used to create a combined custom image.

tags: pulumi.Output[dict] = None¶

The tag value of an image. The value of N ranges from 1 to 20.

static get(resource_name, id, opts=None, architecture=None, description=None, disk_device_mappings=None, force=None, image_name=None, instance_id=None, name=None, platform=None, resource_group_id=None, snapshot_id=None, tags=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• architecture (pulumi.Input[str]) – Specifies the architecture of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: i386 , Default is x86_64.

• description (pulumi.Input[str]) – The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.

• disk_device_mappings (pulumi.Input[list]) – Description of the system with disks and snapshots under the image.

• force (pulumi.Input[bool]) – Indicates whether to force delete the custom image, Default is false.

- true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
- false：Verifies that the image is not currently in use by any other instances before deleting the image.

Parameters

• image*name (pulumi.Input[str]) –

  The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (*), or hyphens (-). Default value: null.

• instance_id (pulumi.Input[str]) – The instance ID.

• platform (pulumi.Input[str]) – Specifies the operating system platform of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: CentOS, Ubuntu, SUSE, OpenSUSE, RedHat, Debian, CoreOS, Aliyun Linux, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows 7, Default is Others Linux, Customized Linux.

• resource_group_id (pulumi.Input[str]) – The ID of the enterprise resource group to which a custom image belongs

• snapshot_id (pulumi.Input[str]) – Specifies a snapshot that is used to create a combined custom image.

• tags (pulumi.Input[dict]) – The tag value of an image. The value of N ranges from 1 to 20.

The disk_device_mappings object supports the following:

• device (pulumi.Input[str]) - Specifies the name of a disk in the combined custom image. Value range: /dev/xvda to /dev/xvdz.

• disk_type (pulumi.Input[str]) - Specifies the type of a disk in the combined custom image. If you specify this parameter, you can use a data disk snapshot as the data source of a system disk for creating an image. If it is not specified, the disk type is determined by the corresponding snapshot. Valid values: system, data,

• size (pulumi.Input[float]) - Specifies the size of a disk in the combined custom image, in GiB. Value range: 5 to 2000.

• snapshot_id (pulumi.Input[str]) - Specifies a snapshot that is used to create a combined custom image.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.ImageCopy(resource_name, opts=None, description=None, encrypted=None, force=None, image_name=None, kms_key_id=None, name=None, source_image_id=None, source_region_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Copies a custom image from one region to another. You can use copied images to perform operations in the target region, such as creating instances (RunInstances) and replacing system disks (ReplaceSystemDisk).

NOTE: You can only copy the custom image when it is in the Available state.

NOTE: You can only copy the image belonging to your Alibaba Cloud account. Images cannot be copied from one account to another.

NOTE: If the copying is not completed, you cannot call DeleteImage to delete the image but you can call CancelCopyImage to cancel the copying.

NOTE: Available in 1.66.0+.

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.ecs.ImageCopy("default",
    description="test-image",
    image_name="test-image",
    source_image_id="m-bp1gxyhdswlsn18tu***",
    source_region_id="cn-hangzhou",
    tags={
        "FinanceDept": "FinanceDeptJoshua",
    })

The following attributes are exported:

• id - ID of the image.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• description (pulumi.Input[str]) – The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.

• encrypted (pulumi.Input[bool]) – Indicates whether to encrypt the image.

• force (pulumi.Input[bool]) – Indicates whether to force delete the custom image, Default is false.

- true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
- false：Verifies that the image is not currently in use by any other instances before deleting the image.

Parameters

• image*name (pulumi.Input[str]) –

  The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (*), or hyphens (-). Default value: null.

• kms_key_id (pulumi.Input[str]) – Key ID used to encrypt the image.

• source_image_id (pulumi.Input[str]) – The source image ID.

• source_region_id (pulumi.Input[str]) – The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.

• tags (pulumi.Input[dict]) – The tag value of an image. The value of N ranges from 1 to 20.

description: pulumi.Output[str] = None¶

The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.

encrypted: pulumi.Output[bool] = None¶

Indicates whether to encrypt the image.

force: pulumi.Output[bool] = None¶

Indicates whether to force delete the custom image, Default is false.

• true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.

• false：Verifies that the image is not currently in use by any other instances before deleting the image.

image_name: pulumi.Output[str] = None¶

The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.

kms_key_id: pulumi.Output[str] = None¶

Key ID used to encrypt the image.

source_image_id: pulumi.Output[str] = None¶

The source image ID.

source_region_id: pulumi.Output[str] = None¶

The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.

tags: pulumi.Output[dict] = None¶

The tag value of an image. The value of N ranges from 1 to 20.

static get(resource_name, id, opts=None, description=None, encrypted=None, force=None, image_name=None, kms_key_id=None, name=None, source_image_id=None, source_region_id=None, tags=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• description (pulumi.Input[str]) – The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.

• encrypted (pulumi.Input[bool]) – Indicates whether to encrypt the image.

• force (pulumi.Input[bool]) – Indicates whether to force delete the custom image, Default is false.

- true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
- false：Verifies that the image is not currently in use by any other instances before deleting the image.

Parameters

• image*name (pulumi.Input[str]) –

  The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (*), or hyphens (-). Default value: null.

• kms_key_id (pulumi.Input[str]) – Key ID used to encrypt the image.

• source_image_id (pulumi.Input[str]) – The source image ID.

• source_region_id (pulumi.Input[str]) –

  The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.

• tags (pulumi.Input[dict]) – The tag value of an image. The value of N ranges from 1 to 20.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.ImageExport(resource_name, opts=None, image_id=None, oss_bucket=None, oss_prefix=None, __props__=None, __name__=None, __opts__=None)¶

Export a custom image to the OSS bucket in the same region as the custom image.

NOTE: If you create an ECS instance using a mirror image and create a system disk snapshot again, exporting a custom image created from the system disk snapshot is not supported.

NOTE: Support for exporting custom images that include data disk snapshot information in the image. The number of data disks cannot exceed 4 and the maximum capacity of a single data disk cannot exceed 500 GiB.

NOTE: Before exporting the image, you must authorize the cloud server ECS official service account to write OSS permissions through RAM.

NOTE: Available in 1.68.0+.

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.ecs.ImageExport("default",
    image_id="m-bp1gxy***",
    oss_bucket="ecsimageexportconfig",
    oss_prefix="ecsExport")

The following attributes are exported:

• id - ID of the image.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• image_id (pulumi.Input[str]) – The source image ID.

• oss_bucket (pulumi.Input[str]) – Save the exported OSS bucket.

• oss_prefix (pulumi.Input[str]) – The prefix of your OSS Object. It can be composed of numbers or letters, and the character length is 1 ~ 30.

image_id: pulumi.Output[str] = None¶

The source image ID.

oss_bucket: pulumi.Output[str] = None¶

Save the exported OSS bucket.

oss_prefix: pulumi.Output[str] = None¶

The prefix of your OSS Object. It can be composed of numbers or letters, and the character length is 1 ~ 30.

static get(resource_name, id, opts=None, image_id=None, oss_bucket=None, oss_prefix=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• image_id (pulumi.Input[str]) – The source image ID.

• oss_bucket (pulumi.Input[str]) – Save the exported OSS bucket.

• oss_prefix (pulumi.Input[str]) – The prefix of your OSS Object. It can be composed of numbers or letters, and the character length is 1 ~ 30.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.ImageImport(resource_name, opts=None, architecture=None, description=None, disk_device_mappings=None, image_name=None, license_type=None, os_type=None, platform=None, __props__=None, __name__=None, __opts__=None)¶

Import a copy of your local on-premise file to ECS, and appear as a custom replacement in the corresponding domain.

NOTE: You must upload the image file to the object storage OSS in advance.

NOTE: The region where the image is imported must be the same region as the OSS bucket where the image file is uploaded.

NOTE: Available in 1.69.0+.

import pulumi
import pulumi_alicloud as alicloud

this = alicloud.ecs.ImageImport("this",
    architecture="x86_64",
    description="test import image",
    disk_device_mappings=[{
        "diskImageSize": 5,
        "oss_bucket": "testimportimage",
        "ossObject": "root.img",
    }],
    image_name="test-import-image",
    license_type="Auto",
    os_type="linux",
    platform="Ubuntu")

The following attributes are exported:

• id - ID of the image.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• architecture (pulumi.Input[str]) – Specifies the architecture of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: i386 , Default is x86_64.

• description (pulumi.Input[str]) – Description of the image. The length is 2 to 256 English or Chinese characters, and cannot begin with http: // and https: //.

• disk_device_mappings (pulumi.Input[list]) – Description of the system with disks and snapshots under the image.

• image*name (pulumi.Input[str]) –

  The image name. The length is 2 ~ 128 English or Chinese characters. Must start with a english letter or Chinese, and cannot start with http: // and https: //. Can contain numbers, colons (:), underscores (*), or hyphens (-).

• license_type (pulumi.Input[str]) – The type of the license used to activate the operating system after the image is imported. Default value: Auto. Valid values: Auto,Aliyun,BYOL.

• os_type (pulumi.Input[str]) – Operating system platform type. Valid values: windows, Default is linux.

• platform (pulumi.Input[str]) – Specifies the operating system platform of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: CentOS, Ubuntu, SUSE, OpenSUSE, Debian, CoreOS, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows 7, Default is Others Linux, Customized Linux.

The disk_device_mappings object supports the following:

• device (pulumi.Input[str]) - The name of disk N in the custom image.

• diskImageSize (pulumi.Input[float]) - Resolution size. You must ensure that the system disk space ≥ file system space. Ranges: When n = 1, the system disk: 5 ~ 500GiB, When n = 2 ~ 17, that is, data disk: 5 ~ 1000GiB, When temporary is introduced, the system automatically detects the size, which is subject to the detection result.

• format (pulumi.Input[str]) - Image format. Value range: When the RAW, VHD, qcow2 is imported into the image, the system automatically detects the image format, whichever comes first.

• oss_bucket (pulumi.Input[str]) - Save the exported OSS bucket.

• ossObject (pulumi.Input[str]) - The file name of your OSS Object.

architecture: pulumi.Output[str] = None¶

Specifies the architecture of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: i386 , Default is x86_64.

description: pulumi.Output[str] = None¶

Description of the image. The length is 2 to 256 English or Chinese characters, and cannot begin with http: // and https: //.

disk_device_mappings: pulumi.Output[list] = None¶

Description of the system with disks and snapshots under the image.

• device (str) - The name of disk N in the custom image.

• diskImageSize (float) - Resolution size. You must ensure that the system disk space ≥ file system space. Ranges: When n = 1, the system disk: 5 ~ 500GiB, When n = 2 ~ 17, that is, data disk: 5 ~ 1000GiB, When temporary is introduced, the system automatically detects the size, which is subject to the detection result.

• format (str) - Image format. Value range: When the RAW, VHD, qcow2 is imported into the image, the system automatically detects the image format, whichever comes first.

• oss_bucket (str) - Save the exported OSS bucket.

• ossObject (str) - The file name of your OSS Object.

image_name: pulumi.Output[str] = None¶

The image name. The length is 2 ~ 128 English or Chinese characters. Must start with a english letter or Chinese, and cannot start with http: // and https: //. Can contain numbers, colons (:), underscores (_), or hyphens (-).

license_type: pulumi.Output[str] = None¶

The type of the license used to activate the operating system after the image is imported. Default value: Auto. Valid values: Auto,Aliyun,BYOL.

os_type: pulumi.Output[str] = None¶

Operating system platform type. Valid values: windows, Default is linux.

platform: pulumi.Output[str] = None¶

Specifies the operating system platform of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: CentOS, Ubuntu, SUSE, OpenSUSE, Debian, CoreOS, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows 7, Default is Others Linux, Customized Linux.

static get(resource_name, id, opts=None, architecture=None, description=None, disk_device_mappings=None, image_name=None, license_type=None, os_type=None, platform=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• architecture (pulumi.Input[str]) – Specifies the architecture of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: i386 , Default is x86_64.

• description (pulumi.Input[str]) – Description of the image. The length is 2 to 256 English or Chinese characters, and cannot begin with http: // and https: //.

• disk_device_mappings (pulumi.Input[list]) – Description of the system with disks and snapshots under the image.

• image*name (pulumi.Input[str]) –

  The image name. The length is 2 ~ 128 English or Chinese characters. Must start with a english letter or Chinese, and cannot start with http: // and https: //. Can contain numbers, colons (:), underscores (*), or hyphens (-).

• license_type (pulumi.Input[str]) – The type of the license used to activate the operating system after the image is imported. Default value: Auto. Valid values: Auto,Aliyun,BYOL.

• os_type (pulumi.Input[str]) – Operating system platform type. Valid values: windows, Default is linux.

• platform (pulumi.Input[str]) – Specifies the operating system platform of the system disk after you specify a data disk snapshot as the data source of the system disk for creating an image. Valid values: CentOS, Ubuntu, SUSE, OpenSUSE, Debian, CoreOS, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows 7, Default is Others Linux, Customized Linux.

The disk_device_mappings object supports the following:

• device (pulumi.Input[str]) - The name of disk N in the custom image.

• diskImageSize (pulumi.Input[float]) - Resolution size. You must ensure that the system disk space ≥ file system space. Ranges: When n = 1, the system disk: 5 ~ 500GiB, When n = 2 ~ 17, that is, data disk: 5 ~ 1000GiB, When temporary is introduced, the system automatically detects the size, which is subject to the detection result.

• format (pulumi.Input[str]) - Image format. Value range: When the RAW, VHD, qcow2 is imported into the image, the system automatically detects the image format, whichever comes first.

• oss_bucket (pulumi.Input[str]) - Save the exported OSS bucket.

• ossObject (pulumi.Input[str]) - The file name of your OSS Object.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.ImageSharePermission(resource_name, opts=None, account_id=None, image_id=None, __props__=None, __name__=None, __opts__=None)¶

Manage image sharing permissions. You can share your custom image to other Alibaba Cloud users. The user can use the shared custom image to create ECS instances or replace the system disk of the instance.

NOTE: You can only share your own custom images to other Alibaba Cloud users.

NOTE: Each custom image can be shared with up to 50 Alibaba Cloud accounts. You can submit a ticket to share with more users.

NOTE: After creating an ECS instance using a shared image, once the custom image owner releases the image sharing relationship or deletes the custom image, the instance cannot initialize the system disk.

NOTE: Available in 1.68.0+.

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.ecs.ImageSharePermission("default",
    account_id="1234567890",
    image_id="m-bp1gxyh***")

The following attributes are exported:

• id - ID of the image. It formats as <image_id>:<account_id>

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_id (pulumi.Input[str]) – Alibaba Cloud Account ID. It is used to share images.

• image_id (pulumi.Input[str]) – The source image ID.

account_id: pulumi.Output[str] = None¶

Alibaba Cloud Account ID. It is used to share images.

image_id: pulumi.Output[str] = None¶

The source image ID.

static get(resource_name, id, opts=None, account_id=None, image_id=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_id (pulumi.Input[str]) – Alibaba Cloud Account ID. It is used to share images.

• image_id (pulumi.Input[str]) – The source image ID.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ecs.Instance(resource_name, opts=None, allocate_public_ip=None, auto_release_time=None, auto_renew_period=None, availability_zone=None, credit_specification=None, data_disks=None, deletion_protection=None, description=None, dry_run=None, force_delete=None, host_name=None, image_id=None, include_data_disks=None, instance_charge_type=None, instance_name=None, instance_type=None, internet_charge_type=None, internet_max_bandwidth_in=None, internet_max_bandwidth_out=None, io_optimized=None, is_outdated=None, key_name=None, kms_encrypted_password=None, kms_encryption_context=None, password=None, period=None, period_unit=None, private_ip=None, renewal_status=None, resource_group_id=None, role_name=None, security_enhancement_strategy=None, security_groups=None, spot_price_limit=None, spot_strategy=None, status=None, subnet_id=None, system_disk_auto_snapshot_policy_id=None, system_disk_category=None, system_disk_size=None, tags=None, user_data=None, volume_tags=None, vswitch_id=None, __props__=None, __name__=None, __opts__=None)¶

Create a Instance resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] allocate_public_ip: It has been deprecated from version “1.7.0”. Setting “internet_max_bandwidth_out” larger than 0 can allocate a public ip address for an instance. :param pulumi.Input[str] auto_release_time: The automatic release time of the PostPaid instance.

The time follows the ISO 8601 standard and is in UTC time. Format: yyyy-MM-ddTHH:mm:ssZ. It must be at least half an hour later than the current time and less than 3 years since the current time. Set it to null can cancel automatic release attribute and the ECS instance will not be released automatically.

Parameters

auto_renew_period (pulumi.Input[float]) – Auto renewal period of an instance, in the unit of month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid value:

- [1, 2, 3, 6, 12] when `period_unit` in "Month"
- [1, 2, 3] when `period_unit` in "Week"

Parameters

• availability_zone (pulumi.Input[str]) – The Zone to start the instance in. It is ignored and will be computed when set vswitch_id.

• credit_specification (pulumi.Input[str]) – Performance mode of the t5 burstable instance. Valid values: ‘Standard’, ‘Unlimited’.

• data_disks (pulumi.Input[list]) – The list of data disks created with instance.

• deletion_protection (pulumi.Input[bool]) – Whether enable the deletion protection or not.

- true: Enable deletion protection.
- false: Disable deletion protection.

Parameters

• description (pulumi.Input[str]) – The description of the data disk.

• dry_run (pulumi.Input[bool]) – Specifies whether to send a dry-run request. Default to false.

- true: Only a dry-run request is sent and no instance is created. The system checks whether the required parameters are set, and validates the request format, service permissions, and available ECS instances. If the validation fails, the corresponding error code is returned. If the validation succeeds, the `DryRunOperation` error code is returned.
- false: A request is sent. If the validation succeeds, the instance is created.

Parameters

• force_delete (pulumi.Input[bool]) – If it is true, the “PrePaid” instance will be change to “PostPaid” and then deleted forcibly. However, because of changing instance charge type has CPU core count quota limitation, so strongly recommand that “Don’t modify instance charge type frequentlly in one month”.

• host*name (pulumi.Input[str]) –

  Host name of the ECS, which is a string of at least two characters. “hostname” cannot start or end with “.” or “-“. In addition, two or more consecutive “.” or “-“ symbols are not allowed. On Windows, the host name can contain a maximum of 15 characters, which can be a combination of uppercase/lowercase letters, numerals, and “-“. The host name cannot contain dots (“.”) or contain only numeric characters. When it is changed, the instance will reboot to make the change take effect. On other OSs such as Linux, the host name can contain a maximum of 64 characters, which can be segments separated by dots (“.”), where each segment can contain uppercase/lowercase letters, numerals, or “*“. When it is changed, the instance will reboot to make the change take effect.

• image_id (pulumi.Input[str]) – The Image to use for the instance. ECS instance’s image can be replaced via changing ‘image_id’. When it is changed, the instance will reboot to make the change take effect.

• include_data_disks (pulumi.Input[bool]) – Whether to change instance disks charge type when changing instance charge type.

• instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid, The default is PostPaid.

• instance_type (pulumi.Input[str]) – The type of instance to start. When it is changed, the instance will reboot to make the change take effect.

• internet_charge_type (pulumi.Input[str]) – Internet charge type of the instance, Valid values are PayByBandwidth, PayByTraffic. Default is PayByTraffic. At present, ‘PrePaid’ instance cannot change the value to “PayByBandwidth” from “PayByTraffic”.

• internet_max_bandwidth_in (pulumi.Input[float]) – Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second). Value range: [1, 200]. If this value is not specified, then automatically sets it to 200 Mbps.

• internet_max_bandwidth_out (pulumi.Input[float]) – Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bit per second). Value range: [0, 100]. Default to 0 Mbps.

• io_optimized (pulumi.Input[str]) – It has been deprecated on instance resource. All the launched alicloud instances will be I/O optimized.

• is_outdated (pulumi.Input[bool]) – Whether to use outdated instance type. Default to false.

• key_name (pulumi.Input[str]) – The name of key pair that can login ECS instance successfully without password. If it is specified, the password would be invalid.

• kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored. When it is changed, the instance will reboot to make the change take effect.

• kms_encryption_context (pulumi.Input[dict]) – An KMS encryption context used to decrypt kms_encrypted_password before creating or updating an instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set. When it is changed, the instance will reboot to make the change take effect.

• password (pulumi.Input[str]) – Password to an instance is a string of 8 to 30 characters. It must contain uppercase/lowercase letters and numerals, but cannot contain special symbols. When it is changed, the instance will reboot to make the change take effect.

• period (pulumi.Input[float]) – The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values:

- [1-9, 12, 24, 36, 48, 60] when `period_unit` in "Month"
- [1-3] when `period_unit` in "Week"

Parameters

• period_unit (pulumi.Input[str]) – The duration unit that you will buy the resource. It is valid when instance_charge_type is ‘PrePaid’. Valid value: [“Week”, “Month”]. Default to “Month”.

• private_ip (pulumi.Input[str]) – Instance private IP address can be specified when you creating new instance. It is valid when vswitch_id is specified. When it is changed, the instance will reboot to make the change take effect.

• renewal_status (pulumi.Input[str]) – Whether to renew an ECS instance automatically or not. It is valid when instance_charge_type is PrePaid. Default to “Normal”. Valid values:

- `AutoRenewal`: Enable auto renewal.
- `Normal`: Disable auto renewal.
- `NotRenewal`: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.

Parameters

• resource_group_id (pulumi.Input[str]) – The Id of resource group which the instance belongs.

• role_name (pulumi.Input[str]) – Instance RAM role name. The name is provided and maintained by RAM. You can use ram.Role to create a new one.

• security_enhancement_strategy (pulumi.Input[str]) – The security enhancement strategy.

- Active: Enable security enhancement strategy, it only works on system images.
- Deactive: Disable security enhancement strategy, it works on all images.

Parameters

• security_groups (pulumi.Input[list]) – A list of security group ids to associate with.

• spot_price_limit (pulumi.Input[float]) – The hourly price threshold of a instance, and it takes effect only when parameter ‘spot_strategy’ is ‘SpotWithPriceLimit’. Three decimals is allowed at most.

• spot_strategy (pulumi.Input[str]) – The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter instance_charge_type is ‘PostPaid’. Value range:

- NoSpot: A regular Pay-As-You-Go instance.
- SpotWithPriceLimit: A price threshold for a spot instance
- SpotAsPriceGo: A price that is based on the highest Pay-As-You-Go instance

Parameters

• status (pulumi.Input[str]) – The instance status. Valid values: [“Running”, “Stopped”]. You can control the instance start and stop through this parameter. Default to Running.

• system_disk_auto_snapshot_policy_id (pulumi.Input[str]) – The ID of the automatic snapshot policy applied to the system disk.

• system_disk_category (pulumi.Input[str]) – Valid values are ephemeral_ssd, cloud_efficiency, cloud_ssd, cloud_essd, cloud. cloud only is used to some none I/O optimized instance. Default to cloud_efficiency.

• system_disk_size (pulumi.Input[float]) – Size of the system disk, measured in GiB. Value range: [20, 500]. The specified value must be equal to or greater than max{20, Imagesize}. Default value: max{40, ImageSize}.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Parameters

• user_data (pulumi.Input[str]) – User-defined data to customize the startup behaviors of an ECS instance and to pass data into an ECS instance. From version 1.60.0, it can be update in-place. If updated, the instance will reboot to make the change take effect. Note: Not all of changes will take effect and it depends on cloud-init module type.

• volume_tags (pulumi.Input[dict]) – A mapping of tags to assign to the devices created by the instance at launch time.

- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Parameters

vswitch_id (pulumi.Input[str]) – The virtual switch ID to launch in VPC. This parameter must be set unless you can create classic network instances. When it is changed, the instance will reboot to make the change take effect.

The data_disks object supports the following:

• autoSnapshotPolicyId (pulumi.Input[str]) - The ID of the automatic snapshot policy applied to the system disk.

• category (pulumi.Input[str]) - The category of the disk:

  • cloud: The general cloud disk.

  • cloud_efficiency: The efficiency cloud disk.

  • cloud_ssd: The SSD cloud disk.

  • cloud_essd: The ESSD cloud disk.

  • ephemeral_ssd: The local SSD disk. Default to cloud_efficiency.

• delete_with_instance (pulumi.Input[bool]) - Delete this data disk when the instance is destroyed. It only works on cloud, cloud_efficiency, cloud_essd, cloud_ssd disk. If the category of this data disk was ephemeral_ssd, please don’t set this param.

• description (pulumi.Input[str]) - The description of the data disk.

• encrypted (pulumi.Input[bool]) - -(Optional, Bool, ForceNew) Encrypted the data in this disk.

• name (pulumi.Input[str]) - The name of the data disk.

• size (pulumi.Input[float]) - The size of the data disk.

  • cloud：[5, 2000]

  • cloud_efficiency：[20, 32768]

  • cloud_ssd：[20, 32768]

  • cloud_essd：[20, 32768]

  • ephemeral_ssd: [5, 800]

• snapshot_id (pulumi.Input[str]) - The snapshot ID used to initialize the data disk. If the size specified by snapshot is greater that the size of the disk, use the size specified by snapshot as the size of the data disk.

allocate_public_ip: pulumi.Output[bool] = None¶

It has been deprecated from version “1.7.0”. Setting “internet_max_bandwidth_out” larger than 0 can allocate a public ip address for an instance.

auto_release_time: pulumi.Output[str] = None¶

The automatic release time of the PostPaid instance. The time follows the ISO 8601 standard and is in UTC time. Format: yyyy-MM-ddTHH:mm:ssZ. It must be at least half an hour later than the current time and less than 3 years since the current time. Set it to null can cancel automatic release attribute and the ECS instance will not be released automatically.

auto_renew_period: pulumi.Output[float] = None¶

Auto renewal period of an instance, in the unit of month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid value:

• [1, 2, 3, 6, 12] when period_unit in “Month”

• [1, 2, 3] when period_unit in “Week”

availability_zone: pulumi.Output[str] = None¶

The Zone to start the instance in. It is ignored and will be computed when set vswitch_id.

credit_specification: pulumi.Output[str] = None¶

Performance mode of the t5 burstable instance. Valid values: ‘Standard’, ‘Unlimited’.

data_disks: pulumi.Output[list] = None¶

The list of data disks created with instance.

• autoSnapshotPolicyId (str) - The ID of the automatic snapshot policy applied to the system disk.

• category (str) - The category of the disk:

  • cloud: The general cloud disk.

  • cloud_efficiency: The efficiency cloud disk.

  • cloud_ssd: The SSD cloud disk.

  • cloud_essd: The ESSD cloud disk.

  • ephemeral_ssd: The local SSD disk. Default to cloud_efficiency.

• delete_with_instance (bool) - Delete this data disk when the instance is destroyed. It only works on cloud, cloud_efficiency, cloud_essd, cloud_ssd disk. If the category of this data disk was ephemeral_ssd, please don’t set this param.

• description (str) - The description of the data disk.

• encrypted (bool) - -(Optional, Bool, ForceNew) Encrypted the data in this disk.

• name (str) - The name of the data disk.

• size (float) - The size of the data disk.

  • cloud：[5, 2000]

  • cloud_efficiency：[20, 32768]

  • cloud_ssd：[20, 32768]

  • cloud_essd：[20, 32768]

  • ephemeral_ssd: [5, 800]

• snapshot_id (str) - The snapshot ID used to initialize the data disk. If the size specified by snapshot is greater that the size of the disk, use the size specified by snapshot as the size of the data disk.

deletion_protection: pulumi.Output[bool] = None¶

Whether enable the deletion protection or not.

• true: Enable deletion protection.

• false: Disable deletion protection.

description: pulumi.Output[str] = None¶

The description of the data disk.

dry_run: pulumi.Output[bool] = None¶

Specifies whether to send a dry-run request. Default to false.

• true: Only a dry-run request is sent and no instance is created. The system checks whether the required parameters are set, and validates the request format, service permissions, and available ECS instances. If the validation fails, the corresponding error code is returned. If the validation succeeds, the DryRunOperation error code is returned.

• false: A request is sent. If the validation succeeds, the instance is created.

force_delete: pulumi.Output[bool] = None¶

If it is true, the “PrePaid” instance will be change to “PostPaid” and then deleted forcibly. However, because of changing instance charge type has CPU core count quota limitation, so strongly recommand that “Don’t modify instance charge type frequentlly in one month”.

host_name: pulumi.Output[str] = None¶

Host name of the ECS, which is a string of at least two characters. “hostname” cannot start or end with “.” or “-“. In addition, two or more consecutive “.” or “-“ symbols are not allowed. On Windows, the host name can contain a maximum of 15 characters, which can be a combination of uppercase/lowercase letters, numerals, and “-“. The host name cannot contain dots (“.”) or contain only numeric characters. When it is changed, the instance will reboot to make the change take effect. On other OSs such as Linux, the host name can contain a maximum of 64 characters, which can be segments separated by dots (“.”), where each segment can contain uppercase/lowercase letters, numerals, or “_“. When it is changed, the instance will reboot to make the change take effect.

image_id: pulumi.Output[str] = None¶

The Image to use for the instance. ECS instance’s image can be replaced via changing ‘image_id’. When it is changed, the instance will reboot to make the change take effect.

include_data_disks: pulumi.Output[bool] = None¶

Whether to change instance disks charge type when changing instance charge type.

instance_charge_type: pulumi.Output[str] = None¶

Valid values are PrePaid, PostPaid, The default is PostPaid.

instance_type: pulumi.Output[str] = None¶

The type of instance to start. When it is changed, the instance will reboot to make the change take effect.

internet_charge_type: pulumi.Output[str] = None¶

Internet charge type of the instance, Valid values are PayByBandwidth, PayByTraffic. Default is PayByTraffic. At present, ‘PrePaid’ instance cannot change the value to “PayByBandwidth” from “PayByTraffic”.

internet_max_bandwidth_in: pulumi.Output[float] = None¶

Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second). Value range: [1, 200]. If this value is not specified, then automatically sets it to 200 Mbps.

internet_max_bandwidth_out: pulumi.Output[float] = None¶

Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bit per second). Value range: [0, 100]. Default to 0 Mbps.

io_optimized: pulumi.Output[str] = None¶

It has been deprecated on instance resource. All the launched alicloud instances will be I/O optimized.

is_outdated: pulumi.Output[bool] = None¶

Whether to use outdated instance type. Default to false.

key_name: pulumi.Output[str] = None¶

The name of key pair that can login ECS instance successfully without password. If it is specified, the password would be invalid.

kms_encrypted_password: pulumi.Output[str] = None¶

An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored. When it is changed, the instance will reboot to make the change take effect.

kms_encryption_context: pulumi.Output[dict] = None¶

An KMS encryption context used to decrypt kms_encrypted_password before creating or updating an instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set. When it is changed, the instance will reboot to make the change take effect.

password: pulumi.Output[str] = None¶

Password to an instance is a string of 8 to 30 characters. It must contain uppercase/lowercase letters and numerals, but cannot contain special symbols. When it is changed, the instance will reboot to make the change take effect.

period: pulumi.Output[float] = None¶

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values:

• [1-9, 12, 24, 36, 48, 60] when period_unit in “Month”

• [1-3] when period_unit in “Week”

period_unit: pulumi.Output[str] = None¶

The duration unit that you will buy the resource. It is valid when instance_charge_type is ‘PrePaid’. Valid value: [“Week”, “Month”]. Default to “Month”.

private_ip: pulumi.Output[str] = None¶

Instance private IP address can be specified when you creating new instance. It is valid when vswitch_id is specified. When it is changed, the instance will reboot to make the change take effect.

public_ip: pulumi.Output[str] = None¶

The instance public ip.

renewal_status: pulumi.Output[str] = None¶

Whether to renew an ECS instance automatically or not. It is valid when instance_charge_type is PrePaid. Default to “Normal”. Valid values:

• AutoRenewal: Enable auto renewal.

• Normal: Disable auto renewal.

• NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.

resource_group_id: pulumi.Output[str] = None¶

The Id of resource group which the instance belongs.

role_name: pulumi.Output[str] = None¶

Instance RAM role name. The name is provided and maintained by RAM. You can use ram.Role to create a new one.

security_enhancement_strategy: pulumi.Output[str] = None¶

The security enhancement strategy.

• Active: Enable security enhancement strategy, it only works on system images.

• Deactive: Disable security enhancement strategy, it works on all images.

security_groups: pulumi.Output[list] = None¶

A list of security group ids to associate with.

spot_price_limit: pulumi.Output[float] = None¶

The hourly price threshold of a instance, and it takes effect only when parameter ‘spot_strategy’ is ‘SpotWithPriceLimit’. Three decimals is allowed at most.

spot_strategy: pulumi.Output[str] = None¶

The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter instance_charge_type is ‘PostPaid’. Value range:

• NoSpot: A regular Pay-As-You-Go instance.

• SpotWithPriceLimit: A price threshold for a spot instance

• SpotAsPriceGo: A price that is based on the highest Pay-As-You-Go instance

status: pulumi.Output[str] = None¶

The instance status. Valid values: [“Running”, “Stopped”]. You can control the instance start and stop through this parameter. Default to Running.

system_disk_auto_snapshot_policy_id: pulumi.Output[str] = None¶

The ID of the automatic snapshot policy applied to the system disk.

system_disk_category: pulumi.Output[str] = None¶

Valid values are ephemeral_ssd, cloud_efficiency, cloud_ssd, cloud_essd, cloud. cloud only is used to some none I/O optimized instance. Default to cloud_efficiency.

system_disk_size: pulumi.Output[float] = None¶

Size of the system disk, measured in GiB. Value range: [20, 500]. The specified value must be equal to or greater than max{20, Imagesize}. Default value: max{40, ImageSize}.

tags: pulumi.Output[dict] = None¶

A mapping of tags to assign to the resource.

• Key: It can be up to 64 characters in length. It cannot begin with “aliyun”, “acs:”, “http://”, or “https://”. It cannot be a null string.

• Value: It can be up to 128 characters in length. It cannot begin with “aliyun”, “acs:”, “http://”, or “https://”. It can be a null string.

user_data: pulumi.Output[str] = None¶

User-defined data to customize the startup behaviors of an ECS instance and to pass data into an ECS instance. From version 1.60.0, it can be update in-place. If updated, the instance will reboot to make the change take effect. Note: Not all of changes will take effect and it depends on cloud-init module type.

volume_tags: pulumi.Output[dict] = None¶

A mapping of tags to assign to the devices created by the instance at launch time.

• Key: It can be up to 64 characters in length. It cannot begin with “aliyun”, “acs:”, “http://”, or “https://”. It cannot be a null string.

• Value: It can be up to 128 characters in length. It cannot begin with “aliyun”, “acs:”, “http://”, or “https://”. It can be a null string.

vswitch_id: pulumi.Output[str] = None¶

The virtual switch ID to launch in VPC. This parameter must be set unless you can create classic network instances. When it is changed, the instance will reboot to make the change take effect.

static get(resource_name, id, opts=None, allocate_public_ip=None, auto_release_time=None, auto_renew_period=None, availability_zone=None, credit_specification=None, data_disks=None, deletion_protection=None, description=None, dry_run=None, force_delete=None, host_name=None, image_id=None, include_data_disks=None, instance_charge_type=None, instance_name=None, instance_type=None, internet_charge_type=None, internet_max_bandwidth_in=None, internet_max_bandwidth_out=None, io_optimized=None, is_outdated=None, key_name=None, kms_encrypted_password=None, kms_encryption_context=None, password=None, period=None, period_unit=None, private_ip=None, public_ip=None, renewal_status=None, resource_group_id=None, role_name=None, security_enhancement_strategy=None, security_groups=None, spot_price_limit=None, spot_strategy=None, status=None, subnet_id=None, system_disk_auto_snapshot_policy_id=None, system_disk_category=None, system_disk_size=None, tags=None, user_data=None, volume_tags=None, vswitch_id=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• allocate_public_ip (pulumi.Input[bool]) – It has been deprecated from version “1.7.0”. Setting “internet_max_bandwidth_out” larger than 0 can allocate a public ip address for an instance.

• auto_release_time (pulumi.Input[str]) – The automatic release time of the PostPaid instance. The time follows the ISO 8601 standard and is in UTC time. Format: yyyy-MM-ddTHH:mm:ssZ. It must be at least half an hour later than the current time and less than 3 years since the current time. Set it to null can cancel automatic release attribute and the ECS instance will not be released automatically.

• auto_renew_period (pulumi.Input[float]) – Auto renewal period of an instance, in the unit of month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid value:

- [1, 2, 3, 6, 12] when `period_unit` in "Month"
- [1, 2, 3] when `period_unit` in "Week"

Parameters

• availability_zone (pulumi.Input[str]) – The Zone to start the instance in. It is ignored and will be computed when set vswitch_id.

• credit_specification (pulumi.Input[str]) – Performance mode of the t5 burstable instance. Valid values: ‘Standard’, ‘Unlimited’.

• data_disks (pulumi.Input[list]) – The list of data disks created with instance.

• deletion_protection (pulumi.Input[bool]) – Whether enable the deletion protection or not.

- true: Enable deletion protection.
- false: Disable deletion protection.

Parameters

• description (pulumi.Input[str]) – The description of the data disk.

• dry_run (pulumi.Input[bool]) – Specifies whether to send a dry-run request. Default to false.

- true: Only a dry-run request is sent and no instance is created. The system checks whether the required parameters are set, and validates the request format, service permissions, and available ECS instances. If the validation fails, the corresponding error code is returned. If the validation succeeds, the `DryRunOperation` error code is returned.
- false: A request is sent. If the validation succeeds, the instance is created.

Parameters

• force_delete (pulumi.Input[bool]) – If it is true, the “PrePaid” instance will be change to “PostPaid” and then deleted forcibly. However, because of changing instance charge type has CPU core count quota limitation, so strongly recommand that “Don’t modify instance charge type frequentlly in one month”.

• host*name (pulumi.Input[str]) –

  Host name of the ECS, which is a string of at least two characters. “hostname” cannot start or end with “.” or “-“. In addition, two or more consecutive “.” or “-“ symbols are not allowed. On Windows, the host name can contain a maximum of 15 characters, which can be a combination of uppercase/lowercase letters, numerals, and “-“. The host name cannot contain dots (“.”) or contain only numeric characters. When it is changed, the instance will reboot to make the change take effect. On other OSs such as Linux, the host name can contain a maximum of 64 characters, which can be segments separated by dots (“.”), where each segment can contain uppercase/lowercase letters, numerals, or “*“. When it is changed, the instance will reboot to make the change take effect.

• image_id (pulumi.Input[str]) – The Image to use for the instance. ECS instance’s image can be replaced via changing ‘image_id’. When it is changed, the instance will reboot to make the change take effect.

• include_data_disks (pulumi.Input[bool]) – Whether to change instance disks charge type when changing instance charge type.

• instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid, The default is PostPaid.

• instance_type (pulumi.Input[str]) – The type of instance to start. When it is changed, the instance will reboot to make the change take effect.

• internet_charge_type (pulumi.Input[str]) – Internet charge type of the instance, Valid values are PayByBandwidth, PayByTraffic. Default is PayByTraffic. At present, ‘PrePaid’ instance cannot change the value to “PayByBandwidth” from “PayByTraffic”.

• internet_max_bandwidth_in (pulumi.Input[float]) – Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second). Value range: [1, 200]. If this value is not specified, then automatically sets it to 200 Mbps.

• internet_max_bandwidth_out (pulumi.Input[float]) – Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bit per second). Value range: [0, 100]. Default to 0 Mbps.

• io_optimized (pulumi.Input[str]) – It has been deprecated on instance resource. All the launched alicloud instances will be I/O optimized.

• is_outdated (pulumi.Input[bool]) – Whether to use outdated instance type. Default to false.

• key_name (pulumi.Input[str]) – The name of key pair that can login ECS instance successfully without password. If it is specified, the password would be invalid.

• kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored. When it is changed, the instance will reboot to make the change take effect.

• kms_encryption_context (pulumi.Input[dict]) –

  An KMS encryption context used to decrypt kms_encrypted_password before creating or updating an instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set. When it is changed, the instance will reboot to make the change take effect.

• password (pulumi.Input[str]) – Password to an instance is a string of 8 to 30 characters. It must contain uppercase/lowercase letters and numerals, but cannot contain special symbols. When it is changed, the instance will reboot to make the change take effect.

• period (pulumi.Input[float]) – The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values:

- [1-9, 12, 24, 36, 48, 60] when `period_unit` in "Month"
- [1-3] when `period_unit` in "Week"

Parameters

• period_unit (pulumi.Input[str]) – The duration unit that you will buy the resource. It is valid when instance_charge_type is ‘PrePaid’. Valid value: [“Week”, “Month”]. Default to “Month”.

• private_ip (pulumi.Input[str]) – Instance private IP address can be specified when you creating new instance. It is valid when vswitch_id is specified. When it is changed, the instance will reboot to make the change take effect.

• public_ip (pulumi.Input[str]) – The instance public ip.

• renewal_status (pulumi.Input[str]) – Whether to renew an ECS instance automatically or not. It is valid when instance_charge_type is PrePaid. Default to “Normal”. Valid values:

- `AutoRenewal`: Enable auto renewal.
- `Normal`: Disable auto renewal.
- `NotRenewal`: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.

Parameters

• resource_group_id (pulumi.Input[str]) – The Id of resource group which the instance belongs.

• role_name (pulumi.Input[str]) – Instance RAM role name. The name is provided and maintained by RAM. You can use ram.Role to create a new one.

• security_enhancement_strategy (pulumi.Input[str]) – The security enhancement strategy.

- Active: Enable security enhancement strategy, it only works on system images.
- Deactive: Disable security enhancement strategy, it works on all images.

Parameters

• security_groups (pulumi.Input[list]) – A list of security group ids to associate with.

• spot_price_limit (pulumi.Input[float]) – The hourly price threshold of a instance, and it takes effect only when parameter ‘spot_strategy’ is ‘SpotWithPriceLimit’. Three decimals is allowed at most.

• spot_strategy (pulumi.Input[str]) – The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter instance_charge_type is ‘PostPaid’. Value range:

- NoSpot: A regular Pay-As-You-Go instance.
- SpotWithPriceLimit: A price threshold for a spot instance
- SpotAsPriceGo: A price that is based on the highest Pay-As-You-Go instance

Parameters

• status (pulumi.Input[str]) – The instance status. Valid values: [“Running”, “Stopped”]. You can control the instance start and stop through this parameter. Default to Running.

• system_disk_auto_snapshot_policy_id (pulumi.Input[str]) – The ID of the automatic snapshot policy applied to the system disk.

• system_disk_category (pulumi.Input[str]) – Valid values are ephemeral_ssd, cloud_efficiency, cloud_ssd, cloud_essd, cloud. cloud only is used to some none I/O optimized instance. Default to cloud_efficiency.

• system_disk_size (pulumi.Input[float]) – Size of the system disk, measured in GiB. Value range: [20, 500]. The specified value must be equal to or greater than max{20, Imagesize}. Default value: max{40, ImageSize}.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Parameters

• user_data (pulumi.Input[str]) –

  User-defined data to customize the startup behaviors of an ECS instance and to pass data into an ECS instance. From version 1.60.0, it can be update in-place. If updated, the instance will reboot to make the change take effect. Note: Not all of changes will take effect and it depends on cloud-init module type.

• volume_tags (pulumi.Input[dict]) – A mapping of tags to assign to the devices created by the instance at launch time.

- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Parameters

vswitch_id (pulumi.Input[str]) – The virtual switch ID to launch in VPC. This parameter must be set unless you can create classic network instances. When it is changed, the instance will reboot to make the change take effect.

The data_disks object supports the following:

• autoSnapshotPolicyId (pulumi.Input[str]) - The ID of the automatic snapshot policy applied to the system disk.

• category (pulumi.Input[str]) - The category of the disk:

  • cloud: The general cloud disk.

  • cloud_efficiency: The efficiency cloud disk.

  • cloud_ssd: The SSD cloud disk.

  • cloud_essd: The ESSD cloud disk.

  • ephemeral_ssd: The local SSD disk. Default to cloud_efficiency.

• delete_with_instance (pulumi.Input[bool]) - Delete this data disk when the instance is destroyed. It only works on cloud, cloud_efficiency, cloud_essd, cloud_ssd disk. If the category of this data disk was ephemeral_ssd, please don’t set this param.

• description (pulumi.Input[str]) - The description of the data disk.

• encrypted (pulumi.Input[bool]) - -(Optional, Bool, ForceNew) Encrypted the data in this disk.

• name (pulumi.Input[str]) - The name of the data disk.

• size (pulumi.Input[float]) - The size of the data disk.

  • cloud：[5, 2000]

  • cloud_efficiency：[20, 32768]

  • cloud_ssd：[20, 32768]

  • cloud_essd：[20, 32768]

  • ephemeral_ssd: [5, 800]

• snapshot_id (pulumi.Input[str]) - The snapshot ID used to initialize the data disk. If the size specified by snapshot is greater that the size of the disk, use the size specified by snapshot as the size of the data disk.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str