DATASOURCE::ApiGateway::Groups - 既存の API グループとその基本情報のクエリ - Resource Orchestration Service

構文

{
  "Type": "DATASOURCE::ApiGateway::Groups",
  "Properties": {
    "GroupName": String,
    "InstanceId": String,
    "Sort": String,
    "GroupId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	更新可能	説明	制約
GroupName	String	No	Yes	API グループの名前。	None
InstanceId	String	No	Yes	インスタンス ID。	None
Sort	String	No	Yes	ソート順。	有効な値： asc：更新日時で昇順にソートします。 desc：更新日時で降順にソートします。
GroupId	String	No	Yes	API グループの ID。	None
RefreshOptions	String	No	Yes	スタックの更新時に、データソースリソースに適用する更新ポリシー。	有効な値： Never (default)：スタックの更新時にデータソースリソースは更新されません。 Always：スタックの更新時にデータソースリソースは常に更新されます。

戻り値 (Fn::GetAtt)

ApiGroups： API グループのリスト。
ApiGroupIds： API グループ ID のリスト。

プロパティ名	タイプ	説明	制約
ApiGroupIds	List	API グループ ID のリスト。	None
ApiGroups	List	API グループの詳細リスト。	None
BillingStatus	String	課金ステータス。	有効な値：正常 LOCKED：支払い遅延によりインスタンスがロックされています。
GroupId	String	API グループの ID。	None
CreatedTime	String	作成日時。	時刻は GMT で、形式は YYYY-MM-DD-HH-mm です。
Description	String	グループの説明。	None
GroupName	String	API グループの名前。	None
HttpsPolicy	String	HTTPS セキュリティポリシー。	None
IllegalStatus	String	不正行為によるロックステータス。	有効な値： NORMAL：インスタンスは正常です。 LOCKED：不正行為によりインスタンスがロックされています。
InstanceId	String	インスタンス ID。	None
InstanceType	String	インスタンスタイプ。	None
ModifiedTime	String	最終更新日時。	時刻は GMT で、形式は YYYY-MM-DD-HH-mm です。
RegionId	String	API グループが属するリージョン。	None
SubDomain	String	API グループに割り当てられたセカンドレベルドメイン。	カスタムドメイン名の CNAME として使用されます。
TrafficLimit	Integer	グループの QPS 上限。	デフォルト値： 500。説明 QPS 上限の引き上げを申請できます。
Tags	Map	API グループのタグ。	None

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupId:
    Type: String
    Description: API グループ ID。
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Groups
    Properties:
      GroupId:
        Ref: GroupId
Outputs:
  ApiGroups:
    Description: API グループの情報。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroups
  ApiGroupIds:
    Description: API グループ ID のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroupIds

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Description": "API グループ ID。"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Groups",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        }
      }
    }
  },
  "Outputs": {
    "ApiGroups": {
      "Description": "API グループの情報。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroups"
        ]
      }
    },
    "ApiGroupIds": {
      "Description": "API グループ ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroupIds"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値 (Fn::GetAtt)

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式