全部产品
Search
文档中心

资源编排:DATASOURCE::CLOUDFW::AddressBooks

更新时间:Sep 18, 2024

DATASOURCE::CLOUDFW::AddressBooks类型用于查询云防火墙访问控制策略地址簿的详细信息。

语法

{
  "Type": "DATASOURCE::CLOUDFW::AddressBooks",
  "Properties": {
    "GroupType": String,
    "Lang": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

GroupType

String

地址簿的类型。

取值:

  • ip:IP地址簿。

  • domain:域名地址簿。

  • port:端口地址簿。

  • tag:ECS标签地址簿。

  • allCloud:云服务地址簿。

  • threat:威胁情报地址簿。

说明

不设置该参数表示查询IP地址簿和ECS标签地址簿。

Lang

String

请求消息的语言类型。

取值:

  • zh(默认):中文。

  • en:英文。

RefreshOptions

String

当资源栈更新时,数据源资源的刷新策略。

有效值:

  • Never(默认值):更新堆栈时,从不刷新数据源资源。

  • Always:更新堆栈时,始终刷新数据源资源。

返回值

Fn::GetAtt

  • AddressBooks:地址簿信息列表。

  • GroupUuids:地址簿的唯一标识ID列表。

属性名称

类型

描述

约束

GroupUuids

List

地址簿的唯一标识ID列表。

AddressBooks

List

地址簿信息列表。

AutoAddTagEcs

String

是否自动添加新匹配标签的ECS(新购且完成标签设置的ECS或修改标签的ECS)公网IP到地址簿。

取值:

  • 1:表示自动添加。

  • 0:表示不自动添加。

Tags

List

标签信息。

GroupUuid

String

地址簿的唯一标识ID。

AddressListCount

String

地址簿中包含地址的个数。

GroupName

String

地址簿的名称。

ReferenceCount

String

地址簿被引用次数。

TagRelation

String

多个ECS标签间的关系。

取值:

  • and:多个标签间为关系,即同时匹配多个标签的ECS公网IP才会被加入地址簿。

  • or:多个标签间为关系,即只要匹配一个标签的ECS公网IP就会被加入地址簿。

AddressList

List

地址簿的地址列表。

Description

String

地址簿的描述信息。

GroupType

String

地址簿的类型。

取值:

  • ip:IP 地址簿。

  • domain:域名地址簿。

  • port:端口地址簿。

  • tag:ECS标签地址簿。

  • allCloud:云服务地址簿。

  • threat:威胁情报地址簿。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupType:
    AllowedValues:
    - ip
    - domain
    - port
    - tag
    Description:
      en: 'Address Book, it can be set to include:

        - **ip**: an IP address book

        - **domain**: domain name address book

        - **port**: port Address Book

        - **tag**:ECS tag address book.'
    Required: false
    Type: String
  Lang:
    Description:
      en: 'The language type of the received message.

        - **zh** (default): Chinese.

        - **en**: English.'
    Required: false
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      GroupType:
        Ref: GroupType
      Lang:
        Ref: Lang
    Type: DATASOURCE::CLOUDFW::AddressBooks
Outputs:
  AddressBooks:
    Description: The list of address books.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AddressBooks
  GroupUuids:
    Description: The list of group uuids.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - GroupUuids
                        

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupType": {
      "Type": "String",
      "Description": {
        "en": "Address Book, it can be set to include:\n- **ip**: an IP address book\n- **domain**: domain name address book\n- **port**: port Address Book\n- **tag**:ECS tag address book."
      },
      "AllowedValues": [
        "ip",
        "domain",
        "port",
        "tag"
      ],
      "Required": false
    },
    "Lang": {
      "Type": "String",
      "Description": {
        "en": "The language type of the received message.\n- **zh** (default): Chinese.\n- **en**: English."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::CLOUDFW::AddressBooks",
      "Properties": {
        "GroupType": {
          "Ref": "GroupType"
        },
        "Lang": {
          "Ref": "Lang"
        }
      }
    }
  },
  "Outputs": {
    "AddressBooks": {
      "Description": "The list of address books.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AddressBooks"
        ]
      }
    },
    "GroupUuids": {
      "Description": "The list of group uuids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GroupUuids"
        ]
      }
    }
  }
}