This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

ess¶

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.ess.Alarm(resource_name, opts=None, alarm_actions=None, cloud_monitor_group_id=None, comparison_operator=None, description=None, dimensions=None, enable=None, evaluation_count=None, metric_name=None, metric_type=None, name=None, period=None, scaling_group_id=None, statistics=None, threshold=None, __props__=None, __name__=None, __opts__=None)¶

Create a Alarm 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[list] alarm_actions: The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari. :param pulumi.Input[float] cloud_monitor_group_id: Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc. :param pulumi.Input[str] comparison_operator: The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Supported value: >=, <=, >, <. Defaults to >=. :param pulumi.Input[str] description: The description for the alarm. :param pulumi.Input[dict] dimensions: The dimension map for the alarm’s associated metric (documented below). For all metrics, you can not set the dimension key as “scaling_group” or “userId”, which is set by default, the second dimension for metric, such as “device” for “PackagesNetIn”, need to be set by users. :param pulumi.Input[bool] enable: Whether to enable specific ess alarm. Default to true. :param pulumi.Input[float] evaluation_count: The number of times that needs to satisfies comparison condition before transition into ALARM state. Defaults to 3. :param pulumi.Input[str] metric_name: The name for the alarm’s associated metric. See Block_metricNames_and_dimensions below for details. :param pulumi.Input[str] metric_type: The type for the alarm’s associated metric. Supported value: system, custom. “system” means the metric data is collected by Aliyun Cloud Monitor Service(CMS), “custom” means the metric data is upload to CMS by users. Defaults to system. :param pulumi.Input[str] name: The name for ess alarm. :param pulumi.Input[float] period: The period in seconds over which the specified statistic is applied. Supported value: 60, 120, 300, 900. Defaults to 300. :param pulumi.Input[str] scaling_group_id: The scaling group associated with this alarm, the ‘ForceNew’ attribute is available in 1.56.0+. :param pulumi.Input[str] statistics: The statistic to apply to the alarm’s associated metric. Supported value: Average, Minimum, Maximum. Defaults to Average. :param pulumi.Input[str] threshold: The value against which the specified statistics is compared.

alarm_actions: pulumi.Output[list] = None¶: The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.

cloud_monitor_group_id: pulumi.Output[float] = None¶: Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.

comparison_operator: pulumi.Output[str] = None¶: The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Supported value: >=, <=, >, <. Defaults to >=.

description: pulumi.Output[str] = None¶: The description for the alarm.

dimensions: pulumi.Output[dict] = None¶: The dimension map for the alarm’s associated metric (documented below). For all metrics, you can not set the dimension key as “scaling_group” or “userId”, which is set by default, the second dimension for metric, such as “device” for “PackagesNetIn”, need to be set by users.

enable: pulumi.Output[bool] = None¶: Whether to enable specific ess alarm. Default to true.

evaluation_count: pulumi.Output[float] = None¶: The number of times that needs to satisfies comparison condition before transition into ALARM state. Defaults to 3.

metric_name: pulumi.Output[str] = None¶: The name for the alarm’s associated metric. See Block_metricNames_and_dimensions below for details.

metric_type: pulumi.Output[str] = None¶: The type for the alarm’s associated metric. Supported value: system, custom. “system” means the metric data is collected by Aliyun Cloud Monitor Service(CMS), “custom” means the metric data is upload to CMS by users. Defaults to system.

name: pulumi.Output[str] = None¶: The name for ess alarm.

period: pulumi.Output[float] = None¶: The period in seconds over which the specified statistic is applied. Supported value: 60, 120, 300, 900. Defaults to 300.

scaling_group_id: pulumi.Output[str] = None¶: The scaling group associated with this alarm, the ‘ForceNew’ attribute is available in 1.56.0+.

state: pulumi.Output[str] = None¶: The state of specified alarm.

statistics: pulumi.Output[str] = None¶: The statistic to apply to the alarm’s associated metric. Supported value: Average, Minimum, Maximum. Defaults to Average.

threshold: pulumi.Output[str] = None¶: The value against which the specified statistics is compared.

static get(resource_name, id, opts=None, alarm_actions=None, cloud_monitor_group_id=None, comparison_operator=None, description=None, dimensions=None, enable=None, evaluation_count=None, metric_name=None, metric_type=None, name=None, period=None, scaling_group_id=None, state=None, statistics=None, threshold=None)¶

Get an existing Alarm 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.
alarm_actions (pulumi.Input[list]) – The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.
cloud_monitor_group_id (pulumi.Input[float]) – Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.
comparison_operator (pulumi.Input[str]) – The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Supported value: >=, <=, >, <. Defaults to >=.
description (pulumi.Input[str]) – The description for the alarm.
dimensions (pulumi.Input[dict]) – The dimension map for the alarm’s associated metric (documented below). For all metrics, you can not set the dimension key as “scaling_group” or “userId”, which is set by default, the second dimension for metric, such as “device” for “PackagesNetIn”, need to be set by users.
enable (pulumi.Input[bool]) – Whether to enable specific ess alarm. Default to true.
evaluation_count (pulumi.Input[float]) – The number of times that needs to satisfies comparison condition before transition into ALARM state. Defaults to 3.
metric_name (pulumi.Input[str]) – The name for the alarm’s associated metric. See Block_metricNames_and_dimensions below for details.
metric_type (pulumi.Input[str]) – The type for the alarm’s associated metric. Supported value: system, custom. “system” means the metric data is collected by Aliyun Cloud Monitor Service(CMS), “custom” means the metric data is upload to CMS by users. Defaults to system.
name (pulumi.Input[str]) – The name for ess alarm.
period (pulumi.Input[float]) – The period in seconds over which the specified statistic is applied. Supported value: 60, 120, 300, 900. Defaults to 300.
scaling_group_id (pulumi.Input[str]) – The scaling group associated with this alarm, the ‘ForceNew’ attribute is available in 1.56.0+.
state (pulumi.Input[str]) – The state of specified alarm.
statistics (pulumi.Input[str]) – The statistic to apply to the alarm’s associated metric. Supported value: Average, Minimum, Maximum. Defaults to Average.
threshold (pulumi.Input[str]) – The value against which the specified statistics is compared.

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.ess.Attachment(resource_name, opts=None, force=None, instance_ids=None, scaling_group_id=None, __props__=None, __name__=None, __opts__=None)¶

Attaches several ECS instances to a specified scaling group or remove them from it.

NOTE: ECS instances can be attached or remove only when the scaling group is active and it has no scaling activity in progress.
NOTE: There are two types ECS instances in a scaling group: “AutoCreated” and “Attached”. The total number of them can not larger than the scaling group “MaxSize”.

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "essattachmentconfig"
default_zones = alicloud.get_zones(available_disk_category="cloud_efficiency",
    available_resource_creation="VSwitch")
default_instance_types = alicloud.ecs.get_instance_types(availability_zone=default_zones.zones[0]["id"],
    cpu_core_count=2,
    memory_size=4)
default_images = alicloud.ecs.get_images(most_recent=True,
    name_regex="^ubuntu_18.*64",
    owners="system")
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_security_group_rule = alicloud.ecs.SecurityGroupRule("defaultSecurityGroupRule",
    cidr_ip="172.16.0.0/24",
    ip_protocol="tcp",
    nic_type="intranet",
    policy="accept",
    port_range="22/22",
    priority=1,
    security_group_id=default_security_group.id,
    type="ingress")
default_scaling_group = alicloud.ess.ScalingGroup("defaultScalingGroup",
    max_size=2,
    min_size=0,
    removal_policies=[
        "OldestInstance",
        "NewestInstance",
    ],
    scaling_group_name=name,
    vswitch_ids=[default_switch.id])
default_scaling_configuration = alicloud.ess.ScalingConfiguration("defaultScalingConfiguration",
    active=True,
    enable=True,
    force_delete=True,
    image_id=default_images.images[0]["id"],
    instance_type=default_instance_types.instance_types[0]["id"],
    scaling_group_id=default_scaling_group.id,
    security_group_id=default_security_group.id)
