ALIYUN::VPC::VpcGatewayEndpoint - Resource Orchestration Service

ALIYUN::VPC::VpcGatewayEndpoint is used to create a gateway endpoint.

Syntax

{
  "Type": "ALIYUN::VPC::VpcGatewayEndpoint",
  "Properties": {
    "ServiceName": String,
    "VpcId": String,
    "EndpointName": String,
    "EndpointDescription": String,
    "PolicyDocument": String,
    "ResourceGroupId": String,
    "Tags": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ServiceName	String	Yes	No	The name of the endpoint service.	None.
VpcId	String	Yes	No	The ID of the virtual private cloud (VPC) in which you want to create the gateway endpoint.	None.
EndpointName	String	No	Yes	The name of the gateway endpoint.	The name must be 1 to 128 characters in length.
EndpointDescription	String	No	Yes	The description of the gateway endpoint.	The description must be 1 to 255 characters in length.
PolicyDocument	String	No	Yes	The access policy for the cloud service.	For more information about the syntax and structure of access policies, see Policy syntax and structure. Note This property must be specified if the selected endpoint service supports access policies. This property must be left empty if the selected endpoint service does not support access policies. You can call the ListVpcEndpointServicesByEndUser operation and obtain the SupportPolicy value to check whether the endpoint service supports access policies. If the SupportPolicy value is true, the endpoint service supports access policies. Otherwise, the endpoint service does not support access policies.
ResourceGroupId	String	No	No	The ID of the resource group to which the gateway endpoint belongs.	None.
Tags	List	No	No	The tags that you want to add to the gateway endpoint.	You can add up to 20 tags. For more information, see Tags properties.

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property

Type

Required

Editable

Description

Constraint

Key

String

Yes

The key of the tag that you want to add to the gateway endpoint.

The tag key cannot be an empty string.

The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.

Value

String

The value of the tag that you want to add to the gateway endpoint.

The tag value can be an empty string.

The tag value can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.

Return values

Fn::GetAtt

EndpointId: the ID of the gateway endpoint.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      en: |-
        The VPC ID of the gateway endpoint is to be created.
        The VPC must be in the same region as the gateway endpoint.
    Required: true
  ServiceName:
    Type: String
    Description:
      en: Terminal service name.
    Required: true
Resources:
  VpcGatewayEndpoint:
    Type: ALIYUN::VPC::VpcGatewayEndpoint
    Properties:
      VpcId:
        Ref: VpcId
      ServiceName:
        Ref: ServiceName
Outputs:
  EndpointId:
    Description: Gateway endpoint instance ID.
    Value:
      Fn::GetAtt:
        - VpcGatewayEndpoint
        - EndpointId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "en": "The VPC ID of the gateway endpoint is to be created.\nThe VPC must be in the same region as the gateway endpoint."
      },
      "Required": true
    },
    "ServiceName": {
      "Type": "String",
      "Description": {
        "en": "Terminal service name."
      },
      "Required": true
    }
  },
  "Resources": {
    "VpcGatewayEndpoint": {
      "Type": "ALIYUN::VPC::VpcGatewayEndpoint",
      "Properties": {
        "VpcId": {
          "Ref": "VpcId"
        },
        "ServiceName": {
          "Ref": "ServiceName"
        }
      }
    }
  },
  "Outputs": {
    "EndpointId": {
      "Description": "Gateway endpoint instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "VpcGatewayEndpoint",
          "EndpointId"
        ]
      }
    }
  }
}