CloudOps Orchestration Service:ACS-ESS-ECILifeCycleModifyMongoDBIPWhitelist

テンプレート名

ACS-ESS-ECILifeCycleModifyMongoDBIPWhitelist

今すぐ実行

テンプレートの説明

ライフサイクルフックを使用して、ApsaraDB for MongoDB インスタンスの IP アドレスホワイトリストに Elastic Container Instance (ECI) の IP アドレスを追加または削除します。

テンプレートタイプ

自動化

所有者

Alibaba Cloud

入力パラメーター

パラメーター	説明	タイプ	必須	デフォルト値	制限
dbInstanceId	ApsaraDB for MongoDB インスタンスの ID です。	String	はい
modifyMode	IP アドレスホワイトリストを変更する方法です。	String	はい
regionId	リージョン ID です。	String	いいえ	${regionId}
instanceIds	ECI インスタンスの ID です。	List	いいえ	['${instanceIds}']
lifecycleHookId	ライフサイクルフックの ID です。	String	いいえ	${lifecycleHookId}
lifecycleActionToken	インスタンスに関連付けられているスケーリングアクティビティのトークンです。	String	いいえ	${lifecycleActionToken}
OOSAssumeRole	CloudOps Orchestration Service (OOS) が引き受ける RAM ロールです。	String	いいえ	OOSServiceRole

出力パラメーター

パラメーター	説明	タイプ
ipAddresses		List

テンプレートの実行に必要なポリシー

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

関連ドキュメント

ACS-ESS-ECILifeCycleModifyMongoDBIPWhitelist

テンプレートの内容

FormatVersion: OOS-2019-06-01
Description:
  en: Use lifecycleHook to modify the IP whitelist of the MongoDB instance
  zh-cn: ライフサイクルフックを使用して、MongoDB インスタンスの IP アドレスホワイトリストを変更します。
  name-en: ACS-ESS-ECILifeCycleModifyMongoDBIPWhitelist
  name-zh-cn: ECI ライフサイクルフックを使用した MongoDB IP アドレスホワイトリストの変更
  categories:
    - elastic_manage
Parameters:
  dbInstanceId:
    Label:
      en: DBInstanceId
      zh-cn: MongoDB インスタンス ID
    Type: String
  modifyMode:
    Label:
      en: ModifyMode
      zh-cn: IP アドレスホワイトリストの変更方法
    Description:
      en: The method to modify the IP whitelist, Delete is used for elastic contraction activities, and Append is used for elastic expansion activities
      zh-cn: IP アドレスホワイトリストを変更する方法です。Append はスケールアウトアクティビティに、Delete はスケールインアクティビティに使用されます。
    Type: String
    AllowedValues:
      - Append
      - Delete
  regionId:
    Label:
      en: RegionId
      zh-cn: リージョン ID
    Description:
      en: The ID of region
      zh-cn: リージョン ID です。Auto Scaling システムのデフォルト値 ${regionId} を使用してください。
    Type: String
    Default: '${regionId}'
  instanceIds:
    Label:
      en: InstanceIds
      zh-cn: ECI インスタンス ID リスト
    Description:
      en: The ID list of the ECI instance
      zh-cn: ECI インスタンス ID リストです。Auto Scaling システムのデフォルト値 ['${instanceIds}'] を使用してください。
    Type: List
    Default:
      - '${instanceIds}'
  lifecycleHookId:
    Label:
      en: LifecycleHookId
      zh-cn: ライフサイクルフック ID
    Description:
      en: The ID of the lifecycle hook
      zh-cn: ライフサイクルフックの ID です。Auto Scaling システムのデフォルト値 ${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: インスタンスに関連付けられている特定のスケーリングアクティビティのトークンです。Auto Scaling システムのデフォルト値 ${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 ECI instance network type and ip address
      zh-cn: ECI インスタンスのネットワークタイプと 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: DDS
      API: ModifySecurityIps
      Parameters:
        RegionId: '{{ regionId }}'
        ModifyMode: '{{ modifyMode }}'
        DBInstanceId: '{{ 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 }}'