default_instance = []
for range in [{"value": i} for i in range(0, 2)]:
    default_instance.append(alicloud.ecs.Instance(f"defaultInstance-{range['value']}",
        image_id=default_images.images[0]["id"],
        instance_charge_type="PostPaid",
        instance_name=name,
        instance_type=default_instance_types.instance_types[0]["id"],
        internet_charge_type="PayByTraffic",
        internet_max_bandwidth_out="10",
        security_groups=[default_security_group.id],
        system_disk_category="cloud_efficiency",
        vswitch_id=default_switch.id))
default_attachment = alicloud.ess.Attachment("defaultAttachment",
    force=True,
    instance_ids=[
        default_instance[0].id,
        default_instance[1].id,
    ],
    scaling_group_id=default_scaling_group.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
force (pulumi.Input[bool]) – Whether to remove forcibly “AutoCreated” ECS instances in order to release scaling group capacity “MaxSize” for attaching ECS instances. Default to false.
instance_ids (pulumi.Input[list]) – ID of the ECS instance to be attached to the scaling group. You can input up to 20 IDs.
scaling_group_id (pulumi.Input[str]) – ID of the scaling group of a scaling configuration.

force: pulumi.Output[bool] = None¶: Whether to remove forcibly “AutoCreated” ECS instances in order to release scaling group capacity “MaxSize” for attaching ECS instances. Default to false.

instance_ids: pulumi.Output[list] = None¶: ID of the ECS instance to be attached to the scaling group. You can input up to 20 IDs.

scaling_group_id: pulumi.Output[str] = None¶: ID of the scaling group of a scaling configuration.

static get(resource_name, id, opts=None, force=None, instance_ids=None, scaling_group_id=None)¶

Get an existing Attachment 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.
force (pulumi.Input[bool]) – Whether to remove forcibly “AutoCreated” ECS instances in order to release scaling group capacity “MaxSize” for attaching ECS instances. Default to false.
instance_ids (pulumi.Input[list]) – ID of the ECS instance to be attached to the scaling group. You can input up to 20 IDs.
scaling_group_id (pulumi.Input[str]) – ID of the scaling group of a scaling configuration.

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.ess.AwaitableGetAlarmsResult(alarms=None, id=None, ids=None, metric_type=None, name_regex=None, names=None, output_file=None, scaling_group_id=None)¶

class pulumi_alicloud.ess.AwaitableGetLifecycleHooksResult(hooks=None, id=None, ids=None, name_regex=None, names=None, output_file=None, scaling_group_id=None)¶

class pulumi_alicloud.ess.AwaitableGetNotificationsResult(id=None, ids=None, notifications=None, output_file=None, scaling_group_id=None)¶

class pulumi_alicloud.ess.AwaitableGetScalingConfigurationsResult(configurations=None, id=None, ids=None, name_regex=None, names=None, output_file=None, scaling_group_id=None)¶

class pulumi_alicloud.ess.AwaitableGetScalingGroupsResult(groups=None, id=None, ids=None, name_regex=None, names=None, output_file=None)¶

class pulumi_alicloud.ess.AwaitableGetScalingRulesResult(id=None, ids=None, name_regex=None, names=None, output_file=None, rules=None, scaling_group_id=None, type=None)¶

class pulumi_alicloud.ess.AwaitableGetScheduledTasksResult(id=None, ids=None, name_regex=None, names=None, output_file=None, scheduled_action=None, scheduled_task_id=None, tasks=None)¶

class pulumi_alicloud.ess.GetAlarmsResult(alarms=None, id=None, ids=None, metric_type=None, name_regex=None, names=None, output_file=None, scaling_group_id=None)¶

A collection of values returned by getAlarms.

alarms = None¶: A list of alarms. Each element contains the following attributes:

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of alarm ids.

metric_type = None¶: The type for the alarm’s associated metric.

names = None¶: A list of alarm names.

scaling_group_id = None¶: The scaling group associated with this alarm.

class pulumi_alicloud.ess.GetLifecycleHooksResult(hooks=None, id=None, ids=None, name_regex=None, names=None, output_file=None, scaling_group_id=None)¶

A collection of values returned by getLifecycleHooks.

hooks = None¶: A list of lifecycle hooks. Each element contains the following attributes:

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of lifecycle hook ids.

names = None¶: A list of lifecycle hook names.

scaling_group_id = None¶: ID of the scaling group.

class pulumi_alicloud.ess.GetNotificationsResult(id=None, ids=None, notifications=None, output_file=None, scaling_group_id=None)¶

A collection of values returned by getNotifications.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of notification ids.

notifications = None¶: A list of notifications. Each element contains the following attributes:

scaling_group_id = None¶: ID of the scaling group.

class pulumi_alicloud.ess.GetScalingConfigurationsResult(configurations=None, id=None, ids=None, name_regex=None, names=None, output_file=None, scaling_group_id=None)¶

A collection of values returned by getScalingConfigurations.

configurations = None¶: A list of scaling rules. Each element contains the following attributes:

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of scaling configuration ids.

names = None¶: A list of scaling configuration names.

scaling_group_id = None¶: ID of the scaling group.

class pulumi_alicloud.ess.GetScalingGroupsResult(groups=None, id=None, ids=None, name_regex=None, names=None, output_file=None)¶

A collection of values returned by getScalingGroups.

groups = None¶: A list of scaling groups. Each element contains the following attributes:

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of scaling group ids.

names = None¶: A list of scaling group names.

class pulumi_alicloud.ess.GetScalingRulesResult(id=None, ids=None, name_regex=None, names=None, output_file=None, rules=None, scaling_group_id=None, type=None)¶

A collection of values returned by getScalingRules.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of scaling rule ids.

names = None¶: A list of scaling rule names.

rules = None¶: A list of scaling rules. Each element contains the following attributes:

scaling_group_id = None¶: ID of the scaling group.

type = None¶: Type of the scaling rule.

class pulumi_alicloud.ess.GetScheduledTasksResult(id=None, ids=None, name_regex=None, names=None, output_file=None, scheduled_action=None, scheduled_task_id=None, tasks=None)¶

A collection of values returned by getScheduledTasks.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of scheduled task ids.

names = None¶: A list of scheduled task names.

scheduled_action = None¶: The operation to be performed when a scheduled task is triggered.

tasks = None¶: A list of scheduled tasks. Each element contains the following attributes:

class pulumi_alicloud.ess.LifecycleHook(resource_name, opts=None, default_result=None, heartbeat_timeout=None, lifecycle_transition=None, name=None, notification_arn=None, notification_metadata=None, scaling_group_id=None, __props__=None, __name__=None, __opts__=None)¶

Create a LifecycleHook 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] default_result: Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses. Applicable value: CONTINUE, ABANDON, default value: CONTINUE. :param pulumi.Input[float] heartbeat_timeout: Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the default_result parameter. Default value: 600. :param pulumi.Input[str] lifecycle_transition: Type of Scaling activity attached to lifecycle hook. Supported value: SCALE_OUT, SCALEIN. :param pulumi.Input[str] name: The name of the lifecycle hook, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores `, hypens-, and decimal point.`. If this parameter value is not specified, the default value is lifecycle hook id. :param pulumi.Input[str] notification_arn: The Arn of notification target. :param pulumi.Input[str] notification_metadata: Additional information that you want to include when Auto Scaling sends a message to the notification target. :param pulumi.Input[str] scaling_group_id: The ID of the Auto Scaling group to which you want to assign the lifecycle hook.

default_result: pulumi.Output[str] = None¶: Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses. Applicable value: CONTINUE, ABANDON, default value: CONTINUE.

heartbeat_timeout: pulumi.Output[float] = None¶: Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the default_result parameter. Default value: 600.

lifecycle_transition: pulumi.Output[str] = None¶: Type of Scaling activity attached to lifecycle hook. Supported value: SCALE_OUT, SCALE_IN.

name: pulumi.Output[str] = None¶: The name of the lifecycle hook, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores _, hypens -, and decimal point .. If this parameter value is not specified, the default value is lifecycle hook id.

notification_arn: pulumi.Output[str] = None¶: The Arn of notification target.

