Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. AsStartInstanceRefresh
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.AsStartInstanceRefresh

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create as instance refresh

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.AsStartInstanceRefresh;
import com.pulumi.tencentcloud.AsStartInstanceRefreshArgs;
import com.pulumi.tencentcloud.inputs.AsStartInstanceRefreshRefreshSettingsArgs;
import com.pulumi.tencentcloud.inputs.AsStartInstanceRefreshRefreshSettingsRollingUpdateSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var example = new AsStartInstanceRefresh("example", AsStartInstanceRefreshArgs.builder()
            .autoScalingGroupId("asg-8n7fdm28")
            .refreshMode("ROLLING_UPDATE_RESET")
            .refreshSettings(AsStartInstanceRefreshRefreshSettingsArgs.builder()
                .checkInstanceTargetHealth(false)
                .rollingUpdateSettings(AsStartInstanceRefreshRefreshSettingsRollingUpdateSettingsArgs.builder()
                    .batchNumber(1)
                    .batchPause("AUTOMATIC")
                    .maxSurge(1)
                    .failProcess("AUTO_PAUSE")
                    .build())
                .build())
            .timeouts(AsStartInstanceRefreshTimeoutsArgs.builder()
                .create("10m")
                .build())
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:AsStartInstanceRefresh
    properties:
      autoScalingGroupId: asg-8n7fdm28
      refreshMode: ROLLING_UPDATE_RESET
      refreshSettings:
        checkInstanceTargetHealth: false
        rollingUpdateSettings:
          batchNumber: 1
          batchPause: AUTOMATIC
          maxSurge: 1
          failProcess: AUTO_PAUSE
      timeouts:
        - create: 10m

    Create AsStartInstanceRefresh Resource

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

    Constructor syntax

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

@overload
def AsStartInstanceRefresh(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           auto_scaling_group_id: Optional[str] = None,
                           refresh_settings: Optional[AsStartInstanceRefreshRefreshSettingsArgs] = None,
                           as_start_instance_refresh_id: Optional[str] = None,
                           refresh_mode: Optional[str] = None,
                           timeouts: Optional[AsStartInstanceRefreshTimeoutsArgs] = None)
    func NewAsStartInstanceRefresh(ctx *Context, name string, args AsStartInstanceRefreshArgs, opts ...ResourceOption) (*AsStartInstanceRefresh, error)
    public AsStartInstanceRefresh(string name, AsStartInstanceRefreshArgs args, CustomResourceOptions? opts = null)
    public AsStartInstanceRefresh(String name, AsStartInstanceRefreshArgs args)
public AsStartInstanceRefresh(String name, AsStartInstanceRefreshArgs args, CustomResourceOptions options)

    type: tencentcloud:AsStartInstanceRefresh
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 AsStartInstanceRefreshArgs
    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 AsStartInstanceRefreshArgs
    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 AsStartInstanceRefreshArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AsStartInstanceRefreshArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AsStartInstanceRefreshArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AsStartInstanceRefresh 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 AsStartInstanceRefresh resource accepts the following input properties:

    AutoScalingGroupId string
    Scaling group ID.
    RefreshSettings AsStartInstanceRefreshRefreshSettings
    Refresh settings.
    AsStartInstanceRefreshId string
    ID of the resource.
    RefreshMode string
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    Timeouts AsStartInstanceRefreshTimeouts
    AutoScalingGroupId string
    Scaling group ID.
    RefreshSettings AsStartInstanceRefreshRefreshSettingsArgs
    Refresh settings.
    AsStartInstanceRefreshId string
    ID of the resource.
    RefreshMode string
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    Timeouts AsStartInstanceRefreshTimeoutsArgs
    autoScalingGroupId String
    Scaling group ID.
    refreshSettings AsStartInstanceRefreshRefreshSettings
    Refresh settings.
    asStartInstanceRefreshId String
    ID of the resource.
    refreshMode String
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    timeouts AsStartInstanceRefreshTimeouts
    autoScalingGroupId string
    Scaling group ID.
    refreshSettings AsStartInstanceRefreshRefreshSettings
    Refresh settings.
    asStartInstanceRefreshId string
    ID of the resource.
    refreshMode string
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    timeouts AsStartInstanceRefreshTimeouts
    auto_scaling_group_id str
    Scaling group ID.
    refresh_settings AsStartInstanceRefreshRefreshSettingsArgs
    Refresh settings.
    as_start_instance_refresh_id str
    ID of the resource.
    refresh_mode str
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    timeouts AsStartInstanceRefreshTimeoutsArgs
    autoScalingGroupId String
    Scaling group ID.
    refreshSettings Property Map
    Refresh settings.
    asStartInstanceRefreshId String
    ID of the resource.
    refreshMode String
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AsStartInstanceRefresh 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 AsStartInstanceRefresh Resource

    Get an existing AsStartInstanceRefresh 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?: AsStartInstanceRefreshState, opts?: CustomResourceOptions): AsStartInstanceRefresh
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        as_start_instance_refresh_id: Optional[str] = None,
        auto_scaling_group_id: Optional[str] = None,
        refresh_mode: Optional[str] = None,
        refresh_settings: Optional[AsStartInstanceRefreshRefreshSettingsArgs] = None,
        timeouts: Optional[AsStartInstanceRefreshTimeoutsArgs] = None) -> AsStartInstanceRefresh
    func GetAsStartInstanceRefresh(ctx *Context, name string, id IDInput, state *AsStartInstanceRefreshState, opts ...ResourceOption) (*AsStartInstanceRefresh, error)
    public static AsStartInstanceRefresh Get(string name, Input<string> id, AsStartInstanceRefreshState? state, CustomResourceOptions? opts = null)
    public static AsStartInstanceRefresh get(String name, Output<String> id, AsStartInstanceRefreshState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:AsStartInstanceRefresh    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:
    AsStartInstanceRefreshId string
    ID of the resource.
    AutoScalingGroupId string
    Scaling group ID.
    RefreshMode string
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    RefreshSettings AsStartInstanceRefreshRefreshSettings
    Refresh settings.
    Timeouts AsStartInstanceRefreshTimeouts
    AsStartInstanceRefreshId string
    ID of the resource.
    AutoScalingGroupId string
    Scaling group ID.
    RefreshMode string
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    RefreshSettings AsStartInstanceRefreshRefreshSettingsArgs
    Refresh settings.
    Timeouts AsStartInstanceRefreshTimeoutsArgs
    asStartInstanceRefreshId String
    ID of the resource.
    autoScalingGroupId String
    Scaling group ID.
    refreshMode String
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    refreshSettings AsStartInstanceRefreshRefreshSettings
    Refresh settings.
    timeouts AsStartInstanceRefreshTimeouts
    asStartInstanceRefreshId string
    ID of the resource.
    autoScalingGroupId string
    Scaling group ID.
    refreshMode string
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    refreshSettings AsStartInstanceRefreshRefreshSettings
    Refresh settings.
    timeouts AsStartInstanceRefreshTimeouts
    as_start_instance_refresh_id str
    ID of the resource.
    auto_scaling_group_id str
    Scaling group ID.
    refresh_mode str
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    refresh_settings AsStartInstanceRefreshRefreshSettingsArgs
    Refresh settings.
    timeouts AsStartInstanceRefreshTimeoutsArgs
    asStartInstanceRefreshId String
    ID of the resource.
    autoScalingGroupId String
    Scaling group ID.
    refreshMode String
    Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET.
    refreshSettings Property Map
    Refresh settings.
    timeouts Property Map

    Supporting Types

    AsStartInstanceRefreshRefreshSettings, AsStartInstanceRefreshRefreshSettingsArgs

    RollingUpdateSettings AsStartInstanceRefreshRefreshSettingsRollingUpdateSettings
    Rolling update settings parameters. RefreshMode is the rolling update. This parameter must be filled in.Note: This field may return null, indicating that no valid value can be obtained.
    CheckInstanceTargetHealth bool
    Backend service health check status for instances, defaults to FALSE. This setting takes effect only for scaling groups bound with application load balancers. When enabled, if an instance fails the check after being refreshed, its load balancer port weight remains 0 and is marked as a refresh failure. Valid values: TRUE: Enable the check. FALSE: Do not enable the check.
    RollingUpdateSettings AsStartInstanceRefreshRefreshSettingsRollingUpdateSettings
    Rolling update settings parameters. RefreshMode is the rolling update. This parameter must be filled in.Note: This field may return null, indicating that no valid value can be obtained.
    CheckInstanceTargetHealth bool
    Backend service health check status for instances, defaults to FALSE. This setting takes effect only for scaling groups bound with application load balancers. When enabled, if an instance fails the check after being refreshed, its load balancer port weight remains 0 and is marked as a refresh failure. Valid values: TRUE: Enable the check. FALSE: Do not enable the check.
    rollingUpdateSettings AsStartInstanceRefreshRefreshSettingsRollingUpdateSettings
    Rolling update settings parameters. RefreshMode is the rolling update. This parameter must be filled in.Note: This field may return null, indicating that no valid value can be obtained.
    checkInstanceTargetHealth Boolean
    Backend service health check status for instances, defaults to FALSE. This setting takes effect only for scaling groups bound with application load balancers. When enabled, if an instance fails the check after being refreshed, its load balancer port weight remains 0 and is marked as a refresh failure. Valid values: TRUE: Enable the check. FALSE: Do not enable the check.
    rollingUpdateSettings AsStartInstanceRefreshRefreshSettingsRollingUpdateSettings
    Rolling update settings parameters. RefreshMode is the rolling update. This parameter must be filled in.Note: This field may return null, indicating that no valid value can be obtained.
    checkInstanceTargetHealth boolean
    Backend service health check status for instances, defaults to FALSE. This setting takes effect only for scaling groups bound with application load balancers. When enabled, if an instance fails the check after being refreshed, its load balancer port weight remains 0 and is marked as a refresh failure. Valid values: TRUE: Enable the check. FALSE: Do not enable the check.
    rolling_update_settings AsStartInstanceRefreshRefreshSettingsRollingUpdateSettings
    Rolling update settings parameters. RefreshMode is the rolling update. This parameter must be filled in.Note: This field may return null, indicating that no valid value can be obtained.
    check_instance_target_health bool
    Backend service health check status for instances, defaults to FALSE. This setting takes effect only for scaling groups bound with application load balancers. When enabled, if an instance fails the check after being refreshed, its load balancer port weight remains 0 and is marked as a refresh failure. Valid values: TRUE: Enable the check. FALSE: Do not enable the check.
    rollingUpdateSettings Property Map
    Rolling update settings parameters. RefreshMode is the rolling update. This parameter must be filled in.Note: This field may return null, indicating that no valid value can be obtained.
    checkInstanceTargetHealth Boolean
    Backend service health check status for instances, defaults to FALSE. This setting takes effect only for scaling groups bound with application load balancers. When enabled, if an instance fails the check after being refreshed, its load balancer port weight remains 0 and is marked as a refresh failure. Valid values: TRUE: Enable the check. FALSE: Do not enable the check.

    AsStartInstanceRefreshRefreshSettingsRollingUpdateSettings, AsStartInstanceRefreshRefreshSettingsRollingUpdateSettingsArgs

    BatchNumber double
    Batch quantity. The batch quantity should be a positive integer greater than 0, but cannot exceed the total number of instances pending refresh.
    BatchPause string
    Pause policy between batches. Default value: Automatic. Valid values: FIRST_BATCH_PAUSE: Pause after the first batch update completes. BATCH_INTERVAL_PAUSE: Pause between each batch update. AUTOMATIC: No pauses.
    FailProcess string
    Failure Handling Policy. The default value is AUTO_PAUSE. The values are as follows, AUTO_PAUSE: Pause after refresh fails; AUTO_ROLLBACK: Roll back after refresh fails; AUTO_CANCEL: Cancel after refresh fails.
    MaxSurge double
    Maximum Extra Quantity. After setting this parameter, a batch of pay-as-you-go extra instances will be created according to the launch configuration before the rolling update starts, and the extra instances will be destroyed after the rolling update is completed.
    BatchNumber float64
    Batch quantity. The batch quantity should be a positive integer greater than 0, but cannot exceed the total number of instances pending refresh.
    BatchPause string
    Pause policy between batches. Default value: Automatic. Valid values: FIRST_BATCH_PAUSE: Pause after the first batch update completes. BATCH_INTERVAL_PAUSE: Pause between each batch update. AUTOMATIC: No pauses.
    FailProcess string
    Failure Handling Policy. The default value is AUTO_PAUSE. The values are as follows, AUTO_PAUSE: Pause after refresh fails; AUTO_ROLLBACK: Roll back after refresh fails; AUTO_CANCEL: Cancel after refresh fails.
    MaxSurge float64
    Maximum Extra Quantity. After setting this parameter, a batch of pay-as-you-go extra instances will be created according to the launch configuration before the rolling update starts, and the extra instances will be destroyed after the rolling update is completed.
    batchNumber Double
    Batch quantity. The batch quantity should be a positive integer greater than 0, but cannot exceed the total number of instances pending refresh.
    batchPause String
    Pause policy between batches. Default value: Automatic. Valid values: FIRST_BATCH_PAUSE: Pause after the first batch update completes. BATCH_INTERVAL_PAUSE: Pause between each batch update. AUTOMATIC: No pauses.
    failProcess String
    Failure Handling Policy. The default value is AUTO_PAUSE. The values are as follows, AUTO_PAUSE: Pause after refresh fails; AUTO_ROLLBACK: Roll back after refresh fails; AUTO_CANCEL: Cancel after refresh fails.
    maxSurge Double
    Maximum Extra Quantity. After setting this parameter, a batch of pay-as-you-go extra instances will be created according to the launch configuration before the rolling update starts, and the extra instances will be destroyed after the rolling update is completed.
    batchNumber number
    Batch quantity. The batch quantity should be a positive integer greater than 0, but cannot exceed the total number of instances pending refresh.
    batchPause string
    Pause policy between batches. Default value: Automatic. Valid values: FIRST_BATCH_PAUSE: Pause after the first batch update completes. BATCH_INTERVAL_PAUSE: Pause between each batch update. AUTOMATIC: No pauses.
    failProcess string
    Failure Handling Policy. The default value is AUTO_PAUSE. The values are as follows, AUTO_PAUSE: Pause after refresh fails; AUTO_ROLLBACK: Roll back after refresh fails; AUTO_CANCEL: Cancel after refresh fails.
    maxSurge number
    Maximum Extra Quantity. After setting this parameter, a batch of pay-as-you-go extra instances will be created according to the launch configuration before the rolling update starts, and the extra instances will be destroyed after the rolling update is completed.
    batch_number float
    Batch quantity. The batch quantity should be a positive integer greater than 0, but cannot exceed the total number of instances pending refresh.
    batch_pause str
    Pause policy between batches. Default value: Automatic. Valid values: FIRST_BATCH_PAUSE: Pause after the first batch update completes. BATCH_INTERVAL_PAUSE: Pause between each batch update. AUTOMATIC: No pauses.
    fail_process str
    Failure Handling Policy. The default value is AUTO_PAUSE. The values are as follows, AUTO_PAUSE: Pause after refresh fails; AUTO_ROLLBACK: Roll back after refresh fails; AUTO_CANCEL: Cancel after refresh fails.
    max_surge float
    Maximum Extra Quantity. After setting this parameter, a batch of pay-as-you-go extra instances will be created according to the launch configuration before the rolling update starts, and the extra instances will be destroyed after the rolling update is completed.
    batchNumber Number
    Batch quantity. The batch quantity should be a positive integer greater than 0, but cannot exceed the total number of instances pending refresh.
    batchPause String
    Pause policy between batches. Default value: Automatic. Valid values: FIRST_BATCH_PAUSE: Pause after the first batch update completes. BATCH_INTERVAL_PAUSE: Pause between each batch update. AUTOMATIC: No pauses.
    failProcess String
    Failure Handling Policy. The default value is AUTO_PAUSE. The values are as follows, AUTO_PAUSE: Pause after refresh fails; AUTO_ROLLBACK: Roll back after refresh fails; AUTO_CANCEL: Cancel after refresh fails.
    maxSurge Number
    Maximum Extra Quantity. After setting this parameter, a batch of pay-as-you-go extra instances will be created according to the launch configuration before the rolling update starts, and the extra instances will be destroyed after the rolling update is completed.

    AsStartInstanceRefreshTimeouts, AsStartInstanceRefreshTimeoutsArgs

    Create string
    Create string
    create String
    create string
    create str
    create String

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud