ALIYUN::ApiGateway::VpcAccessConfig は、インスタンスの仮想プライベートクラウド (VPC) アクセス認証を設定するために使用されます。これにより、API はプライベートネットワークに基づいてサービスを提供できます。
構文
{
"Type": "ALIYUN::ApiGateway::VpcAccessConfig",
"Properties": {
"InstanceId": String,
"VpcId": String,
"Name": String,
"Port": Integer
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
InstanceId | String | はい | はい | VPC アクセス認証を設定する Elastic Compute Service (ECS) または Server Load Balancer (SLB) インスタンスの ID。 | インスタンスは、VpcId で指定された VPC に属している必要があります。 |
Name | String | はい | はい | カスタム認証の名前。 | 名前は一意である必要があります。 |
Port | Integer | はい | はい | インスタンスのポート番号。 | なし。 |
VpcId | String | はい | はい | VPC ID。 | なし。 |
戻り値
Fn::GetAtt
なし。
例
説明
マスクされたパラメーターの値は、ビジネス要件に基づいて変更してください。
YAML 形式
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
InstanceId:
Type: String
AssociationProperty: ALIYUN::ECS::Instance::InstanceId
VpcId:
Type: String
AssociationProperty: ALIYUN::ECS::VPC::VPCId
Resources:
VpcAccesssConfig:
Type: ALIYUN::ApiGateway::VpcAccessConfig
Properties:
VpcId:
Ref: VpcId
InstanceId:
Ref: InstanceId
Port: 8080
Name: ros_test_vpc_accessJSON 形式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"InstanceId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::Instance::InstanceId"
},
"VpcId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
}
},
"Resources": {
"VpcAccesssConfig": {
"Type": "ALIYUN::ApiGateway::VpcAccessConfig",
"Properties": {
"VpcId": {
"Ref": "VpcId"
},
"InstanceId": {
"Ref": "InstanceId"
},
"Port": 8080,
"Name": "ros_test_vpc_ac****"
}
}
}
}