notification_metadata: pulumi.Output[str] = None¶: Additional information that you want to include when Auto Scaling sends a message to the notification target.

scaling_group_id: pulumi.Output[str] = None¶: The ID of the Auto Scaling group to which you want to assign the lifecycle hook.

static get(resource_name, id, opts=None, default_result=None, heartbeat_timeout=None, lifecycle_transition=None, name=None, notification_arn=None, notification_metadata=None, scaling_group_id=None)¶

Get an existing LifecycleHook 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_result (pulumi.Input[str]) – Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses. Applicable value: CONTINUE, ABANDON, default value: CONTINUE.
heartbeat_timeout (pulumi.Input[float]) – Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the default_result parameter. Default value: 600.
lifecycle_transition (pulumi.Input[str]) – Type of Scaling activity attached to lifecycle hook. Supported value: SCALE_OUT, SCALE*IN.
name (pulumi.Input[str]) – The name of the lifecycle hook, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores *`, hypens``-, and decimal point.`. If this parameter value is not specified, the default value is lifecycle hook id.
notification_arn (pulumi.Input[str]) – The Arn of notification target.
notification_metadata (pulumi.Input[str]) – Additional information that you want to include when Auto Scaling sends a message to the notification target.
scaling_group_id (pulumi.Input[str]) – The ID of the Auto Scaling group to which you want to assign the lifecycle hook.

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.ess.Notification(resource_name, opts=None, notification_arn=None, notification_types=None, scaling_group_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a ESS notification resource. More about Ess notification, see Autoscaling Notification.

NOTE: Available in 1.55.0+

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf-testAccEssNotification-%d"
default_regions = alicloud.get_regions(current=True)
default_account = alicloud.get_account()
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_scaling_group = alicloud.ess.ScalingGroup("defaultScalingGroup",
    max_size=1,
    min_size=1,
    removal_policies=[
        "OldestInstance",
        "NewestInstance",
    ],
    scaling_group_name=name,
    vswitch_ids=[default_switch.id])
default_queue = alicloud.mns.Queue("defaultQueue")
default_notification = alicloud.ess.Notification("defaultNotification",
    notification_arn=default_queue.name.apply(lambda name: f"acs:ess:{default_regions.regions[0]['id']}:{default_account.id}:queue/{name}"),
    notification_types=[
        "AUTOSCALING:SCALE_OUT_SUCCESS",
        "AUTOSCALING:SCALE_OUT_ERROR",
    ],
    scaling_group_id=default_scaling_group.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
notification_arn (pulumi.Input[str]) – The Alibaba Cloud Resource Name (ARN) of the notification object, The value must be in acs:ess:{region}:{account-id}:{resource-relative-id} format.

* region: the region ID of the scaling group. For more information, see `Regions and zones`
* account-id: the ID of your account.
* resource-relative-id: the notification method. Valid values : `cloudmonitor`, MNS queue: `queue/{queuename}`, Replace the queuename with the specific MNS queue name, MNS topic: `topic/{topicname}`, Replace the topicname with the specific MNS topic name.

Parameters

notification_types (pulumi.Input[list]) – The notification types of Auto Scaling events and resource changes. Supported notification types: ‘AUTOSCALING:SCALE_OUT_SUCCESS’, ‘AUTOSCALING:SCALE_IN_SUCCESS’, ‘AUTOSCALING:SCALE_OUT_ERROR’, ‘AUTOSCALING:SCALE_IN_ERROR’, ‘AUTOSCALING:SCALE_REJECT’, ‘AUTOSCALING:SCALE_OUT_START’, ‘AUTOSCALING:SCALE_IN_START’, ‘AUTOSCALING:SCHEDULE_TASK_EXPIRING’.
scaling_group_id (pulumi.Input[str]) – The ID of the Auto Scaling group.

notification_arn: pulumi.Output[str] = None¶

The Alibaba Cloud Resource Name (ARN) of the notification object, The value must be in acs:ess:{region}:{account-id}:{resource-relative-id} format.

region: the region ID of the scaling group. For more information, see Regions and zones
account-id: the ID of your account.
resource-relative-id: the notification method. Valid values : cloudmonitor, MNS queue: queue/{queuename}, Replace the queuename with the specific MNS queue name, MNS topic: topic/{topicname}, Replace the topicname with the specific MNS topic name.

notification_types: pulumi.Output[list] = None¶: The notification types of Auto Scaling events and resource changes. Supported notification types: ‘AUTOSCALING:SCALE_OUT_SUCCESS’, ‘AUTOSCALING:SCALE_IN_SUCCESS’, ‘AUTOSCALING:SCALE_OUT_ERROR’, ‘AUTOSCALING:SCALE_IN_ERROR’, ‘AUTOSCALING:SCALE_REJECT’, ‘AUTOSCALING:SCALE_OUT_START’, ‘AUTOSCALING:SCALE_IN_START’, ‘AUTOSCALING:SCHEDULE_TASK_EXPIRING’.

scaling_group_id: pulumi.Output[str] = None¶: The ID of the Auto Scaling group.

static get(resource_name, id, opts=None, notification_arn=None, notification_types=None, scaling_group_id=None)¶

Get an existing Notification 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.
notification_arn (pulumi.Input[str]) – The Alibaba Cloud Resource Name (ARN) of the notification object, The value must be in acs:ess:{region}:{account-id}:{resource-relative-id} format.

* region: the region ID of the scaling group. For more information, see `Regions and zones`
* account-id: the ID of your account.
* resource-relative-id: the notification method. Valid values : `cloudmonitor`, MNS queue: `queue/{queuename}`, Replace the queuename with the specific MNS queue name, MNS topic: `topic/{topicname}`, Replace the topicname with the specific MNS topic name.

Parameters

notification_types (pulumi.Input[list]) – The notification types of Auto Scaling events and resource changes. Supported notification types: ‘AUTOSCALING:SCALE_OUT_SUCCESS’, ‘AUTOSCALING:SCALE_IN_SUCCESS’, ‘AUTOSCALING:SCALE_OUT_ERROR’, ‘AUTOSCALING:SCALE_IN_ERROR’, ‘AUTOSCALING:SCALE_REJECT’, ‘AUTOSCALING:SCALE_OUT_START’, ‘AUTOSCALING:SCALE_IN_START’, ‘AUTOSCALING:SCHEDULE_TASK_EXPIRING’.
scaling_group_id (pulumi.Input[str]) – The ID of the Auto Scaling group.

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.ess.ScalingConfiguration(resource_name, opts=None, active=None, data_disks=None, enable=None, force_delete=None, image_id=None, instance_ids=None, instance_name=None, instance_type=None, instance_types=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, override=None, password=None, password_inherit=None, role_name=None, scaling_configuration_name=None, scaling_group_id=None, security_group_id=None, security_group_ids=None, substitute=None, system_disk_category=None, system_disk_size=None, tags=None, user_data=None, __props__=None, __name__=None, __opts__=None)¶

Create a ScalingConfiguration 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] active: Whether active current scaling configuration in the specified scaling group. Default to false. :param pulumi.Input[list] data_disks: DataDisk mappings to attach to ecs instance. See Block datadisk below for details. :param pulumi.Input[bool] enable: Whether enable the specified scaling group(make it active) to which the current scaling configuration belongs. :param pulumi.Input[bool] force_delete: The last scaling configuration will be deleted forcibly with deleting its scaling group. Default to false. :param pulumi.Input[str] image_id: ID of an image file, indicating the image resource selected when an instance is enabled. :param pulumi.Input[list] instance_ids: It has been deprecated from version 1.6.0. New resource ess.Attachment replaces it. :param pulumi.Input[str] instance_name: Name of an ECS instance. Default to “ESS-Instance”. It is valid from version 1.7.1. :param pulumi.Input[str] instance_type: Resource type of an ECS instance. :param pulumi.Input[list] instance_types: Resource types of an ECS instance. :param pulumi.Input[str] internet_charge_type: Network billing type, Values: PayByBandwidth or PayByTraffic. Default to PayByBandwidth. :param pulumi.Input[float] internet_max_bandwidth_in: Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second). The value range is [1,200]. :param pulumi.Input[float] internet_max_bandwidth_out: Maximum outgoing bandwidth from the public network, measured in Mbps (Mega bit per second). The value range for PayByBandwidth is [0,100]. :param pulumi.Input[str] io_optimized: It has been deprecated on instance resource. All the launched alicloud instances will be I/O optimized. :param pulumi.Input[bool] is_outdated: Whether to use outdated instance type. Default to false. :param pulumi.Input[str] key_name: The name of key pair that can login ECS instance successfully without password. If it is specified, the password would be invalid. :param pulumi.Input[str] kms_encrypted_password: An KMS encrypts password used to a db account. If the password is filled in, this field will be ignored. :param pulumi.Input[dict] kms_encryption_context: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set. :param pulumi.Input[bool] override: Indicates whether to overwrite the existing data. Default to false. :param pulumi.Input[str] password: The password of the ECS instance. The password must be 8 to 30 characters in length. It must contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include () ~!@#$%^&*-_+=\|{}[]:;'<>,.?/, The password of Windows-based instances cannot start with a forward slash (/). :param pulumi.Input[bool] password_inherit: Specifies whether to use the password that is predefined in the image. If the PasswordInherit parameter is set to true, the password and kms_encrypted_password will be ignored. You must ensure that the selected image has a password configured. :param pulumi.Input[str] role_name: Instance RAM role name. The name is provided and maintained by RAM. You can use ram.Role to create a new one. :param pulumi.Input[str] scaling_configurationname: Name shown for the scheduled task. which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores `, hypens-, and decimal point.. If this parameter value is not specified, the default value is ScalingConfigurationId. :param pulumi.Input[str] scaling_group_id: ID of the scaling group of a scaling configuration. :param pulumi.Input[str] security_group_id: ID of the security group used to create new instance. It is conflict withsecurity_group_ids. :param pulumi.Input[list] security_group_ids: List IDs of the security group used to create new instances. It is conflict withsecurity_group_id. :param pulumi.Input[str] substitute: The another scaling configuration which will be active automatically and replace current configuration when settingactiveto 'false'. It is invalid whenactiveis 'true'. :param pulumi.Input[str] system_disk_category: Category of the system disk. The parameter value options areephemeral_ssd,cloud_efficiency,cloud_ssd,cloud_essdandcloud.cloudonly is used to some no I/O optimized instance. Default tocloud_efficiency`. :param pulumi.Input[float] system_disk_size: Size of system disk, in GiB. Optional values: cloud: 20-500, cloud_efficiency: 20-500, cloud_ssd: 20-500, ephemeral_ssd: 20-500 The default value is max{40, ImageSize}. If this parameter is set, the system disk size must be greater than or equal to max{40, ImageSize}. :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource. It will be applied for ECS instances finally.

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

