DATASOURCE::ApiGateway::Groups リソース概要 - ROS

DATASOURCE::ApiGateway::Groups は、既存の API グループに関する情報を照会するために使用されます。

構文

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

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
GroupName	String	いいえ	はい	API グループの名前。	なし。
InstanceId	String	いいえ	はい	インスタンス ID。	なし。
Sort	String	いいえ	はい	API グループが表示される順序。	有効な値: asc: API グループは、変更時間の昇順で表示されます。 desc: API グループは、変更時間の降順で表示されます。
GroupId	String	いいえ	はい	API グループの ID。	なし。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never（デフォルト）: スタックが更新されたときにデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

ApiGroups: API グループの詳細。
ApiGroupIds: API グループの ID。

プロパティ	タイプ	説明	制約
ApiGroupIds	List	API グループの ID。	なし。
ApiGroups	List	API グループの詳細。	なし。
BillingStatus	String	API グループの請求ステータス。	有効な値: NORMAL: API グループの請求状態は正常です。 LOCKED: 支払いの延滞により API グループはロックされています。
GroupId	String	API グループの ID。	なし。
CreatedTime	String	API グループが作成された時刻。	時刻は UTC で表示されます。時刻は ISO 8601 標準の yy-mm-dd-hh-mm 形式に従います。
Description	String	API グループの説明。	なし。
GroupName	String	API グループの名前。	なし。
HttpsPolicy	String	HTTPS セキュリティポリシー。	なし。
IllegalStatus	String	API グループの有効性ステータス。	有効な値: NORMAL: API グループは有効です。 LOCKED: 無効であるため、API グループはロックされています。
InstanceId	String	インスタンス ID。	なし。
InstanceType	String	インスタンスタイプ。	なし。
ModifiedTime	String	API グループが最後に変更された時刻。	時刻は UTC で表示されます。時刻は ISO 8601 標準の yy-mm-dd-hh-mm 形式に従います。
RegionId	String	API グループのリージョン。	なし。
SubDomain	String	API グループに対応するセカンドレベルドメイン名。	セカンドレベルドメイン名は、カスタムドメイン名の正規名（ CNAME ）によって使用されます。
TrafficLimit	Integer	API グループの 1 秒あたりの最大クエリ数（ QPS ）。	デフォルト値: 500。説明最大 QPS を増やすリクエストを行うことができます。
Tags	Map	タグ。	なし。

例

`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: ApiGateway グループに関する情報。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroups
  ApiGroupIds:
    Description: ApiGateway グループ ID のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroupIds

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Description": "API グループ ID。" // API group ID.
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Groups",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        }
      }
    }
  },
  "Outputs": {
    "ApiGroups": {
      "Description": "ApiGateway グループに関する情報。", // The information about ApiGateway groups.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroups"
        ]
      }
    },
    "ApiGroupIds": {
      "Description": "ApiGateway グループ ID のリスト。", // The list of The ApiGateway group ids.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroupIds"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値 (Fn::GetAtt)

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式