すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:DATASOURCE::CLOUDFW::AddressBooks

最終更新日:Mar 17, 2025

DATASOURCE::CLOUDFW::AddressBooks は、Cloud Firewall でアクセスの制御に使用するアドレス帳に関する情報をクエリするために使用されます。

構文

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

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

GroupType

String

いいえ

はい

アドレス帳のタイプ。

有効な値:

  • ip: IP アドレス帳

  • domain: ドメインアドレス帳

  • port: ポートアドレス帳

  • tag: Elastic Compute Service (ECS) タグベースのアドレス帳

  • allCloud: クラウドサービスアドレス帳

  • threat: 脅威インテリジェンスアドレス帳

説明

このプロパティを指定しない場合、システムは IP アドレス帳と ECS タグベースのアドレス帳をクエリします。

Lang

String

いいえ

はい

リクエスト内のコンテンツの言語。

有効な値:

  • zh (デフォルト): 中国語

  • en: 英語

RefreshOptions

String

いいえ

はい

スタックが更新されたときのデータソースリソースのリフレッシュポリシー。

有効な値:

  • Never (デフォルト): スタックが更新されたときにデータソースリソースをリフレッシュしません。

  • Always: スタックが更新されたときにデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

  • AddressBooks: アドレス帳の詳細。

  • GroupUuids: アドレス帳の UUID。

プロパティ

タイプ

説明

制約

GroupUuids

List

アドレス帳の UUID。

なし。

AddressBooks

List

アドレス帳の詳細。

なし。

AutoAddTagEcs

String

インスタンスが指定されたタグと一致する場合、ECS インスタンスのパブリック IP アドレスがアドレス帳に自動的に追加されるかどうかを示します。このプロパティは、タグ設定が完了した新しく購入した ECS インスタンス、またはタグ設定が変更された ECS インスタンスに対して有効になります。

有効な値:

  • 1: インスタンスが指定されたタグと一致する場合、ECS インスタンスのパブリック IP アドレスはアドレス帳に自動的に追加されます。

  • 0: インスタンスが指定されたタグと一致する場合、ECS インスタンスのパブリック IP アドレスはアドレス帳に自動的に追加されません。

Tags

List

タグに関する情報。

なし。

GroupUuid

String

アドレス帳の UUID。

なし。

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 the following:

        - **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 the following:\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": "アドレス帳のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AddressBooks"
        ]
      }
    },
    "GroupUuids": {
      "Description": "グループ UUID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GroupUuids"
        ]
      }
    }
  }
}