Parameters: user_data (pulumi.Input[str]) – User-defined data to customize the startup behaviors of the ECS instance and to pass data into the ECS instance.

The data_disks object supports the following:

category (pulumi.Input[str])
delete_with_instance (pulumi.Input[bool])
device (pulumi.Input[str])
size (pulumi.Input[float])
snapshot_id (pulumi.Input[str])

active: pulumi.Output[bool] = None¶: Whether active current scaling configuration in the specified scaling group. Default to false.

data_disks: pulumi.Output[list] = None¶

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

category (str)
delete_with_instance (bool)
device (str)
size (float)
snapshot_id (str)

enable: pulumi.Output[bool] = None¶: Whether enable the specified scaling group(make it active) to which the current scaling configuration belongs.

force_delete: pulumi.Output[bool] = None¶: The last scaling configuration will be deleted forcibly with deleting its scaling group. Default to false.

image_id: pulumi.Output[str] = None¶: ID of an image file, indicating the image resource selected when an instance is enabled.

instance_ids: pulumi.Output[list] = None¶: It has been deprecated from version 1.6.0. New resource ess.Attachment replaces it.

instance_name: pulumi.Output[str] = None¶: Name of an ECS instance. Default to “ESS-Instance”. It is valid from version 1.7.1.

instance_type: pulumi.Output[str] = None¶: Resource type of an ECS instance.

instance_types: pulumi.Output[list] = None¶: Resource types of an ECS instance.

internet_charge_type: pulumi.Output[str] = None¶: Network billing type, Values: PayByBandwidth or PayByTraffic. Default to PayByBandwidth.

internet_max_bandwidth_in: pulumi.Output[float] = None¶: Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second). The value range is [1,200].

internet_max_bandwidth_out: pulumi.Output[float] = None¶: Maximum outgoing bandwidth from the public network, measured in Mbps (Mega bit per second). The value range for PayByBandwidth is [0,100].

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 a db account. If the password is filled in, this field will be ignored.

kms_encryption_context: pulumi.Output[dict] = None¶: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

override: pulumi.Output[bool] = None¶: Indicates whether to overwrite the existing data. Default to false.

password: pulumi.Output[str] = None¶: The password of the ECS instance. The password must be 8 to 30 characters in length. It must contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include () ~!@#$%^&*-_+=\|{}[]:;'<>,.?/, The password of Windows-based instances cannot start with a forward slash (/).

password_inherit: pulumi.Output[bool] = None¶: Specifies whether to use the password that is predefined in the image. If the PasswordInherit parameter is set to true, the password and kms_encrypted_password will be ignored. You must ensure that the selected image has a password configured.

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.

scaling_configuration_name: pulumi.Output[str] = None¶: Name shown for the scheduled task. which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores _, hypens -, and decimal point .. If this parameter value is not specified, the default value is ScalingConfigurationId.

scaling_group_id: pulumi.Output[str] = None¶: ID of the scaling group of a scaling configuration.

security_group_id: pulumi.Output[str] = None¶: ID of the security group used to create new instance. It is conflict with security_group_ids.

security_group_ids: pulumi.Output[list] = None¶: List IDs of the security group used to create new instances. It is conflict with security_group_id.

substitute: pulumi.Output[str] = None¶: The another scaling configuration which will be active automatically and replace current configuration when setting active to ‘false’. It is invalid when active is ‘true’.

system_disk_category: pulumi.Output[str] = None¶: Category of the system disk. The parameter value options are ephemeral_ssd, cloud_efficiency, cloud_ssd, cloud_essd and cloud. cloud only is used to some no I/O optimized instance. Default to cloud_efficiency.

system_disk_size: pulumi.Output[float] = None¶: Size of system disk, in GiB. Optional values: cloud: 20-500, cloud_efficiency: 20-500, cloud_ssd: 20-500, ephemeral_ssd: 20-500 The default value is max{40, ImageSize}. If this parameter is set, the system disk size must be greater than or equal to max{40, ImageSize}.

tags: pulumi.Output[dict] = None¶

A mapping of tags to assign to the resource. It will be applied for ECS instances finally.

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

user_data: pulumi.Output[str] = None¶: User-defined data to customize the startup behaviors of the ECS instance and to pass data into the ECS instance.

static get(resource_name, id, opts=None, active=None, data_disks=None, enable=None, force_delete=None, image_id=None, instance_ids=None, instance_name=None, instance_type=None, instance_types=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, override=None, password=None, password_inherit=None, role_name=None, scaling_configuration_name=None, scaling_group_id=None, security_group_id=None, security_group_ids=None, substitute=None, system_disk_category=None, system_disk_size=None, tags=None, user_data=None)¶

