ROS で API Gateway プラグインバインディングを自動化 - ROS

ALIYUN::APIG::PluginAttachment は、プラグインをバインドするために使用されます。

構文

{
  "Type": "ALIYUN::APIG::PluginAttachment",
  "Properties": {
    "PluginInfo": Map,
    "AttachResourceIds": List,
    "AttachResourceId": String,
    "AttachResourceType": String,
    "EnvironmentId": String,
    "Enable": Boolean
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
PluginInfo	Map	はい	いいえ	クラウドネイティブ API Gateway インスタンスにバインドするプラグインの情報。	詳細については、「PluginInfo プロパティ」をご参照ください。
AttachResourceIds	List	いいえ	はい	プラグインをバインドするリソースの ID。	最大 10 個のリソース ID を指定できます。
AttachResourceId	String	いいえ	いいえ	プラグインをバインドするリソースの ID。	なし。
AttachResourceType	String	いいえ	いいえ	プラグインをバインドするリソースのタイプ。	なし。
EnvironmentId	String	いいえ	いいえ	環境の ID。	なし。
Enable	Boolean	いいえ	はい	プラグインを有効にするかどうかを指定します。	デフォルト値: false。

PluginInfo 構文

"PluginInfo": {
  "PluginConfig": String,
  "GatewayId": String,
  "PluginId": String
}

PluginInfo プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
GatewayId	String	はい	いいえ	クラウドネイティブ API Gateway インスタンスの ID。	なし。
PluginId	String	はい	いいえ	プラグインの ID。	なし。
PluginConfig	String	いいえ	はい	クラウドネイティブ API Gateway インスタンスにバインドするプラグインの構成。	このプロパティの値は Base64 でエンコードする必要があります。

戻り値

Fn::GetAtt

AttachResourceIds: プラグインがバインドされているリソースの ID。
AttachResourceParentIds: プラグインがバインドされている親リソースの ID。
PluginClassInfo: プラグインのタイプ。
EnvironmentId: 環境の ID。
PluginAttachmentId: プラグインバインディングの ID。
Enable: プラグインが有効になっているかどうかを示します。
PluginInfo: クラウドネイティブ API Gateway インスタンスにバインドされているプラグインの情報。
AttachResourceNames: プラグインがバインドされているリソースの名前。
AttachResourceId: プラグインがバインドされているリソースの ID。
AttachResourceType: プラグインがバインドされているリソースのタイプ。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GatewayId:
    AssociationProperty: ALIYUN::APIG::Gateway::GatewayId
    Type: String
Resources:
  ExtensionResource:
    Type: ALIYUN::APIG::PluginAttachment
    Properties:
      AttachResourceIds:
        - Ref: GatewayId
      PluginInfo:
        PluginId: pl-xxxxxxx
        GatewayId:
          Ref: GatewayId
      AttachResourceId: gw-xxxxxxx
      AttachResourceType: Gateway
Outputs:
  AttachResourceIds:
    Description: プラグインによってアタッチされるリソース ID のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AttachResourceIds
  AttachResourceParentIds:
    Description: プラグインによってアタッチされるリソースの親 ID のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AttachResourceParentIds
  PluginClassInfo:
    Description: プラグインのタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PluginClassInfo
  EnvironmentId:
    Description: 環境の ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EnvironmentId
  PluginAttachmentId:
    Description: プラグインアタッチメントの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PluginAttachmentId
  Enable:
    Description: このプラグインを有効にするかどうか。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Enable
  PluginInfo:
    Description: ゲートウェイインスタンスとプラグインの関連付けに関する情報。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PluginInfo
  AttachResourceNames:
    Description: プラグインによってアタッチされるリソース名のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AttachResourceNames
  AttachResourceId:
    Description: プラグインによってアタッチされるリソース ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AttachResourceId
  AttachResourceType:
    Description: プラグインによってアタッチされるリソースのタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AttachResourceType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GatewayId": {
      "AssociationProperty": "ALIYUN::APIG::Gateway::GatewayId",
      "Type": "String"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::APIG::PluginAttachment",
      "Properties": {
        "AttachResourceIds": [
          {
            "Ref": "GatewayId"
          }
        ],
        "PluginInfo": {
          "PluginId": "pl-xxxxxxx",
          "GatewayId": {
            "Ref": "GatewayId"
          }
        },
        "AttachResourceId": "gw-xxxxxxx",
        "AttachResourceType": "Gateway"
      }
    }
  },
  "Outputs": {
    "AttachResourceIds": {
      "Description": "プラグインによってアタッチされるリソース ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AttachResourceIds"
        ]
      }
    },
    "AttachResourceParentIds": {
      "Description": "プラグインによってアタッチされるリソースの親 ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AttachResourceParentIds"
        ]
      }
    },
    "PluginClassInfo": {
      "Description": "プラグインのタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PluginClassInfo"
        ]
      }
    },
    "EnvironmentId": {
      "Description": "環境の ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvironmentId"
        ]
      }
    },
    "PluginAttachmentId": {
      "Description": "プラグインアタッチメントの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PluginAttachmentId"
        ]
      }
    },
    "Enable": {
      "Description": "このプラグインを有効にするかどうか。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Enable"
        ]
      }
    },
    "PluginInfo": {
      "Description": "ゲートウェイインスタンスとプラグインの関連付けに関する情報。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PluginInfo"
        ]
      }
    },
    "AttachResourceNames": {
      "Description": "プラグインによってアタッチされるリソース名のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AttachResourceNames"
        ]
      }
    },
    "AttachResourceId": {
      "Description": "プラグインによってアタッチされるリソース ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AttachResourceId"
        ]
      }
    },
    "AttachResourceType": {
      "Description": "プラグインによってアタッチされるリソースのタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AttachResourceType"
        ]
      }
    }
  }
}