DocsICP FilingConsole
官方文档
首页

ACS-ESS-LifeCycleModifyRedisIPWhitelist

更新时间：
复制 MD 格式
产品详情
我的收藏

Template name

ACS-ESS-LifeCycleModifyRedisIPWhitelist

Execute Now

Template description

Updates the IP address whitelist of a Tair (Redis OSS-compatible) instance when Auto Scaling adds or removes Elastic Compute Service (ECS) instances, using a lifecycle hook to trigger the update.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

dbInstanceId

The ID of the Tair (Redis OSS-compatible) instance whose IP whitelist you want to update.

String

Yes

modifyMode

The update method. Use Append or AppendDup when scaling out (adding instances), and Delete when scaling in (removing instances). Valid values: Append, Delete, AppendDup.

String

Yes

regionId

The region where the Tair instance resides. Defaults to the region ID passed in by the Auto Scaling lifecycle hook.

String

No

${regionId}

instanceIds

The IDs of the ECS instances whose IP addresses are added to or removed from the whitelist. Defaults to the instance ID list passed in by the lifecycle hook.

List

No

['${instanceIds}']

lifecycleHookId

The ID of the lifecycle hook that triggered this execution.

String

No

${lifecycleHookId}

lifecycleActionToken

The token that identifies the scaling activity associated with the instances.

String

No

${lifecycleActionToken}

OOSAssumeRole

The RAM role that OOS assumes to run this template.

String

No

OOSServiceRole

Output parameters

Parameter

Description

Type

ipAddresses

The private IP addresses of the specified ECS instances, including VPC private IPs and classic network internal IPs.

List

How it works

The template runs four tasks in sequence:

  1. getInstanceIpAddress — Calls ecs:DescribeInstances to retrieve the private IP addresses (VPC and classic network) of the specified ECS instances. If this step fails, the template triggers CompleteLifecycleActionForAbandon.

  2. modifySecurityIps — Calls kvstore:ModifySecurityIps to update the Tair instance whitelist with the retrieved IPs using the specified modifyMode. If this step succeeds, the template triggers CompleteLifecycleActionForContinue. If it fails, it triggers CompleteLifecycleActionForAbandon.

  3. CompleteLifecycleActionForContinue — Notifies Auto Scaling that the lifecycle hook activity can proceed (CONTINUE). Runs only when step 2 succeeds.

  4. CompleteLifecycleActionForAbandon — Notifies Auto Scaling to abandon the scaling activity (ABANDON). Runs when step 1 or step 2 fails.

Policy required to run this template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:DescribeInstances"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "kvstore:ModifySecurityIps"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "ess:CompleteLifecycleAction"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

ACS-ESS-LifeCycleModifyRedisIPWhitelist

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Use lifecycleHook to modify the IP whitelist of the redis instance
  zh-cn: 使用生命周期挂钩设置Redis实例的IP白名单
  name-en: ACS-ESS-LifeCycleModifyRedisIPWhitelist
  name-zh-cn: 使用生命周期挂钩设置Redis实例的IP白名单
  categories:
    - elastic_manage
Parameters:
  dbInstanceId:
    Label:
      en: DBInstanceId
      zh-cn: Redis实例ID
    Type: String
  modifyMode:
    Label:
      en: ModifyMode
      zh-cn: 修改IP白名单的方式
    Description:
      en: The method of modifying the IP whitelist, Append and AppendDup are used for
          elastic expansion activities, and Delete is used for elastic contraction activities
      zh-cn: 修改IP白名单的方式，Append和AppendDup用于弹性扩张活动，Delete用于弹性收缩活动
    Type: String
    AllowedValues:
      - Append
      - Delete
      - AppendDup
  regionId:
    Label:
      en: RegionId
      zh-cn: 地域ID
    Description:
      en: The ID of region
      zh-cn: '地域ID，请使用弹性伸缩系统默认值 ${regionId}'
    Type: String
    Default: '${regionId}'
  instanceIds:
    Label:
      en: InstanceIds
      zh-cn: ECS实例ID列表
    Description:
      en: The ID list of the ECS instance
      zh-cn: 'ECS实例ID列表,请使用弹性伸缩系统默认值 ["${instanceId}"]'
    Type: List
    Default:
      - '${instanceIds}'
  lifecycleHookId:
    Label:
      en: LifecycleHookId
      zh-cn: 生命周期挂钩ID
    Description:
      en: The ID of the lifecycle hook
      zh-cn: '生命周期挂钩ID,请使用弹性伸缩系统默认值 ${lifecycleHookId}'
    Type: String
    Default: '${lifecycleHookId}'
  lifecycleActionToken:
    Label:
      en: LifecycleActionToken
      zh-cn: 实例关联的特定伸缩活动的令牌
    Description:
      en: The token that indicates a specific scaling activity associated with an instance
      zh-cn: '实例关联的特定伸缩活动的令牌,请使用弹性伸缩系统默认值 ${lifecycleActionToken}'
    Type: String
    Default: '${lifecycleActionToken}'
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: OOS扮演的RAM角色
    Type: String
    Default: OOSServiceRole
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: getInstanceIpAddress
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Gets ECS instance network type and ip address
      zh-cn: 获取ECS实例的网络类型和Ip地址
    OnError: CompleteLifecycleActionForAbandon
    Properties:
      Service: ECS
      API: DescribeInstances
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceIds: '{{ instanceIds }}'
    Outputs:
      Ips:
        Type: List
        ValueSelector: >-
          .Instances.Instance[]|.VpcAttributes.PrivateIpAddress.IpAddress+.InnerIpAddress.IpAddress|.[]
  - Name: modifySecurityIps
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Modifies the whitelist
      zh-cn: 修改白名单
    OnError: CompleteLifecycleActionForAbandon
    OnSuccess: CompleteLifecycleActionForContinue
    Properties:
      Service: R-KVSTORE
      API: ModifySecurityIps
      Parameters:
        RegionId: '{{ regionId }}'
        ModifyMode: '{{ modifyMode }}'
        InstanceId: '{{ dBInstanceId }}'
        SecurityIps:
          'Fn::Join':
            - ','
            - '{{ getInstanceIpAddress.Ips }}'
  - Name: CompleteLifecycleActionForContinue
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Modify lifecycle action for continue
      zh-cn: 修改伸缩活动的等待状态为继续完成
    OnSuccess: 'ACS::END'
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ regionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: CONTINUE
  - Name: CompleteLifecycleActionForAbandon
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Complete lifecycle action for Abandon
      zh-cn: 修改伸缩活动的等待状态为弃用
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ regionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: ABANDON
Outputs:
  ipAddresses:
    Type: List
    Value: '{{ getInstanceIpAddress.Ips }}'
Previous：ACS-ESS-LifeCycleModifyPolarDBIPWhitelistNext：ACS-ESS-LifeCycleReleaseEipAddressFromInstance