Get an existing ScalingConfiguration 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.
active (pulumi.Input[bool]) – Whether active current scaling configuration in the specified scaling group. Default to false.
data_disks (pulumi.Input[list]) – DataDisk mappings to attach to ecs instance. See Block datadisk below for details.
enable (pulumi.Input[bool]) – Whether enable the specified scaling group(make it active) to which the current scaling configuration belongs.
force_delete (pulumi.Input[bool]) – The last scaling configuration will be deleted forcibly with deleting its scaling group. Default to false.
image_id (pulumi.Input[str]) – ID of an image file, indicating the image resource selected when an instance is enabled.
instance_ids (pulumi.Input[list]) – It has been deprecated from version 1.6.0. New resource ess.Attachment replaces it.
instance_name (pulumi.Input[str]) – Name of an ECS instance. Default to “ESS-Instance”. It is valid from version 1.7.1.
instance_type (pulumi.Input[str]) – Resource type of an ECS instance.
instance_types (pulumi.Input[list]) – Resource types of an ECS instance.
internet_charge_type (pulumi.Input[str]) – Network billing type, Values: PayByBandwidth or PayByTraffic. Default to PayByBandwidth.
internet_max_bandwidth_in (pulumi.Input[float]) – Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second). The value range is [1,200].
internet_max_bandwidth_out (pulumi.Input[float]) – Maximum outgoing bandwidth from the public network, measured in Mbps (Mega bit per second). The value range for PayByBandwidth is [0,100].
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 a db account. If the password is filled in, this field will be ignored.
kms_encryption_context (pulumi.Input[dict]) –
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
override (pulumi.Input[bool]) – Indicates whether to overwrite the existing data. Default to false.
password (pulumi.Input[str]) – The password of the ECS instance. The password must be 8 to 30 characters in length. It must contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include () ~!@#$%^&*-_+=\|{}[]:;'<>,.?/, The password of Windows-based instances cannot start with a forward slash (/).
password_inherit (pulumi.Input[bool]) – Specifies whether to use the password that is predefined in the image. If the PasswordInherit parameter is set to true, the password and kms_encrypted_password will be ignored. You must ensure that the selected image has a password configured.
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.
scaling_configuration*name (pulumi.Input[str]) –
Name shown for the scheduled task. which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores *`, hypens``-, and decimal point.``. If this parameter value is not specified, the default value is ScalingConfigurationId.
scaling_group_id (pulumi.Input[str]) – ID of the scaling group of a scaling configuration.
security_group_id (pulumi.Input[str]) – ID of the security group used to create new instance. It is conflict with``security_group_ids``.
security_group_ids (pulumi.Input[list]) – List IDs of the security group used to create new instances. It is conflict with``security_group_id``.
substitute (pulumi.Input[str]) – The another scaling configuration which will be active automatically and replace current configuration when setting``activeto 'false'. It is invalid whenactive``is ‘true’.
system_disk_category (pulumi.Input[str]) – Category of the system disk. The parameter value options are``ephemeral_ssd,cloud_efficiency,cloud_ssd,cloud_essdandcloud.cloudonly is used to some no I/O optimized instance. Default tocloud_efficiency`.
system_disk_size (pulumi.Input[float]) – Size of system disk, in GiB. Optional values: cloud: 20-500, cloud_efficiency: 20-500, cloud_ssd: 20-500, ephemeral_ssd: 20-500 The default value is max{40, ImageSize}. If this parameter is set, the system disk size must be greater than or equal to max{40, ImageSize}.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. It will be applied for ECS instances finally.

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

Parameters: user_data (pulumi.Input[str]) – User-defined data to customize the startup behaviors of the ECS instance and to pass data into the ECS instance.

The data_disks object supports the following:

category (pulumi.Input[str])
delete_with_instance (pulumi.Input[bool])
device (pulumi.Input[str])
size (pulumi.Input[float])
snapshot_id (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.ess.ScalingGroup(resource_name, opts=None, db_instance_ids=None, default_cooldown=None, desired_capacity=None, loadbalancer_ids=None, max_size=None, min_size=None, multi_az_policy=None, on_demand_base_capacity=None, on_demand_percentage_above_base_capacity=None, removal_policies=None, scaling_group_name=None, spot_instance_pools=None, spot_instance_remedy=None, vswitch_id=None, vswitch_ids=None, __props__=None, __name__=None, __opts__=None)¶

Create a ScalingGroup 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[list] db_instance_ids: If an RDS instance is specified in the scaling group, the scaling group automatically attaches the Intranet IP addresses of its ECS instances to the RDS access whitelist.

- The specified RDS instance must be in running status.
- The specified RDS instance’s whitelist must have room for more IP addresses.

Parameters

default_cooldown (pulumi.Input[float]) – Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.
desired_capacity (pulumi.Input[float]) – Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].
loadbalancer_ids (pulumi.Input[list]) – If a Server Load Balancer instance is specified in the scaling group, the scaling group automatically attaches its ECS instances to the Server Load Balancer instance.

- The Server Load Balancer instance must be enabled.
- At least one listener must be configured for each Server Load Balancer and it HealthCheck must be on. Otherwise, creation will fail (it may be useful to add a `depends_on` argument
targeting your `slb.Listener` in order to make sure the listener with its HealthCheck configuration is ready before creating your scaling group).
- The Server Load Balancer instance attached with VPC-type ECS instances cannot be attached to the scaling group.
- The default weight of an ECS instance attached to the Server Load Balancer instance is 50.

Parameters

max_size (pulumi.Input[float]) – Maximum number of ECS instances in the scaling group. Value range: [0, 1000].
min_size (pulumi.Input[float]) – Minimum number of ECS instances in the scaling group. Value range: [0, 1000].
multi_az_policy (pulumi.Input[str]) – Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).
on_demand_base_capacity (pulumi.Input[float]) – The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.
on_demand_percentage_above_base_capacity (pulumi.Input[float]) – Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
removal_policies (pulumi.Input[list]) – RemovalPolicy is used to select the ECS instances you want to remove from the scaling group when multiple candidates for removal exist. Optional values:

- OldestInstance: removes the ECS instance that is added to the scaling group at the earliest point in time.
- NewestInstance: removes the ECS instance that is added to the scaling group at the latest point in time.
- OldestScalingConfiguration: removes the ECS instance that is created based on the earliest scaling configuration.
- Default values: Default value of RemovalPolicy.1: OldestScalingConfiguration. Default value of RemovalPolicy.2: OldestInstance.

Parameters

scaling_group*name (pulumi.Input[str]) –
Name shown for the scaling group, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain numbers, underscores *`, hyphens``-, and decimal points.`. If this parameter is not specified, the default value is ScalingGroupId.
spot_instance_pools (pulumi.Input[float]) – The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.
spot_instance_remedy (pulumi.Input[bool]) – Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.
vswitch_id (pulumi.Input[str]) – It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.
vswitch_ids (pulumi.Input[list]) – List of virtual switch IDs in which the ecs instances to be launched.

db_instance_ids: pulumi.Output[list] = None¶

If an RDS instance is specified in the scaling group, the scaling group automatically attaches the Intranet IP addresses of its ECS instances to the RDS access whitelist.

The specified RDS instance must be in running status.
The specified RDS instance’s whitelist must have room for more IP addresses.

default_cooldown: pulumi.Output[float] = None¶: Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

desired_capacity: pulumi.Output[float] = None¶: Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

loadbalancer_ids: pulumi.Output[list] = None¶

If a Server Load Balancer instance is specified in the scaling group, the scaling group automatically attaches its ECS instances to the Server Load Balancer instance.

The Server Load Balancer instance must be enabled.
At least one listener must be configured for each Server Load Balancer and it HealthCheck must be on. Otherwise, creation will fail (it may be useful to add a depends_on argument targeting your slb.Listener in order to make sure the listener with its HealthCheck configuration is ready before creating your scaling group).
The Server Load Balancer instance attached with VPC-type ECS instances cannot be attached to the scaling group.
The default weight of an ECS instance attached to the Server Load Balancer instance is 50.

max_size: pulumi.Output[float] = None¶: Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

min_size: pulumi.Output[float] = None¶: Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

multi_az_policy: pulumi.Output[str] = None¶: Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

on_demand_base_capacity: pulumi.Output[float] = None¶: The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

on_demand_percentage_above_base_capacity: pulumi.Output[float] = None¶: Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

removal_policies: pulumi.Output[list] = None¶

RemovalPolicy is used to select the ECS instances you want to remove from the scaling group when multiple candidates for removal exist. Optional values:

OldestInstance: removes the ECS instance that is added to the scaling group at the earliest point in time.
NewestInstance: removes the ECS instance that is added to the scaling group at the latest point in time.
OldestScalingConfiguration: removes the ECS instance that is created based on the earliest scaling configuration.
Default values: Default value of RemovalPolicy.1: OldestScalingConfiguration. Default value of RemovalPolicy.2: OldestInstance.

