com.aliyun.ess20220222.models.CreateLifecycleHookRequest Maven / Gradle / Ivy

Go to download
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.ess20220222.models;

import com.aliyun.tea.*;

public class CreateLifecycleHookRequest extends TeaModel {
    /**
     * The action that you want Auto Scaling to perform after the lifecycle hook times out. Valid values:
     * 
     * CONTINUE: Auto Scaling continues to respond to scale-in or scale-out requests.
     * ABANDON: Auto Scaling releases Elastic Compute Service (ECS) instances that are created during scale-out activities, or removes ECS instances from the scaling group during scale-in activities.
     * 
     * If multiple lifecycle hooks in a scaling group are triggered during scale-in activities and you set the DefaultResult parameter to ABANDON for one of the lifecycle hooks, Auto Scaling immediately performs the action after the lifecycle hook whose DefaultResult is set to ABANDON times out. As a result, other lifecycle hooks time out ahead of schedule. In other cases, Auto Scaling performs the action only after all lifecycle hooks time out.
     * Default value: CONTINUE.
     * 
     * example:
     * CONTINUE
     */
    @NameInMap("DefaultResult")
    public String defaultResult;

    /**
     * The period of time before the lifecycle hook times out. After the lifecycle hook times out, Auto Scaling performs the default action. Valid values: 30 to 21600. Unit: seconds.
     * After you create a lifecycle hook, you can call the RecordLifecycleActionHeartbeat operation to prolong the timeout period of the lifecycle hook. You can also call the CompleteLifecycleAction operation to end the timeout period of the lifecycle hook ahead of schedule.
     * Default value: 600.
     * 
     * example:
     * 600
     */
    @NameInMap("HeartbeatTimeout")
    public Integer heartbeatTimeout;

    /**
     * The name of the lifecycle hook. Each lifecycle hook name must be unique within a scaling group. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (_), hyphens (-), and periods (.). It must start with a letter or a digit.
     * If you do not specify this parameter, the value of the LifecycleHookId parameter is used.
     * 
     * example:
     * lifecyclehook****
     */
    @NameInMap("LifecycleHookName")
    public String lifecycleHookName;

    /**
     * The type of the scaling activity to which the lifecycle hook applies. Valid values:
     * 
     * SCALE_OUT
     * SCALE_IN
     * 
     * This parameter is required.
     * 
     * example:
     * SCALE_OUT
     */
    @NameInMap("LifecycleTransition")
    public String lifecycleTransition;

    /**
     * The Alibaba Cloud Resource Name (ARN) of the notification method that is used by Auto Scaling to send notifications when the lifecycle hook takes effect. If you do not specify this parameter, no notification is sent when the lifecycle hook takes effect. If you specify this parameter, the following rules apply:
     * 
     * If you use a Message Service (MNS) queue as the notification method, specify the value in the acs:mns:{region-id}:{account-id}:queue/{queuename} format.
     * If you use an MNS topic as the notification method, specify the value in the acs:mns:{region-id}:{account-id}:topic/{topicname} format.
     * If you use an OOS template as the notification method, specify the value in the acs:oos:{region-id}:{account-id}:template/{templatename} format.
     * 
     * The variables in the preceding parameter formats have the following meanings:
     * 
     * region-id: the region ID of the scaling group.
     * account-id: the ID of the Alibaba Cloud account. The ID of the RAM user is not supported.
     * queuename: the name of the MNS queue.
     * topicname: the name of the MNS topic.
     * templatename: the name of the OOS template.
     * 
     * 
     * example:
     * acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo****
     */
    @NameInMap("NotificationArn")
    public String notificationArn;

