aliyun::cloudfw::addressbook を呼び出して、セキュリティアクセスの制御アドレス帳を追加する - Resource Orchestration Service

ALIYUN::CLOUDFW::AddressBook リソースタイプは、IP アドレス帳、Elastic Compute Service (ECS) タグベースのアドレス帳、ポートアドレス帳、ドメイン名アドレス帳といった、セキュリティアクセスの制御用アドレス帳の作成に使用します。

構文

{
  "Type": "ALIYUN::CLOUDFW::AddressBook",
  "Properties": {
    "GroupType": String,
    "AutoAddTagEcs": Boolean,
    "Description": String,
    "TagRelation": String,
    "RegionId": String,
    "GroupName": String,
    "AddressList": String,
    "AckLabels": List,
    "AckClusterConnectorId": String,
    "AckNamespaces": List,
    "TagList": List
  }
}

プロパティ

プロパティ名	タイプ	必須	更新可能	説明	制約
Description	String	はい	はい	アドレス帳の説明です。	なし。
GroupName	String	はい	いいえ	アドレス帳の名前です。	なし。
GroupType	String	はい	いいえ	アドレス帳のタイプです。	有効値： IP：IP アドレス帳。 domain：ドメイン名アドレス帳。 port：ポートアドレス帳。 tag：ECS タグベースのアドレス帳。
AddressList	String	いいえ	はい	アドレス帳のアドレスリストです。複数のアドレスは英語のカンマ (,) で区切ります。説明 GroupType が IP、port、または domain の場合にこのパラメーターを設定します。	GroupType が IP の場合、アドレスリストに IP アドレスを入力します。例：10.10.XX.XX/32, 10.10.XX.XX/24。 GroupType が port の場合、アドレスリストにポートまたはポート範囲を入力します。例：80, 100/200。 GroupType が domain の場合、アドレスリストにドメイン名を入力します。例：demo1.aliyun.com, demo2.aliyun.com。
AckLabels	List	いいえ	いいえ	ACK クラスターコンテナグループのラベルのリストです。	最大 10 個です。詳細については、「AckLabels のプロパティ」をご参照ください。
AckClusterConnectorId	String	いいえ	いいえ	ACK クラスターコネクタの ID です。	なし。
AckNamespaces	List	いいえ	いいえ	ACK クラスターコンテナグループの名前空間のリストです。	最大 10 個です。
AutoAddTagEcs	Boolean	いいえ	はい	新しいタグに一致する ECS インスタンスのパブリック IP アドレスをアドレス帳に自動的に追加します。	有効値： true false
RegionId	String	いいえ	いいえ	リージョン。デフォルト値：cn-hangzhou。	有効値： cn-hangzhou ap-southeast-1
TagList	List	いいえ	はい	一致させる ECS タグです。	なし。
TagRelation	String	いいえ	はい	一致させる複数の ECS タグ間の関係です。	有効値： and：複数のタグは「AND」関係にあります。指定されたすべてのタグに一致する ECS インスタンスのパブリック IP アドレスのみがアドレス帳に追加されます。 or：複数のタグは「OR」関係にあります。指定されたいずれかのタグに一致する ECS インスタンスのパブリック IP アドレスがアドレス帳に追加されます。

AckLabels の構文

"AckLabels": [
  {
    "Key": String,
    "Value": String
  }
]

AckLabels のプロパティ

プロパティ名	タイプ	必須	更新可能	説明	制約
Key	String	いいえ	いいえ	ACK クラスターコンテナグループのラベルのキーです。	なし。
Value	String	いいえ	いいえ	ACK クラスターコンテナグループのラベルの値です。	なし。

TagList の構文

"TagList": [
  {
    "TagKey": String,
    "TagValue": String
  }
]

TagList のプロパティ

プロパティ名	タイプ	必須	更新可能	説明	制約
TagKey	String	いいえ	はい	一致させる ECS タグのキーです。	なし。
TagValue	String	いいえ	はい	一致させる ECS タグの値です。	なし。

戻り値

Fn::GetAtt

GroupUuid：アドレス帳の一意の ID です。この ID は、アドレス帳が正常に作成された後に返されます。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  AddressBook:
    Type: ALIYUN::CLOUDFW::AddressBook
    Properties:
      GroupType:
        Ref: GroupType
      AutoAddTagEcs:
        Ref: AutoAddTagEcs
      Description:
        Ref: Description
      TagRelation:
        Ref: TagRelation
      RegionId:
        Ref: RegionId
      GroupName:
        Ref: GroupName
      AddressList:
        Ref: AddressList
      TagList:
        Ref: TagList