scaling_group_name: pulumi.Output[str] = None¶: Name shown for the scaling group, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain numbers, underscores _, hyphens -, and decimal points .. If this parameter is not specified, the default value is ScalingGroupId.

spot_instance_pools: pulumi.Output[float] = None¶: The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.

spot_instance_remedy: pulumi.Output[bool] = None¶: Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.

vswitch_id: pulumi.Output[str] = None¶: It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.

vswitch_ids: pulumi.Output[list] = None¶: List of virtual switch IDs in which the ecs instances to be launched.

static get(resource_name, id, opts=None, db_instance_ids=None, default_cooldown=None, desired_capacity=None, loadbalancer_ids=None, max_size=None, min_size=None, multi_az_policy=None, on_demand_base_capacity=None, on_demand_percentage_above_base_capacity=None, removal_policies=None, scaling_group_name=None, spot_instance_pools=None, spot_instance_remedy=None, vswitch_id=None, vswitch_ids=None)¶

Get an existing ScalingGroup 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.
db_instance_ids (pulumi.Input[list]) – If an RDS instance is specified in the scaling group, the scaling group automatically attaches the Intranet IP addresses of its ECS instances to the RDS access whitelist.

- The specified RDS instance must be in running status.
- The specified RDS instance’s whitelist must have room for more IP addresses.

Parameters

default_cooldown (pulumi.Input[float]) – Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.
desired_capacity (pulumi.Input[float]) – Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].
loadbalancer_ids (pulumi.Input[list]) – If a Server Load Balancer instance is specified in the scaling group, the scaling group automatically attaches its ECS instances to the Server Load Balancer instance.

- The Server Load Balancer instance must be enabled.
- At least one listener must be configured for each Server Load Balancer and it HealthCheck must be on. Otherwise, creation will fail (it may be useful to add a `depends_on` argument
targeting your `slb.Listener` in order to make sure the listener with its HealthCheck configuration is ready before creating your scaling group).
- The Server Load Balancer instance attached with VPC-type ECS instances cannot be attached to the scaling group.
- The default weight of an ECS instance attached to the Server Load Balancer instance is 50.

Parameters

max_size (pulumi.Input[float]) – Maximum number of ECS instances in the scaling group. Value range: [0, 1000].
min_size (pulumi.Input[float]) – Minimum number of ECS instances in the scaling group. Value range: [0, 1000].
multi_az_policy (pulumi.Input[str]) – Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).
on_demand_base_capacity (pulumi.Input[float]) – The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.
on_demand_percentage_above_base_capacity (pulumi.Input[float]) – Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
removal_policies (pulumi.Input[list]) – RemovalPolicy is used to select the ECS instances you want to remove from the scaling group when multiple candidates for removal exist. Optional values:

- OldestInstance: removes the ECS instance that is added to the scaling group at the earliest point in time.
- NewestInstance: removes the ECS instance that is added to the scaling group at the latest point in time.
- OldestScalingConfiguration: removes the ECS instance that is created based on the earliest scaling configuration.
- Default values: Default value of RemovalPolicy.1: OldestScalingConfiguration. Default value of RemovalPolicy.2: OldestInstance.

Parameters

scaling_group*name (pulumi.Input[str]) –
Name shown for the scaling group, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain numbers, underscores *`, hyphens``-, and decimal points.`. If this parameter is not specified, the default value is ScalingGroupId.
spot_instance_pools (pulumi.Input[float]) – The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.
spot_instance_remedy (pulumi.Input[bool]) – Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.
vswitch_id (pulumi.Input[str]) – It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.
vswitch_ids (pulumi.Input[list]) – List of virtual switch IDs in which the ecs instances to be launched.

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.ess.ScalingGroupVServerGroups(resource_name, opts=None, force=None, scaling_group_id=None, vserver_groups=None, __props__=None, __name__=None, __opts__=None)¶

Attaches/Detaches vserver groups to a specified scaling group.

NOTE: The load balancer of which vserver groups belongs to must be in active status.
NOTE: If scaling group’s network type is VPC, the vserver groups must be in the same VPC.
NOTE: A scaling group can have at most 5 vserver groups attached by default.
NOTE: Vserver groups and the default group of loadbalancer share the same backend server quota.
NOTE: When attach vserver groups to scaling group, existing ECS instances will be added to vserver groups; Instead, ECS instances will be removed from vserver group when detach.
NOTE: Detach action will be executed before attach action.
NOTE: Vserver group is defined uniquely by loadbalancer_id, vserver_group_id, port.
NOTE: Modifing weight attribute means detach vserver group first and then, attach with new weight parameter.
NOTE: Resource ess.ScalingGroupVServerGroups is available in 1.53.0+.

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "testAccEssVserverGroupsAttachment"
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_load_balancer = alicloud.slb.LoadBalancer("defaultLoadBalancer", vswitch_id=default_switch.id)
default_server_group = alicloud.slb.ServerGroup("defaultServerGroup", load_balancer_id=default_load_balancer.id)
default_listener = []
for range in [{"value": i} for i in range(0, 2)]:
    default_listener.append(alicloud.slb.Listener(f"defaultListener-{range['value']}",
        backend_port="22",
        bandwidth="10",
        frontend_port="22",
        health_check_type="tcp",
        load_balancer_id=[__item.id for __item in [default_load_balancer]][range["value"]],
        protocol="tcp"))
default_scaling_group = alicloud.ess.ScalingGroup("defaultScalingGroup",
    max_size="2",
    min_size="2",
    scaling_group_name=name,
    vswitch_ids=[default_switch.id])
default_scaling_group_v_server_groups = alicloud.ess.ScalingGroupVServerGroups("defaultScalingGroupVServerGroups",
    scaling_group_id=default_scaling_group.id,
    vserver_groups=[{
        "loadbalancerId": default_load_balancer.id,
        "vserverAttributes": [{
            "port": "100",
            "vserver_group_id": default_server_group.id,
            "weight": "60",
        }],
    }])

the vserver_group supports the following:

loadbalancer_id - (Required) Loadbalancer server ID of VServer Group.
vserver_attributes - (Required) A list of VServer Group attributes. See Block vserver_attribute below for details.

vserver_group_id - (Required) ID of VServer Group.
port - (Required) - The port will be used for VServer Group backend server.
weight - (Required) The weight of an ECS instance attached to the VServer Group.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
force (pulumi.Input[bool]) – If instances of scaling group are attached/removed from slb backend server when attach/detach vserver group from scaling group. Default to true.
scaling_group_id (pulumi.Input[str]) – ID of the scaling group.
vserver_groups (pulumi.Input[list]) – A list of vserver groups attached on scaling group. See Block vserver_group below for details.

The vserver_groups object supports the following:

loadbalancerId (pulumi.Input[str])
vserverAttributes (pulumi.Input[list])
- port (pulumi.Input[float])
- vserver_group_id (pulumi.Input[str])
- weight (pulumi.Input[float])

force: pulumi.Output[bool] = None¶: If instances of scaling group are attached/removed from slb backend server when attach/detach vserver group from scaling group. Default to true.

scaling_group_id: pulumi.Output[str] = None¶: ID of the scaling group.

vserver_groups: pulumi.Output[list] = None¶

A list of vserver groups attached on scaling group. See Block vserver_group below for details.

loadbalancerId (str)
vserverAttributes (list)
- port (float)
- vserver_group_id (str)
- weight (float)

static get(resource_name, id, opts=None, force=None, scaling_group_id=None, vserver_groups=None)¶

Get an existing ScalingGroupVServerGroups 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.
force (pulumi.Input[bool]) – If instances of scaling group are attached/removed from slb backend server when attach/detach vserver group from scaling group. Default to true.
scaling_group_id (pulumi.Input[str]) – ID of the scaling group.
vserver_groups (pulumi.Input[list]) – A list of vserver groups attached on scaling group. See Block vserver_group below for details.

The vserver_groups object supports the following:

