ALIYUN::ApiGateway::VpcAccessConfig is used to configure the VPC authorization to provide services through the VPC API.

Syntax

{
  "Type": "ALIYUN::ApiGateway::VpcAccessConfig",
  "Properties": {
    "InstanceId": String,
    "VpcId": String,
    "Name": String,
    "Port": Integer
  }
}

Properties

Name Type Required Editable Description
InstanceId String Yes Yes The ID of the target ECS or SLB instance. The instance must belong to the VPC specified by the VpcId parameter.
VpcId String Yes Yes The ID of the VPC.
Name String Yes Yes The unique custom name for authorization.
Port Integer Yes Yes The port number corresponding to the instance.

Response parameters

Fn::GetAtt

None

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String"
    },
    "VpcId": {
      "Type": "String"
    }
  },
  "Resources": {
    "VpcAccesssConfig": {
      "Type": "ALIYUN::ApiGateway::VpcAccessConfig",
      "Properties": {
        "VpcId": {"Ref": "VpcId"},
        "InstanceId": {"Ref": "InstanceId"},
        "Port": 8080,
        "Name": "ros_test_vpc_access"
      }
    }
  }
}