Parameters:
  GroupType:
    Type: String
    Description: 'アドレス帳のタイプ。有効値：ip (IP アドレス帳)、domain (ドメイン名アドレス帳)、port (ポートアドレス帳)、tag (ECS タグベースのアドレス帳)。'
    AllowedValues:
    - domain
    - ip
    - port
    - tag
  AutoAddTagEcs:
    Default: false
    Type: Boolean
    Description: 新しいタグに一致する ECS インスタンスのパブリック IP アドレスをアドレス帳に自動的に追加します。デフォルトは false です。
    AllowedValues:
    - 'True'
    - 'true'
    - 'False'
    - 'false'
  Description:
    MinLength: 1
    Type: String
    Description: アドレス帳の説明。
  TagRelation:
    Type: String
    Description: '一致させる複数の ECS タグ間の関係。有効値：and (複数のタグは「AND」関係にあります。指定されたすべてのタグに一致する ECS インスタンスのパブリック IP アドレスのみがアドレス帳に追加されます)、or (複数のタグは「OR」関係にあります。指定されたいずれかのタグに一致する ECS インスタンスのパブリック IP アドレスがアドレス帳に追加されます)。'
    AllowedValues:
    - and
    - or
  RegionId:
    Default: cn-hangzhou
    Type: String
    Description: リージョン。デフォルト値：cn-hangzhou。
    AllowedValues:
    - cn-hangzhou
    - ap-southeast-1
  GroupName:
    Type: String
    Description: アドレス帳の名前。
  AddressList:
    Type: String
    Description: |-
      アドレス帳のアドレスリスト。複数のアドレスはカンマ (,) で区切ります。
      注：GroupType が IP、port、または domain の場合にこのパラメーターを設定します。
      GroupType が IP の場合、アドレスリストに IP アドレスを入力します。例：10.10.XX.XX/32, 10.10.XX.XX/24。
      GroupType が port の場合、アドレスリストにポートまたはポート範囲を入力します。例：80, 100/200。
      GroupType が domain の場合、アドレスリストにドメイン名を入力します。例：demo1.aliyun.com, demo2.aliyun.com。
  TagList:
    Type: Json
    Description: ''
    MaxLength: 100
Outputs:
  GroupUuid:
    Description: 追加が成功した後に返されるアドレス帳の一意の ID。
    Value:
      Fn::GetAtt:
      - AddressBook
      - GroupUuid

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "AddressBook": {
      "Type": "ALIYUN::CLOUDFW::AddressBook",
      "Properties": {
        "GroupType": {
          "Ref": "GroupType"
        },
        "AutoAddTagEcs": {
          "Ref": "AutoAddTagEcs"
        },
        "Description": {
          "Ref": "Description"
        },
        "TagRelation": {
          "Ref": "TagRelation"
        },
        "RegionId": {
          "Ref": "RegionId"
        },
        "GroupName": {
          "Ref": "GroupName"
        },
        "AddressList": {
          "Ref": "AddressList"
        },
        "TagList": {
          "Ref": "TagList"
        }
      }
    }
  },
  "Parameters": {
    "GroupType": {
      "Type": "String",
      "Description": "アドレス帳のタイプ。有効値：ip (IP アドレス帳)、domain (ドメイン名アドレス帳)、port (ポートアドレス帳)、tag (ECS タグベースのアドレス帳)。",
      "AllowedValues": [
        "domain",
        "ip",
        "port",
        "tag"
      ]
    },
    "AutoAddTagEcs": {
      "Default": false,
      "Type": "Boolean",
      "Description": "新しいタグに一致する ECS インスタンスのパブリック IP アドレスをアドレス帳に自動的に追加します。デフォルトは false です。",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Description": {
      "MinLength": 1,
      "Type": "String",
      "Description": "アドレス帳の説明。"
    },
    "TagRelation": {
      "Type": "String",
      "Description": "一致させる複数の ECS タグ間の関係。有効値：and (複数のタグは「AND」関係にあります。指定されたすべてのタグに一致する ECS インスタンスのパブリック IP アドレスのみがアドレス帳に追加されます)、or (複数のタグは「OR」関係にあります。指定されたいずれかのタグに一致する ECS インスタンスのパブリック IP アドレスがアドレス帳に追加されます)。",
      "AllowedValues": [
        "and",
        "or"
      ]
    },
    "RegionId": {
      "Default": "cn-hangzhou",
      "Type": "String",
      "Description": "リージョン。デフォルト値：cn-hangzhou。",
      "AllowedValues": [
        "cn-hangzhou",
        "ap-southeast-1"
      ]
    },
    "GroupName": {
      "Type": "String",
      "Description": "アドレス帳の名前。"
    },
    "AddressList": {
      "Type": "String",
      "Description": "アドレス帳のアドレスリスト。複数のアドレスはカンマ (,) で区切ります。\n注：GroupType が IP、port、または domain の場合にこのパラメーターを設定します。\nGroupType が IP の場合、アドレスリストに IP アドレスを入力します。例：10.10.XX.XX/32, 10.10.XX.XX/24。\nGroupType が port の場合、アドレスリストにポートまたはポート範囲を入力します。例：80, 100/200。\nGroupType が domain の場合、アドレスリストにドメイン名を入力します。例：demo1.aliyun.com, demo2.aliyun.com。"
    },
    "TagList": {
      "Type": "Json",
      "Description": "",
      "MaxLength": 100
    }
  },
  "Outputs": {
    "GroupUuid": {
      "Description": "追加が成功した後に返されるアドレス帳の一意の ID。",
      "Value": {
        "Fn::GetAtt": [
          "AddressBook",
          "GroupUuid"
        ]
      }
    }
  }
}