ALIYUN::ApiGateway::VpcAccessConfig is used to configure the VPC authorization for an instance so that VPC API can provide services externally.

Syntax

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

Properties

PropertyTypeRequiredEditableDescriptionConstraint
InstanceId String Yes Yes The ID of the ECS or SLB instance for which to configure the VPC authorization.The instance must belong to the VPC specified by the VpcId parameter.
VpcId String Yes Yes The ID of the VPC.None.
Name String Yes Yes The name of the custom authorization.The name must be unique.
Port Integer Yes Yes The port number that corresponds to the instance. None.

Response parameters

Fn::GetAtt

None.

Examples

  • YAMLformat

    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_access
  • JSONformat

    {
      "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_access"
          }
        }
      }
    }