DATASOURCE::ApiGateway::Instances 概要 - ROS

DATASOURCE::ApiGateway::Instances は、インスタンスをクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::ApiGateway::Instances",
  "Properties": {
    "Language": String,
    "InstanceId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Language	String	いいえ	はい	言語タイプ。	有効な値: en: 英語 zh: 中国語 ja: 日本語
InstanceId	String	いいえ	はい	インスタンス ID。	なし。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックが更新されたときにデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

ApiGatewayInstances: インスタンスの詳細。
ApiGatewayInstanceIds: インスタンスの ID。

プロパティ	タイプ	説明	制約
ApiGatewayInstanceIds	List	インスタンスの ID。	なし。
ApiGatewayInstances	List	インスタンスの詳細。	なし。
Status	String	インスタンスのステータス。	なし。
InstanceId	String	インスタンス ID。	なし。
VpcSlbIntranetEnable	Boolean	仮想プライベートクラウド (VPC) タイプのサーバーロードバランサー (SLB) インスタンスがサポートされているかどうかを示します。	有効な値: true false
ClassicEgressAddress	String	クラシックネットワークのアウトバウンドルール。	なし。
ZoneLocalName	String	ゾーンのローカル名。	なし。
VipTypeList	String	エラスティック IP アドレス (EIP) のタイプ。	なし。
UserVpcId	String	関連付けられている VPC の ID。	なし。
VpcIntranetEnable	Boolean	インターネットアクセスが有効になっているかどうかを示します。	有効な値: true false
VpcOwnerId	String	VPC が属するアカウントの ID。	なし。
InstanceRpsLimit	Integer	インスタンスの 1 秒あたりのレコード数 (RPS) 制限。	なし。
InstanceType	String	インスタンスのカテゴリ。	有効な値: VPC_SHARED: 共有インスタンス VPC_DEDICATED: 専用インスタンス
RegionId	String	リージョン ID。	なし。
InstanceSpec	String	インスタンスタイプ。	なし。
InstanceChargeType	String	インスタンスの課金方法。	有効な値: PrePaid: サブスクリプション PayAsYouGo: 従量課金制
HttpsPolicies	String	HTTPS セキュリティポリシー。	なし。
VpcEgressAddress	String	VPC のアウトバウンド CIDR ブロック。	なし。
EgressIpv6Enable	Boolean	アウトバウンド IPv6 トラフィックがサポートされているかどうかを示します。	有効な値: true false
ExpiredTime	String	インスタンスの有効期限。	時間は UTC で表示されます。
InstanceName	String	インスタンス名。	なし。
ZoneId	String	ゾーン ID。	なし。
SupportIpv6	Boolean	IPv6 がサポートされているかどうかを示します。	有効な値: true false
InternetEgressAddress	String	アウトバウンドパブリック IP アドレス。	なし。
CreatedTime	String	インスタンスが作成された日時。	時間は UTC で表示されます。
UserVswitchId	String	関連付けられている vSwitch の ID。	なし。
InstanceSpecAttributes	List	インスタンスの仕様。	なし。

例

`JSON` 形式

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

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    # API Gateway インスタンスID。
    Description: API Gateway Instance ID.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Instances
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  ApiGatewayInstances:
    # ApiGateway グループに関する情報。
    Description: The information about ApiGateway groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGatewayInstances
  ApiGatewayInstanceIds:
    # ApiGateway グループ ID のリスト。
    Description: The list of The ApiGateway group ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGatewayInstanceIds

構文

プロパティ

戻り値 (Fn::GetAtt)

例

JSON 形式

YAML 形式

`JSON` 形式

`YAML` 形式