ALIYUN::ApiGateway::Plugin は、API ゲートウェイプラグインを作成するために使用されます。
構文
{
"Type": "ALIYUN::ApiGateway::Plugin",
"Properties": {
"PluginName": String,
"Description": String,
"PluginData": String,
"PluginType": String,
"Tags": List
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
PluginData | String | はい | はい | プラグインの定義ステートメント。 | 定義ステートメントは JSON または YAML 形式で指定できます。 |
PluginName | String | はい | はい | プラグインの名前。 | 名前は 4 ～ 50 文字で、文字、数字、ハイフン (-) を使用できます。名前はハイフン (-) で始めることはできません。 |
PluginType | String | はい | いいえ | プラグインのタイプ。 | 有効な値:
|
Description | String | いいえ | はい | プラグインの説明。 | 説明は最大 200 文字まで入力できます。 |
Tags | List | いいえ | はい | プラグインのタグ。 | プラグインには最大 20 個のタグを追加できます。 詳細については、タグのプロパティ をご参照ください。 |
タグの構文
"Tags": [
{
"Key": String,
"Value": String
}
] タグのプロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
Key | String | はい | いいえ | タグキー。 | タグキーは 1 ～ 128 文字で、 |
Value | String | いいえ | いいえ | タグ値。 | タグ値は最大 128 文字で、 |
戻り値
Fn::GetAtt
Description: プラグインの説明。
PluginName: プラグインの名前。
PluginData: プラグインの定義ステートメント。
PluginId: プラグインの ID。
PluginType: プラグインのタイプ。
例
YAML 形式
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
Description:
Description: プラグインの説明。200 文字を超えることはできません。
Type: String
PluginData:
Description: プラグインの定義ステートメント。JSON および YAML 形式のプラグイン定義ステートメントがサポートされています。
Type: String
PluginName:
Description: 作成するプラグインの名前。大文字の英字、小文字の英字、漢字、数字、アンダースコア (_) を使用できます。4 ～ 50 文字で、アンダースコア (_) で始めることはできません。
Type: String
PluginType:
Description: 'プラグインのタイプ。有効な値: ipControl: IP アドレスベースのアクセス制御を示します。trafficControl: スロットリングを示します。backendSignature: バックエンド署名を示します。jwtAuth: JWT (OpenId Connect) を示します。cors: クロスオリジンリソースアクセス (CORS) を示します。caching: キャッシングを示します。'
Type: String
Resources:
ApiGatewayPlugin:
Properties:
Description:
Ref: Description
PluginData:
Ref: PluginData
PluginName:
Ref: PluginName
PluginType:
Ref: PluginType
Type: ALIYUN::ApiGateway::Plugin
Outputs:
Description:
Description: プラグインの説明。200 文字を超えることはできません。
Value:
Fn::GetAtt:
- ApiGatewayPlugin
- Description
PluginData:
Description: プラグインの定義ステートメント。JSON および YAML 形式のプラグイン定義ステートメントがサポートされています。
Value:
Fn::GetAtt:
- ApiGatewayPlugin
- PluginData
PluginId:
Description: 生成されたプラグイン ID。
Value:
Fn::GetAtt:
- ApiGatewayPlugin
- PluginId
PluginName:
Description: 作成するプラグインの名前。大文字の英字、小文字の英字、漢字、数字、アンダースコア (_) を使用できます。4 ～ 50 文字で、アンダースコア (_) で始めることはできません。
Value:
Fn::GetAtt:
- ApiGatewayPlugin
- PluginName
PluginType:
Description: 'プラグインのタイプ。有効な値: ipControl: IP アドレスベースのアクセス制御を示します。trafficControl: スロットリングを示します。backendSignature: バックエンド署名を示します。jwtAuth: JWT (OpenId Connect) を示します。cors: クロスオリジンリソースアクセス (CORS) を示します。caching: キャッシングを示します。'
Value:
Fn::GetAtt:
- ApiGatewayPlugin
- PluginTypeJSON 形式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"PluginName": {
"Type": "String",
"Description": "作成するプラグインの名前。大文字の英字、小文字の英字、漢字、数字、アンダースコア (_) を使用できます。4 ～ 50 文字で、アンダースコア (_) で始めることはできません。" // The name of the plug-in that you want to create. It can contain uppercase English letters, lowercase English letters, Chinese characters, numbers, and underscores (). It must be 4 to 50 characters in length and cannot start with an underscore ().
},
"Description": {
"Type": "String",
"Description": "プラグインの説明。200 文字を超えることはできません。" // The description of the plug-in, which cannot exceed 200 characters.
},
"PluginData": {
"Type": "String",
"Description": "プラグインの定義ステートメント。JSON および YAML 形式のプラグイン定義ステートメントがサポートされています。" // The definition statement of the plug-in. Plug-in definition statements in the JSON and YAML formats are supported.
},
"PluginType": {
"Type": "String",
"Description": "プラグインのタイプ。有効な値: ipControl: IP アドレスベースのアクセス制御を示します。trafficControl: スロットリングを示します。backendSignature: バックエンド署名を示します。jwtAuth: JWT (OpenId Connect) を示します。cors: クロスオリジンリソースアクセス (CORS) を示します。caching: キャッシングを示します。" // The type of the plug-in. Valid values: ipControl: indicates IP address-based access control. trafficControl: indicates throttling. backendSignature: indicates backend signature. jwtAuth: indicates JWT (OpenId Connect). cors: indicates cross-origin resource access (CORS). caching: indicates caching.
}
},
"Resources": {
"ApiGatewayPlugin": {
"Type": "ALIYUN::ApiGateway::Plugin",
"Properties": {
"PluginName": {
"Ref": "PluginName"
},
"Description": {
"Ref": "Description"
},
"PluginData": {
"Ref": "PluginData"
},
"PluginType": {
"Ref": "PluginType"
}
}
}
},
"Outputs": {
"Description": {
"Description": "プラグインの説明。200 文字を超えることはできません。", // The description of the plug-in, which cannot exceed 200 characters.
"Value": {
"Fn::GetAtt": [
"ApiGatewayPlugin",
"Description"
]
}
},
"PluginName": {
"Description": "作成するプラグインの名前。大文字の英字、小文字の英字、漢字、数字、アンダースコア (_) を使用できます。4 ～ 50 文字で、アンダースコア (_) で始めることはできません。", // The name of the plug-in that you want to create. It can contain uppercase English letters, lowercase English letters, Chinese characters, numbers, and underscores (). It must be 4 to 50 characters in length and cannot start with an underscore ().
"Value": {
"Fn::GetAtt": [
"ApiGatewayPlugin",
"PluginName"
]
}
},
"PluginData": {
"Description": "プラグインの定義ステートメント。JSON および YAML 形式のプラグイン定義ステートメントがサポートされています。", // The definition statement of the plug-in. Plug-in definition statements in the JSON and YAML formats are supported.
"Value": {
"Fn::GetAtt": [
"ApiGatewayPlugin",
"PluginData"
]
}
},
"PluginId": {
"Description": "生成されたプラグイン ID。", // The generated plugin ID.
"Value": {
"Fn::GetAtt": [
"ApiGatewayPlugin",
"PluginId"
]
}
},
"PluginType": {
"Description": "プラグインのタイプ。有効な値: ipControl: IP アドレスベースのアクセス制御を示します。trafficControl: スロットリングを示します。backendSignature: バックエンド署名を示します。jwtAuth: JWT (OpenId Connect) を示します。cors: クロスオリジンリソースアクセス (CORS) を示します。caching: キャッシングを示します。", // The type of the plug-in. Valid values: ipControl: indicates IP address-based access control. trafficControl: indicates throttling. backendSignature: indicates backend signature. jwtAuth: indicates JWT (OpenId Connect). cors: indicates cross-origin resource access (CORS). caching: indicates caching.
"Value": {
"Fn::GetAtt": [
"ApiGatewayPlugin",
"PluginType"
]
}
}
}
}