1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. ess
  5. InstanceRefresh
Alibaba Cloud v3.87.0 published on Saturday, Oct 18, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.ess.InstanceRefresh

Deploy with Pulumi
alicloud logo
Alibaba Cloud v3.87.0 published on Saturday, Oct 18, 2025 by Pulumi
pulumi/pulumi-alicloud

    Import

    ESS instance refresh can be imported using the id, e.g.

    $ pulumi import alicloud:ess/instanceRefresh:InstanceRefresh example ir-abc123456

    Create InstanceRefresh Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new InstanceRefresh(name: string, args: InstanceRefreshArgs, opts?: CustomResourceOptions);
    @overload
def InstanceRefresh(resource_name: str,
                    args: InstanceRefreshArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def InstanceRefresh(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    scaling_group_id: Optional[str] = None,
                    checkpoint_pause_time: Optional[int] = None,
                    checkpoints: Optional[Sequence[InstanceRefreshCheckpointArgs]] = None,
                    desired_configuration_containers: Optional[Sequence[InstanceRefreshDesiredConfigurationContainerArgs]] = None,
                    desired_configuration_image_id: Optional[str] = None,
                    desired_configuration_launch_template_id: Optional[str] = None,
                    desired_configuration_launch_template_overrides: Optional[Sequence[InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs]] = None,
                    desired_configuration_launch_template_version: Optional[str] = None,
                    max_healthy_percentage: Optional[int] = None,
                    min_healthy_percentage: Optional[int] = None,
                    skip_matching: Optional[bool] = None,
                    status: Optional[str] = None)
    func NewInstanceRefresh(ctx *Context, name string, args InstanceRefreshArgs, opts ...ResourceOption) (*InstanceRefresh, error)
    public InstanceRefresh(string name, InstanceRefreshArgs args, CustomResourceOptions? opts = null)
    public InstanceRefresh(String name, InstanceRefreshArgs args)
public InstanceRefresh(String name, InstanceRefreshArgs args, CustomResourceOptions options)

    type: alicloud:ess:InstanceRefresh
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceRefreshArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceRefreshArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceRefreshArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceRefreshArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceRefreshArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var instanceRefreshResource = new AliCloud.Ess.InstanceRefresh("instanceRefreshResource", new()
{
    ScalingGroupId = "string",
    CheckpointPauseTime = 0,
    Checkpoints = new[]
    {
        new AliCloud.Ess.Inputs.InstanceRefreshCheckpointArgs
        {
            Percentage = 0,
        },
    },
    DesiredConfigurationContainers = new[]
    {
        new AliCloud.Ess.Inputs.InstanceRefreshDesiredConfigurationContainerArgs
        {
            Args = new[]
            {
                "string",
            },
            Commands = new[]
            {
                "string",
            },
            EnvironmentVars = new[]
            {
                new AliCloud.Ess.Inputs.InstanceRefreshDesiredConfigurationContainerEnvironmentVarArgs
                {
                    FieldRefFieldPath = "string",
                    Key = "string",
                    Value = "string",
                },
            },
            Image = "string",
            Name = "string",
        },
    },
    DesiredConfigurationImageId = "string",
    DesiredConfigurationLaunchTemplateId = "string",
    DesiredConfigurationLaunchTemplateOverrides = new[]
    {
        new AliCloud.Ess.Inputs.InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs
        {
            InstanceType = "string",
        },
    },
    DesiredConfigurationLaunchTemplateVersion = "string",
    MaxHealthyPercentage = 0,
    MinHealthyPercentage = 0,
    SkipMatching = false,
    Status = "string",
});

    example, err := ess.NewInstanceRefresh(ctx, "instanceRefreshResource", &ess.InstanceRefreshArgs{
	ScalingGroupId:      pulumi.String("string"),
	CheckpointPauseTime: pulumi.Int(0),
	Checkpoints: ess.InstanceRefreshCheckpointArray{
		&ess.InstanceRefreshCheckpointArgs{
			Percentage: pulumi.Int(0),
		},
	},
	DesiredConfigurationContainers: ess.InstanceRefreshDesiredConfigurationContainerArray{
		&ess.InstanceRefreshDesiredConfigurationContainerArgs{
			Args: pulumi.StringArray{
				pulumi.String("string"),
			},
			Commands: pulumi.StringArray{
				pulumi.String("string"),
			},
			EnvironmentVars: ess.InstanceRefreshDesiredConfigurationContainerEnvironmentVarArray{
				&ess.InstanceRefreshDesiredConfigurationContainerEnvironmentVarArgs{
					FieldRefFieldPath: pulumi.String("string"),
					Key:               pulumi.String("string"),
					Value:             pulumi.String("string"),
				},
			},
			Image: pulumi.String("string"),
			Name:  pulumi.String("string"),
		},
	},
	DesiredConfigurationImageId:          pulumi.String("string"),
	DesiredConfigurationLaunchTemplateId: pulumi.String("string"),
	DesiredConfigurationLaunchTemplateOverrides: ess.InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArray{
		&ess.InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs{
			InstanceType: pulumi.String("string"),
		},
	},
	DesiredConfigurationLaunchTemplateVersion: pulumi.String("string"),
	MaxHealthyPercentage:                      pulumi.Int(0),
	MinHealthyPercentage:                      pulumi.Int(0),
	SkipMatching:                              pulumi.Bool(false),
	Status:                                    pulumi.String("string"),
})

    var instanceRefreshResource = new InstanceRefresh("instanceRefreshResource", InstanceRefreshArgs.builder()
    .scalingGroupId("string")
    .checkpointPauseTime(0)
    .checkpoints(InstanceRefreshCheckpointArgs.builder()
        .percentage(0)
        .build())
    .desiredConfigurationContainers(InstanceRefreshDesiredConfigurationContainerArgs.builder()
        .args("string")
        .commands("string")
        .environmentVars(InstanceRefreshDesiredConfigurationContainerEnvironmentVarArgs.builder()
            .fieldRefFieldPath("string")
            .key("string")
            .value("string")
            .build())
        .image("string")
        .name("string")
        .build())
    .desiredConfigurationImageId("string")
    .desiredConfigurationLaunchTemplateId("string")
    .desiredConfigurationLaunchTemplateOverrides(InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs.builder()
        .instanceType("string")
        .build())
    .desiredConfigurationLaunchTemplateVersion("string")
    .maxHealthyPercentage(0)
    .minHealthyPercentage(0)
    .skipMatching(false)
    .status("string")
    .build());

    instance_refresh_resource = alicloud.ess.InstanceRefresh("instanceRefreshResource",
    scaling_group_id="string",
    checkpoint_pause_time=0,
    checkpoints=[{
        "percentage": 0,
    }],
    desired_configuration_containers=[{
        "args": ["string"],
        "commands": ["string"],
        "environment_vars": [{
            "field_ref_field_path": "string",
            "key": "string",
            "value": "string",
        }],
        "image": "string",
        "name": "string",
    }],
    desired_configuration_image_id="string",
    desired_configuration_launch_template_id="string",
    desired_configuration_launch_template_overrides=[{
        "instance_type": "string",
    }],
    desired_configuration_launch_template_version="string",
    max_healthy_percentage=0,
    min_healthy_percentage=0,
    skip_matching=False,
    status="string")

    const instanceRefreshResource = new alicloud.ess.InstanceRefresh("instanceRefreshResource", {
    scalingGroupId: "string",
    checkpointPauseTime: 0,
    checkpoints: [{
        percentage: 0,
    }],
    desiredConfigurationContainers: [{
        args: ["string"],
        commands: ["string"],
        environmentVars: [{
            fieldRefFieldPath: "string",
            key: "string",
            value: "string",
        }],
        image: "string",
        name: "string",
    }],
    desiredConfigurationImageId: "string",
    desiredConfigurationLaunchTemplateId: "string",
    desiredConfigurationLaunchTemplateOverrides: [{
        instanceType: "string",
    }],
    desiredConfigurationLaunchTemplateVersion: "string",
    maxHealthyPercentage: 0,
    minHealthyPercentage: 0,
    skipMatching: false,
    status: "string",
});

    type: alicloud:ess:InstanceRefresh
properties:
    checkpointPauseTime: 0
    checkpoints:
        - percentage: 0
    desiredConfigurationContainers:
        - args:
            - string
          commands:
            - string
          environmentVars:
            - fieldRefFieldPath: string
              key: string
              value: string
          image: string
          name: string
    desiredConfigurationImageId: string
    desiredConfigurationLaunchTemplateId: string
    desiredConfigurationLaunchTemplateOverrides:
        - instanceType: string
    desiredConfigurationLaunchTemplateVersion: string
    maxHealthyPercentage: 0
    minHealthyPercentage: 0
    scalingGroupId: string
    skipMatching: false
    status: string

    InstanceRefresh Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The InstanceRefresh resource accepts the following input properties:

    ScalingGroupId string
    The ID of the scaling group.
    CheckpointPauseTime int
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    Checkpoints List<Pulumi.AliCloud.Ess.Inputs.InstanceRefreshCheckpoint>
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    DesiredConfigurationContainers List<Pulumi.AliCloud.Ess.Inputs.InstanceRefreshDesiredConfigurationContainer>
    The list of containers in the instance. See desired_configuration_containers below for details.
    DesiredConfigurationImageId string
    The ID of the image file. This is the image resource used for automatic instance creation.
    DesiredConfigurationLaunchTemplateId string
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    DesiredConfigurationLaunchTemplateOverrides List<Pulumi.AliCloud.Ess.Inputs.InstanceRefreshDesiredConfigurationLaunchTemplateOverride>
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    DesiredConfigurationLaunchTemplateVersion string
    The version of the launch template.
    MaxHealthyPercentage int
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    MinHealthyPercentage int
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    SkipMatching bool
    Indicates whether to skip instances that match the desired configuration.
    Status string
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    ScalingGroupId string
    The ID of the scaling group.
    CheckpointPauseTime int
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    Checkpoints []InstanceRefreshCheckpointArgs
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    DesiredConfigurationContainers []InstanceRefreshDesiredConfigurationContainerArgs
    The list of containers in the instance. See desired_configuration_containers below for details.
    DesiredConfigurationImageId string
    The ID of the image file. This is the image resource used for automatic instance creation.
    DesiredConfigurationLaunchTemplateId string
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    DesiredConfigurationLaunchTemplateOverrides []InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    DesiredConfigurationLaunchTemplateVersion string
    The version of the launch template.
    MaxHealthyPercentage int
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    MinHealthyPercentage int
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    SkipMatching bool
    Indicates whether to skip instances that match the desired configuration.
    Status string
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    scalingGroupId String
    The ID of the scaling group.
    checkpointPauseTime Integer
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    checkpoints List<InstanceRefreshCheckpoint>
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    desiredConfigurationContainers List<InstanceRefreshDesiredConfigurationContainer>
    The list of containers in the instance. See desired_configuration_containers below for details.
    desiredConfigurationImageId String
    The ID of the image file. This is the image resource used for automatic instance creation.
    desiredConfigurationLaunchTemplateId String
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    desiredConfigurationLaunchTemplateOverrides List<InstanceRefreshDesiredConfigurationLaunchTemplateOverride>
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    desiredConfigurationLaunchTemplateVersion String
    The version of the launch template.
    maxHealthyPercentage Integer
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    minHealthyPercentage Integer
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    skipMatching Boolean
    Indicates whether to skip instances that match the desired configuration.
    status String
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    scalingGroupId string
    The ID of the scaling group.
    checkpointPauseTime number
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    checkpoints InstanceRefreshCheckpoint[]
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    desiredConfigurationContainers InstanceRefreshDesiredConfigurationContainer[]
    The list of containers in the instance. See desired_configuration_containers below for details.
    desiredConfigurationImageId string
    The ID of the image file. This is the image resource used for automatic instance creation.
    desiredConfigurationLaunchTemplateId string
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    desiredConfigurationLaunchTemplateOverrides InstanceRefreshDesiredConfigurationLaunchTemplateOverride[]
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    desiredConfigurationLaunchTemplateVersion string
    The version of the launch template.
    maxHealthyPercentage number
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    minHealthyPercentage number
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    skipMatching boolean
    Indicates whether to skip instances that match the desired configuration.
    status string
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    scaling_group_id str
    The ID of the scaling group.
    checkpoint_pause_time int
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    checkpoints Sequence[InstanceRefreshCheckpointArgs]
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    desired_configuration_containers Sequence[InstanceRefreshDesiredConfigurationContainerArgs]
    The list of containers in the instance. See desired_configuration_containers below for details.
    desired_configuration_image_id str
    The ID of the image file. This is the image resource used for automatic instance creation.
    desired_configuration_launch_template_id str
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    desired_configuration_launch_template_overrides Sequence[InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs]
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    desired_configuration_launch_template_version str
    The version of the launch template.
    max_healthy_percentage int
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    min_healthy_percentage int
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    skip_matching bool
    Indicates whether to skip instances that match the desired configuration.
    status str
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    scalingGroupId String
    The ID of the scaling group.
    checkpointPauseTime Number
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    checkpoints List<Property Map>
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    desiredConfigurationContainers List<Property Map>
    The list of containers in the instance. See desired_configuration_containers below for details.
    desiredConfigurationImageId String
    The ID of the image file. This is the image resource used for automatic instance creation.
    desiredConfigurationLaunchTemplateId String
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    desiredConfigurationLaunchTemplateOverrides List<Property Map>
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    desiredConfigurationLaunchTemplateVersion String
    The version of the launch template.
    maxHealthyPercentage Number
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    minHealthyPercentage Number
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    skipMatching Boolean
    Indicates whether to skip instances that match the desired configuration.
    status String
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InstanceRefresh resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing InstanceRefresh Resource

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

    public static get(name: string, id: Input<ID>, state?: InstanceRefreshState, opts?: CustomResourceOptions): InstanceRefresh
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        checkpoint_pause_time: Optional[int] = None,
        checkpoints: Optional[Sequence[InstanceRefreshCheckpointArgs]] = None,
        desired_configuration_containers: Optional[Sequence[InstanceRefreshDesiredConfigurationContainerArgs]] = None,
        desired_configuration_image_id: Optional[str] = None,
        desired_configuration_launch_template_id: Optional[str] = None,
        desired_configuration_launch_template_overrides: Optional[Sequence[InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs]] = None,
        desired_configuration_launch_template_version: Optional[str] = None,
        max_healthy_percentage: Optional[int] = None,
        min_healthy_percentage: Optional[int] = None,
        scaling_group_id: Optional[str] = None,
        skip_matching: Optional[bool] = None,
        status: Optional[str] = None) -> InstanceRefresh
    func GetInstanceRefresh(ctx *Context, name string, id IDInput, state *InstanceRefreshState, opts ...ResourceOption) (*InstanceRefresh, error)
    public static InstanceRefresh Get(string name, Input<string> id, InstanceRefreshState? state, CustomResourceOptions? opts = null)
    public static InstanceRefresh get(String name, Output<String> id, InstanceRefreshState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:ess:InstanceRefresh    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CheckpointPauseTime int
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    Checkpoints List<Pulumi.AliCloud.Ess.Inputs.InstanceRefreshCheckpoint>
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    DesiredConfigurationContainers List<Pulumi.AliCloud.Ess.Inputs.InstanceRefreshDesiredConfigurationContainer>
    The list of containers in the instance. See desired_configuration_containers below for details.
    DesiredConfigurationImageId string
    The ID of the image file. This is the image resource used for automatic instance creation.
    DesiredConfigurationLaunchTemplateId string
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    DesiredConfigurationLaunchTemplateOverrides List<Pulumi.AliCloud.Ess.Inputs.InstanceRefreshDesiredConfigurationLaunchTemplateOverride>
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    DesiredConfigurationLaunchTemplateVersion string
    The version of the launch template.
    MaxHealthyPercentage int
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    MinHealthyPercentage int
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    ScalingGroupId string
    The ID of the scaling group.
    SkipMatching bool
    Indicates whether to skip instances that match the desired configuration.
    Status string
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    CheckpointPauseTime int
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    Checkpoints []InstanceRefreshCheckpointArgs
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    DesiredConfigurationContainers []InstanceRefreshDesiredConfigurationContainerArgs
    The list of containers in the instance. See desired_configuration_containers below for details.
    DesiredConfigurationImageId string
    The ID of the image file. This is the image resource used for automatic instance creation.
    DesiredConfigurationLaunchTemplateId string
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    DesiredConfigurationLaunchTemplateOverrides []InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    DesiredConfigurationLaunchTemplateVersion string
    The version of the launch template.
    MaxHealthyPercentage int
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    MinHealthyPercentage int
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    ScalingGroupId string
    The ID of the scaling group.
    SkipMatching bool
    Indicates whether to skip instances that match the desired configuration.
    Status string
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    checkpointPauseTime Integer
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    checkpoints List<InstanceRefreshCheckpoint>
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    desiredConfigurationContainers List<InstanceRefreshDesiredConfigurationContainer>
    The list of containers in the instance. See desired_configuration_containers below for details.
    desiredConfigurationImageId String
    The ID of the image file. This is the image resource used for automatic instance creation.
    desiredConfigurationLaunchTemplateId String
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    desiredConfigurationLaunchTemplateOverrides List<InstanceRefreshDesiredConfigurationLaunchTemplateOverride>
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    desiredConfigurationLaunchTemplateVersion String
    The version of the launch template.
    maxHealthyPercentage Integer
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    minHealthyPercentage Integer
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    scalingGroupId String
    The ID of the scaling group.
    skipMatching Boolean
    Indicates whether to skip instances that match the desired configuration.
    status String
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    checkpointPauseTime number
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    checkpoints InstanceRefreshCheckpoint[]
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    desiredConfigurationContainers InstanceRefreshDesiredConfigurationContainer[]
    The list of containers in the instance. See desired_configuration_containers below for details.
    desiredConfigurationImageId string
    The ID of the image file. This is the image resource used for automatic instance creation.
    desiredConfigurationLaunchTemplateId string
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    desiredConfigurationLaunchTemplateOverrides InstanceRefreshDesiredConfigurationLaunchTemplateOverride[]
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    desiredConfigurationLaunchTemplateVersion string
    The version of the launch template.
    maxHealthyPercentage number
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    minHealthyPercentage number
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    scalingGroupId string
    The ID of the scaling group.
    skipMatching boolean
    Indicates whether to skip instances that match the desired configuration.
    status string
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    checkpoint_pause_time int
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    checkpoints Sequence[InstanceRefreshCheckpointArgs]
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    desired_configuration_containers Sequence[InstanceRefreshDesiredConfigurationContainerArgs]
    The list of containers in the instance. See desired_configuration_containers below for details.
    desired_configuration_image_id str
    The ID of the image file. This is the image resource used for automatic instance creation.
    desired_configuration_launch_template_id str
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    desired_configuration_launch_template_overrides Sequence[InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs]
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    desired_configuration_launch_template_version str
    The version of the launch template.
    max_healthy_percentage int
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    min_healthy_percentage int
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    scaling_group_id str
    The ID of the scaling group.
    skip_matching bool
    Indicates whether to skip instances that match the desired configuration.
    status str
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.
    checkpointPauseTime Number
    The duration of the pause when the task reaches a checkpoint. Unit: minutes.
    checkpoints List<Property Map>
    The checkpoints for the refresh task. The task automatically pauses for the duration specified by CheckpointPauseTime when the percentage of new instances reaches a specified value. See checkpoints below for details.
    desiredConfigurationContainers List<Property Map>
    The list of containers in the instance. See desired_configuration_containers below for details.
    desiredConfigurationImageId String
    The ID of the image file. This is the image resource used for automatic instance creation.
    desiredConfigurationLaunchTemplateId String
    The ID of the launch template. The scaling group uses this template to obtain launch configuration information.
    desiredConfigurationLaunchTemplateOverrides List<Property Map>
    The instance type information in the launch template overrides. See desired_configuration_launch_template_overrides below for details.
    desiredConfigurationLaunchTemplateVersion String
    The version of the launch template.
    maxHealthyPercentage Number
    The percentage by which the number of instances in the scaling group can exceed the group's capacity during the instance refresh.
    minHealthyPercentage Number
    The percentage of instances that must be healthy in the scaling group during the instance refresh. The value is a percentage of the scaling group's capacity.
    scalingGroupId String
    The ID of the scaling group.
    skipMatching Boolean
    Indicates whether to skip instances that match the desired configuration.
    status String
    The current status of the instance refresh task. Possible values:

    • Pending: The instance refresh task is created and waiting to be scheduled.
    • InProgress: The instance refresh task is in progress.
    • Paused: The instance refresh task is paused.
    • CheckpointPause: The task is paused because it has reached a checkpoint (Checkpoint.Percentage).
    • Failed: The instance refresh task failed.
    • Successful: The instance refresh task was successful.
    • Cancelling: The instance refresh task is being canceled.
    • RollbackInProgress: The instance refresh task is being rolled back.
    • RollbackSuccessful: The instance refresh task was rolled back successfully. Set RollbackSuccessful to rollback the instance refresh task.
    • RollbackFailed: The rollback of the instance refresh task failed.
    • Cancelled: The instance refresh task is canceled. Set Cancelled to cancel the instance refresh task.

    Supporting Types

    InstanceRefreshCheckpoint, InstanceRefreshCheckpointArgs

    Percentage int
    The percentage of new instances out of the total instances in the scaling group. The task automatically pauses when this percentage is reached.
    Percentage int
    The percentage of new instances out of the total instances in the scaling group. The task automatically pauses when this percentage is reached.
    percentage Integer
    The percentage of new instances out of the total instances in the scaling group. The task automatically pauses when this percentage is reached.
    percentage number
    The percentage of new instances out of the total instances in the scaling group. The task automatically pauses when this percentage is reached.
    percentage int
    The percentage of new instances out of the total instances in the scaling group. The task automatically pauses when this percentage is reached.
    percentage Number
    The percentage of new instances out of the total instances in the scaling group. The task automatically pauses when this percentage is reached.

    InstanceRefreshDesiredConfigurationContainer, InstanceRefreshDesiredConfigurationContainerArgs

    Args List<string>
    The arguments for the container startup command.
    Commands List<string>
    The container startup command.
    EnvironmentVars List<Pulumi.AliCloud.Ess.Inputs.InstanceRefreshDesiredConfigurationContainerEnvironmentVar>
    Information about the environment variables. See environment_vars below for details.
    Image string
    The container image.
    Name string
    The custom name of the container.
    Args []string
    The arguments for the container startup command.
    Commands []string
    The container startup command.
    EnvironmentVars []InstanceRefreshDesiredConfigurationContainerEnvironmentVar
    Information about the environment variables. See environment_vars below for details.
    Image string
    The container image.
    Name string
    The custom name of the container.
    args List<String>
    The arguments for the container startup command.
    commands List<String>
    The container startup command.
    environmentVars List<InstanceRefreshDesiredConfigurationContainerEnvironmentVar>
    Information about the environment variables. See environment_vars below for details.
    image String
    The container image.
    name String
    The custom name of the container.
    args string[]
    The arguments for the container startup command.
    commands string[]
    The container startup command.
    environmentVars InstanceRefreshDesiredConfigurationContainerEnvironmentVar[]
    Information about the environment variables. See environment_vars below for details.
    image string
    The container image.
    name string
    The custom name of the container.
    args Sequence[str]
    The arguments for the container startup command.
    commands Sequence[str]
    The container startup command.
    environment_vars Sequence[InstanceRefreshDesiredConfigurationContainerEnvironmentVar]
    Information about the environment variables. See environment_vars below for details.
    image str
    The container image.
    name str
    The custom name of the container.
    args List<String>
    The arguments for the container startup command.
    commands List<String>
    The container startup command.
    environmentVars List<Property Map>
    Information about the environment variables. See environment_vars below for details.
    image String
    The container image.
    name String
    The custom name of the container.

    InstanceRefreshDesiredConfigurationContainerEnvironmentVar, InstanceRefreshDesiredConfigurationContainerEnvironmentVarArgs

    FieldRefFieldPath string
    This parameter is not available for use.
    Key string
    The name of the environment variable.
    Value string
    The value of the environment variable.
    FieldRefFieldPath string
    This parameter is not available for use.
    Key string
    The name of the environment variable.
    Value string
    The value of the environment variable.
    fieldRefFieldPath String
    This parameter is not available for use.
    key String
    The name of the environment variable.
    value String
    The value of the environment variable.
    fieldRefFieldPath string
    This parameter is not available for use.
    key string
    The name of the environment variable.
    value string
    The value of the environment variable.
    field_ref_field_path str
    This parameter is not available for use.
    key str
    The name of the environment variable.
    value str
    The value of the environment variable.
    fieldRefFieldPath String
    This parameter is not available for use.
    key String
    The name of the environment variable.
    value String
    The value of the environment variable.

    InstanceRefreshDesiredConfigurationLaunchTemplateOverride, InstanceRefreshDesiredConfigurationLaunchTemplateOverrideArgs

    InstanceType string
    The specified instance type, which overwrites the instance type in the launch template.
    InstanceType string
    The specified instance type, which overwrites the instance type in the launch template.
    instanceType String
    The specified instance type, which overwrites the instance type in the launch template.
    instanceType string
    The specified instance type, which overwrites the instance type in the launch template.
    instance_type str
    The specified instance type, which overwrites the instance type in the launch template.
    instanceType String
    The specified instance type, which overwrites the instance type in the launch template.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.87.0 published on Saturday, Oct 18, 2025 by Pulumi
    pulumi/pulumi-alicloud
      Meet Neo: Your AI Platform Teammate