loadbalancerId (pulumi.Input[str])
vserverAttributes (pulumi.Input[list])
- port (pulumi.Input[float])
- vserver_group_id (pulumi.Input[str])
- weight (pulumi.Input[float])

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.ess.ScalingRule(resource_name, opts=None, adjustment_type=None, adjustment_value=None, cooldown=None, disable_scale_in=None, estimated_instance_warmup=None, metric_name=None, scaling_group_id=None, scaling_rule_name=None, scaling_rule_type=None, step_adjustments=None, target_value=None, __props__=None, __name__=None, __opts__=None)¶

Create a ScalingRule 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] adjustment_type: Adjustment mode of a scaling rule. Optional values:

- QuantityChangeInCapacity: It is used to increase or decrease a specified number of ECS instances.
- PercentChangeInCapacity: It is used to increase or decrease a specified proportion of ECS instances.
- TotalCapacity: It is used to adjust the quantity of ECS instances in the current scaling group to a specified value.

Parameters: adjustment_value (pulumi.Input[float]) – Adjusted value of a scaling rule. Value range:

- QuantityChangeInCapacity：(0, 500] U (-500, 0]
- PercentChangeInCapacity：[0, 10000] U [-100, 0]
- TotalCapacity：[0, 1000]

Parameters

cooldown (pulumi.Input[float]) – Cool-down time of a scaling rule. Value range: [0, 86,400], in seconds. The default value is empty，if not set, the return value will be 0, which is the default value of integer.
disable_scale_in (pulumi.Input[bool]) – Indicates whether scale in by the target tracking policy is disabled. Default to false.
estimated_instance_warmup (pulumi.Input[float]) – The estimated time, in seconds, until a newly launched instance will contribute CloudMonitor metrics. Default to 300.
metric_name (pulumi.Input[str]) – A CloudMonitor metric name.
scaling_group_id (pulumi.Input[str]) – ID of the scaling group of a scaling rule.
scaling_rule*name (pulumi.Input[str]) –
Name shown for the scaling rule, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores *`, hypens``-, and decimal point.`. If this parameter value is not specified, the default value is scaling rule id.
scaling_rule_type (pulumi.Input[str]) – The scaling rule type, either “SimpleScalingRule”, “TargetTrackingScalingRule”, “StepScalingRule”. Default to “SimpleScalingRule”.
step_adjustments (pulumi.Input[list]) – Steps for StepScalingRule. See Block stepAdjustment below for details.
target_value (pulumi.Input[float]) – The target value for the metric.

The step_adjustments object supports the following:

metricIntervalLowerBound (pulumi.Input[str])
metricIntervalUpperBound (pulumi.Input[str])
scalingAdjustment (pulumi.Input[float])

adjustment_type: pulumi.Output[str] = None¶

Adjustment mode of a scaling rule. Optional values:

QuantityChangeInCapacity: It is used to increase or decrease a specified number of ECS instances.
PercentChangeInCapacity: It is used to increase or decrease a specified proportion of ECS instances.
TotalCapacity: It is used to adjust the quantity of ECS instances in the current scaling group to a specified value.

adjustment_value: pulumi.Output[float] = None¶

Adjusted value of a scaling rule. Value range:

QuantityChangeInCapacity：(0, 500] U (-500, 0]
PercentChangeInCapacity：[0, 10000] U [-100, 0]
TotalCapacity：[0, 1000]

cooldown: pulumi.Output[float] = None¶: Cool-down time of a scaling rule. Value range: [0, 86,400], in seconds. The default value is empty，if not set, the return value will be 0, which is the default value of integer.

disable_scale_in: pulumi.Output[bool] = None¶: Indicates whether scale in by the target tracking policy is disabled. Default to false.

estimated_instance_warmup: pulumi.Output[float] = None¶: The estimated time, in seconds, until a newly launched instance will contribute CloudMonitor metrics. Default to 300.

metric_name: pulumi.Output[str] = None¶: A CloudMonitor metric name.

scaling_group_id: pulumi.Output[str] = None¶: ID of the scaling group of a scaling rule.

scaling_rule_name: pulumi.Output[str] = None¶: Name shown for the scaling rule, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores _, hypens -, and decimal point .. If this parameter value is not specified, the default value is scaling rule id.

scaling_rule_type: pulumi.Output[str] = None¶: The scaling rule type, either “SimpleScalingRule”, “TargetTrackingScalingRule”, “StepScalingRule”. Default to “SimpleScalingRule”.

step_adjustments: pulumi.Output[list] = None¶

Steps for StepScalingRule. See Block stepAdjustment below for details.

metricIntervalLowerBound (str)
metricIntervalUpperBound (str)
scalingAdjustment (float)

target_value: pulumi.Output[float] = None¶: The target value for the metric.

static get(resource_name, id, opts=None, adjustment_type=None, adjustment_value=None, ari=None, cooldown=None, disable_scale_in=None, estimated_instance_warmup=None, metric_name=None, scaling_group_id=None, scaling_rule_name=None, scaling_rule_type=None, step_adjustments=None, target_value=None)¶

Get an existing ScalingRule 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.
adjustment_type (pulumi.Input[str]) – Adjustment mode of a scaling rule. Optional values:

- QuantityChangeInCapacity: It is used to increase or decrease a specified number of ECS instances.
- PercentChangeInCapacity: It is used to increase or decrease a specified proportion of ECS instances.
- TotalCapacity: It is used to adjust the quantity of ECS instances in the current scaling group to a specified value.

Parameters: adjustment_value (pulumi.Input[float]) – Adjusted value of a scaling rule. Value range:

- QuantityChangeInCapacity：(0, 500] U (-500, 0]
- PercentChangeInCapacity：[0, 10000] U [-100, 0]
- TotalCapacity：[0, 1000]

Parameters

cooldown (pulumi.Input[float]) – Cool-down time of a scaling rule. Value range: [0, 86,400], in seconds. The default value is empty，if not set, the return value will be 0, which is the default value of integer.
disable_scale_in (pulumi.Input[bool]) – Indicates whether scale in by the target tracking policy is disabled. Default to false.
estimated_instance_warmup (pulumi.Input[float]) – The estimated time, in seconds, until a newly launched instance will contribute CloudMonitor metrics. Default to 300.
metric_name (pulumi.Input[str]) – A CloudMonitor metric name.
scaling_group_id (pulumi.Input[str]) – ID of the scaling group of a scaling rule.
scaling_rule*name (pulumi.Input[str]) –
Name shown for the scaling rule, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain number, underscores *`, hypens``-, and decimal point.`. If this parameter value is not specified, the default value is scaling rule id.
scaling_rule_type (pulumi.Input[str]) – The scaling rule type, either “SimpleScalingRule”, “TargetTrackingScalingRule”, “StepScalingRule”. Default to “SimpleScalingRule”.
step_adjustments (pulumi.Input[list]) – Steps for StepScalingRule. See Block stepAdjustment below for details.
target_value (pulumi.Input[float]) – The target value for the metric.

The step_adjustments object supports the following:

metricIntervalLowerBound (pulumi.Input[str])
metricIntervalUpperBound (pulumi.Input[str])
scalingAdjustment (pulumi.Input[float])

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.ess.Schedule(resource_name, opts=None, description=None, launch_expiration_time=None, launch_time=None, recurrence_end_time=None, recurrence_type=None, recurrence_value=None, scheduled_action=None, scheduled_task_name=None, task_enabled=None, __props__=None, __name__=None, __opts__=None)¶

Create a Schedule 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, launch_expiration_time=None, launch_time=None, recurrence_end_time=None, recurrence_type=None, recurrence_value=None, scheduled_action=None, scheduled_task_name=None, task_enabled=None)¶

Get an existing Schedule 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.ess.ScheduledTask(resource_name, opts=None, description=None, launch_expiration_time=None, launch_time=None, recurrence_end_time=None, recurrence_type=None, recurrence_value=None, scheduled_action=None, scheduled_task_name=None, task_enabled=None, __props__=None, __name__=None, __opts__=None)¶

Create a ScheduledTask 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] description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long. :param pulumi.Input[float] launch_expiration_time: The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600 :param pulumi.Input[str] launch_time: The time at which the scheduled task is triggered. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.

The time must be in UTC. You cannot enter a time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.

Parameters

recurrence_end_time (pulumi.Input[str]) – Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation.
recurrence_type (pulumi.Input[str]) – Specifies the recurrence type of the scheduled task. If set, both recurrence_value and recurrence_end_time must be set. Valid values:

- Daily: The scheduled task is executed once every specified number of days.
- Weekly: The scheduled task is executed on each specified day of a week.
- Monthly: The scheduled task is executed on each specified day of a month.
- Cron: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.

Parameters: recurrence_value (pulumi.Input[str]) – Specifies how often a scheduled task recurs. The valid value depends on recurrence_type

- Daily: You can enter one value. Valid values: 1 to 31.
- Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
- Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
- Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.

Parameters

scheduled_action (pulumi.Input[str]) – The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule.
scheduled_task_name (pulumi.Input[str]) – Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
task_enabled (pulumi.Input[bool]) – Specifies whether to start the scheduled task. Default to true.

description: pulumi.Output[str] = None¶: Description of the scheduled task, which is 2-200 characters (English or Chinese) long.

launch_expiration_time: pulumi.Output[float] = None¶: The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600

launch_time: pulumi.Output[str] = None¶: The time at which the scheduled task is triggered. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.

recurrence_end_time: pulumi.Output[str] = None¶: Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation.

recurrence_type: pulumi.Output[str] = None¶

Specifies the recurrence type of the scheduled task. If set, both recurrence_value and recurrence_end_time must be set. Valid values:

Daily: The scheduled task is executed once every specified number of days.
Weekly: The scheduled task is executed on each specified day of a week.
Monthly: The scheduled task is executed on each specified day of a month.
Cron: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.

recurrence_value: pulumi.Output[str] = None¶

Specifies how often a scheduled task recurs. The valid value depends on recurrence_type

Daily: You can enter one value. Valid values: 1 to 31.
Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.

scheduled_action: pulumi.Output[str] = None¶: The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule.

scheduled_task_name: pulumi.Output[str] = None¶: Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.

task_enabled: pulumi.Output[bool] = None¶: Specifies whether to start the scheduled task. Default to true.

Get an existing ScheduledTask 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]) – Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
launch_expiration_time (pulumi.Input[float]) – The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
launch_time (pulumi.Input[str]) – The time at which the scheduled task is triggered. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
recurrence_end_time (pulumi.Input[str]) – Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation.
recurrence_type (pulumi.Input[str]) – Specifies the recurrence type of the scheduled task. If set, both recurrence_value and recurrence_end_time must be set. Valid values:

- Daily: The scheduled task is executed once every specified number of days.
- Weekly: The scheduled task is executed on each specified day of a week.
- Monthly: The scheduled task is executed on each specified day of a month.
- Cron: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.

Parameters: recurrence_value (pulumi.Input[str]) – Specifies how often a scheduled task recurs. The valid value depends on recurrence_type

- Daily: You can enter one value. Valid values: 1 to 31.
- Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
- Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
- Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.

Parameters

scheduled_action (pulumi.Input[str]) – The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule.
scheduled_task_name (pulumi.Input[str]) – Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
task_enabled (pulumi.Input[bool]) – Specifies whether to start the scheduled task. Default to true.

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

pulumi_alicloud.ess.get_alarms(ids=None, metric_type=None, name_regex=None, output_file=None, scaling_group_id=None, opts=None)¶

This data source provides available alarm resources.

NOTE Available in 1.72.0+

Parameters

ids (list) – A list of alarm IDs.
metric_type (str) – The type for the alarm’s associated metric. Supported value: system, custom. “system” means the metric data is collected by Aliyun Cloud Monitor Service(CMS), “custom” means the metric data is upload to CMS by users. Defaults to system.
name_regex (str) – A regex string to filter resulting alarms by name.
scaling_group_id (str) – Scaling group id the alarms belong to.

pulumi_alicloud.ess.get_lifecycle_hooks(ids=None, name_regex=None, output_file=None, scaling_group_id=None, opts=None)¶

This data source provides available lifecycle hook resources.

NOTE: Available in 1.72.0+

import pulumi
import pulumi_alicloud as alicloud

ds = alicloud.ess.get_lifecycle_hooks(name_regex="lifecyclehook_name",
    scaling_group_id="scaling_group_id")
pulumi.export("firstLifecycleHook", ds.hooks[0]["id"])

Parameters

ids (list) – A list of lifecycle hook IDs.
name_regex (str) – A regex string to filter resulting lifecycle hook by name.
scaling_group_id (str) – Scaling group id the lifecycle hooks belong to.

pulumi_alicloud.ess.get_notifications(ids=None, output_file=None, scaling_group_id=None, opts=None)¶

This data source provides available notification resources.

NOTE: Available in 1.72.0+

import pulumi
import pulumi_alicloud as alicloud

ds = alicloud.ess.get_notifications(scaling_group_id="scaling_group_id")
pulumi.export("firstNotification", ds.notifications[0]["id"])

Parameters

ids (list) – A list of notification ids.
scaling_group_id (str) – Scaling group id the notifications belong to.

pulumi_alicloud.ess.get_scaling_configurations(ids=None, name_regex=None, output_file=None, scaling_group_id=None, opts=None)¶

This data source provides available scaling configuration resources.

import pulumi
import pulumi_alicloud as alicloud

scalingconfigurations_ds = alicloud.ess.get_scaling_configurations(ids=[
        "scaling_configuration_id1",
        "scaling_configuration_id2",
    ],
    name_regex="scaling_configuration_name",
    scaling_group_id="scaling_group_id")
pulumi.export("firstScalingRule", scalingconfigurations_ds.configurations[0]["id"])

Parameters

ids (list) – A list of scaling configuration IDs.
name_regex (str) – A regex string to filter resulting scaling configurations by name.
scaling_group_id (str) – Scaling group id the scaling configurations belong to.

pulumi_alicloud.ess.get_scaling_groups(ids=None, name_regex=None, output_file=None, opts=None)¶

This data source provides available scaling group resources.

import pulumi
import pulumi_alicloud as alicloud

scalinggroups_ds = alicloud.ess.get_scaling_groups(ids=[
        "scaling_group_id1",
        "scaling_group_id2",
    ],
    name_regex="scaling_group_name")
pulumi.export("firstScalingGroup", scalinggroups_ds.groups[0]["id"])

Parameters

ids (list) – A list of scaling group IDs.
name_regex (str) – A regex string to filter resulting scaling groups by name.

pulumi_alicloud.ess.get_scaling_rules(ids=None, name_regex=None, output_file=None, scaling_group_id=None, type=None, opts=None)¶

This data source provides available scaling rule resources.

import pulumi
import pulumi_alicloud as alicloud

scalingrules_ds = alicloud.ess.get_scaling_rules(ids=[
        "scaling_rule_id1",
        "scaling_rule_id2",
    ],
    name_regex="scaling_rule_name",
    scaling_group_id="scaling_group_id")
pulumi.export("firstScalingRule", scalingrules_ds.rules[0]["id"])

Parameters

ids (list) – A list of scaling rule IDs.
name_regex (str) – A regex string to filter resulting scaling rules by name.
scaling_group_id (str) – Scaling group id the scaling rules belong to.
type (str) – Type of scaling rule.

pulumi_alicloud.ess.get_scheduled_tasks(ids=None, name_regex=None, output_file=None, scheduled_action=None, scheduled_task_id=None, opts=None)¶

This data source provides available scheduled task resources.

NOTE: Available in 1.72.0+

import pulumi
import pulumi_alicloud as alicloud

ds = alicloud.ess.get_scheduled_tasks(name_regex="scheduled_task_name",
    scheduled_task_id="scheduled_task_id")
pulumi.export("firstScheduledTask", ds.tasks[0]["id"])

Parameters

ids (list) – A list of scheduled task IDs.
name_regex (str) – A regex string to filter resulting scheduled tasks by name.
scheduled_action (str) – The operation to be performed when a scheduled task is triggered.
scheduled_task_id (str) – The id of the scheduled task.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

ess¶

On This Page