    /**
     * The notification metadata that is sent when the lifecycle hook takes effect. This helps you manage and categorize notifications in an efficient manner. If you specify this parameter, you must specify the NotificationArn parameter. The parameter value cannot exceed 4,096 characters in length.
     * If you use the NotificationArn parameter to specify a public or customOOS template, the value of the NotificationMetadata parameter must be a JSON string that contains the OOS template parameters. For example, your OOS template includes the following parameters: {"dbInstanceId": "dds-bp17661e0135****", "modifyMode": "Append"}, dbInstanceId, and modifyMode. Some parameters defined in your OOS template have default values. When you specify the NotificationMetadata parameter, specify parameters that do not have default values. If you specify parameters that have default values, the default values are overwritten. However, the default values of the following parameters must be retained to obtain information about scaling activities that are in progress:
     * 
     * regionId: the region ID of the scaling activity that is in progress. Default value: ${regionId}.
     * instanceIds: the IDs of ECS instances that are scaled in in the scaling activity. Default value: ${instanceIds}.
     * lifecycleHookId: the ID of the lifecycle hook. Default value: ${lifecycleHookId}.
     * lifecycleActionToken: the token of the lifecycle action. You can use the token to end the timeout period of the lifecycle hook ahead of schedule. Default value: ${lifecycleActionToken}
     * scalingGroupId: the ID of the scaling group in which the scaling activity is executed. Default value: ${scalingGroupId}.
     * 
     * 
     * You can obtain template parameter information in the OOS console.
     * 
     * 
     * example:
     * Test lifecycle hook.
     */
    @NameInMap("NotificationMetadata")
    public String notificationMetadata;

    @NameInMap("OwnerAccount")
    public String ownerAccount;

    @NameInMap("OwnerId")
    public Long ownerId;

    @NameInMap("ResourceOwnerAccount")
    public String resourceOwnerAccount;

    /**
     * The ID of the scaling group.
     * This parameter is required.
     * 
     * example:
     * asg-bp1eyv4qn8ssgv43****
     */
    @NameInMap("ScalingGroupId")
    public String scalingGroupId;

    public static CreateLifecycleHookRequest build(java.util.Map map) throws Exception {
        CreateLifecycleHookRequest self = new CreateLifecycleHookRequest();
        return TeaModel.build(map, self);
    }

    public CreateLifecycleHookRequest setDefaultResult(String defaultResult) {
        this.defaultResult = defaultResult;
        return this;
    }
    public String getDefaultResult() {
        return this.defaultResult;
    }

    public CreateLifecycleHookRequest setHeartbeatTimeout(Integer heartbeatTimeout) {
        this.heartbeatTimeout = heartbeatTimeout;
        return this;
    }
    public Integer getHeartbeatTimeout() {
        return this.heartbeatTimeout;
    }

    public CreateLifecycleHookRequest setLifecycleHookName(String lifecycleHookName) {
        this.lifecycleHookName = lifecycleHookName;
        return this;
    }
    public String getLifecycleHookName() {
        return this.lifecycleHookName;
    }

    public CreateLifecycleHookRequest setLifecycleTransition(String lifecycleTransition) {
        this.lifecycleTransition = lifecycleTransition;
        return this;
    }
    public String getLifecycleTransition() {
        return this.lifecycleTransition;
    }

    public CreateLifecycleHookRequest setNotificationArn(String notificationArn) {
        this.notificationArn = notificationArn;
        return this;
    }
    public String getNotificationArn() {
        return this.notificationArn;
    }

    public CreateLifecycleHookRequest setNotificationMetadata(String notificationMetadata) {
        this.notificationMetadata = notificationMetadata;
        return this;
    }
    public String getNotificationMetadata() {
        return this.notificationMetadata;
    }

    public CreateLifecycleHookRequest setOwnerAccount(String ownerAccount) {
        this.ownerAccount = ownerAccount;
        return this;
    }
    public String getOwnerAccount() {
        return this.ownerAccount;
    }

    public CreateLifecycleHookRequest setOwnerId(Long ownerId) {
        this.ownerId = ownerId;
        return this;
    }
    public Long getOwnerId() {
        return this.ownerId;
    }

    public CreateLifecycleHookRequest setResourceOwnerAccount(String resourceOwnerAccount) {
        this.resourceOwnerAccount = resourceOwnerAccount;
        return this;
    }
    public String getResourceOwnerAccount() {
        return this.resourceOwnerAccount;
    }

    public CreateLifecycleHookRequest setScalingGroupId(String scalingGroupId) {
        this.scalingGroupId = scalingGroupId;
        return this;
    }
    public String getScalingGroupId() {
        return this.scalingGroupId;
    }

}