文档

ALIYUN::CEN::TransitRouterVpnAttachment

更新时间:

ALIYUN::CEN::TransitRouterVpnAttachment类型用于创建VPN连接。

语法

{
  "Type": "ALIYUN::CEN::TransitRouterVpnAttachment",
  "Properties": {
    "AutoPublishRouteEnabled": Boolean,
    "RouteTableAssociationEnabled": Boolean,
    "VpnOwnerId": String,
    "DeletionForce": Boolean,
    "ZoneId": String,
    "RouteTablePropagationEnabled": Boolean,
    "CenId": String,
    "TransitRouterAttachmentName": String,
    "Tags": List,
    "TransitRouterAttachmentDescription": String,
    "TransitRouterId": String,
    "VpnId": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

VpnId

String

IPsec连接ID。

ZoneId

String

可用区ID。

AutoPublishRouteEnabled

Boolean

是否允许转发路由器实例自动向IPsec连接发布路由条目。

取值:

  • true(默认值):允许。

  • false:不允许。

CenId

String

云企业网实例ID。

DeletionForce

Boolean

是否强制删除VPN连接。 

取值:

  • true:强制删除VPN连接。

  • false:不强制删除VPN连接。

RouteTableAssociationEnabled

Boolean

是否启动路由关联转发关系。

取值:

  • true:启用路由关联转发关系。

  • false:禁用路由关联转发关系。

RouteTablePropagationEnabled

Boolean

是否启用路由学习关系。

取值:

  • true:启用路由学习关系。

  • false:禁用路由学习关系。

Tags

List

标签信息列表。

一次最多支持输入20个标签信息。更多信息,请参见Tags属性

TransitRouterAttachmentDescription

String

VPN连接的描述信息。

描述长度为2~256个字符,必须以字母或中文开头,但不能以http://https://开头。

TransitRouterAttachmentName

String

VPN连接的名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-)。

TransitRouterId

String

转发路由器实例ID。

VpnOwnerId

String

IPsec连接所属的阿里云账号(主账号)ID。

参数要求:

  • 如果不输入本参数,默认使用当前登录的阿里云账号ID。

  • 如果您要连接跨账号的IPsec连接时,本参数必填。

Tags语法

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

Tags属性

属性名称

类型

必须

允许更新

描述

约束

Key

String

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

Value

String

资源的标签值。

标签值可以为空或输入不超过128个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

返回值

Fn::GetAtt

TransitRouterAttachmentId:VPN连接ID。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ZoneId:
    AssociationProperty: ZoneId
    Type: String
    Description:
      en: Availability zone ID in the current region.
  VpnOwnerId:
    Type: String
    Description:
      en: Alibaba Cloud account (main account) ID to which the IPsec connection belongs.
  CenId:
    Type: String
    Description:
      en: The ID of the CEN instance.
  TransitRouterAttachmentName:
    Type: String
    Description:
      en: The name of the VPN connection.
  TransitRouterId:
    Type: String
    Description:
      en: Forwarding router instance ID
  VpnId:
    Type: String
    Description:
      en: IPsec connection ID
Resources:
  TransitRouterVpnAttachment:
    Type: ALIYUN::CEN::TransitRouterVpnAttachment
    Properties:
      VpnOwnerId:
        Ref: VpnOwnerId
      ZoneId:
        Ref: ZoneId
      CenId:
        Ref: CenId
      TransitRouterAttachmentName:
        Ref: TransitRouterAttachmentName
      TransitRouterId:
        Ref: TransitRouterId
      VpnId:
        Ref: VpnId
Outputs:
  TransitRouterAttachmentId:
    Description: The ID of the VPN connection.
    Value:
      Fn::GetAtt:
        - TransitRouterVpnAttachment
        - TransitRouterAttachmentId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "en": "Availability zone ID in the current region."
      }
    },
    "VpnOwnerId": {
      "Type": "String",
      "Description": {
        "en": "Alibaba Cloud account (main account) ID to which the IPsec connection belongs."
      }
    },
    "CenId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the CEN instance."
      }
    },
    "TransitRouterAttachmentName": {
      "Type": "String",
      "Description": {
        "en": "The name of the VPN connection."
      }
    },
    "TransitRouterId": {
      "Type": "String",
      "Description": {
        "en": "Forwarding router instance ID"
      }
    },
    "VpnId": {
      "Type": "String",
      "Description": {
        "en": "IPsec connection ID"
      }
    }
  },
  "Resources": {
    "TransitRouterVpnAttachment": {
      "Type": "ALIYUN::CEN::TransitRouterVpnAttachment",
      "Properties": {
        "VpnOwnerId": {
          "Ref": "VpnOwnerId"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "CenId": {
          "Ref": "CenId"
        },
        "TransitRouterAttachmentName": {
          "Ref": "TransitRouterAttachmentName"
        },
        "TransitRouterId": {
          "Ref": "TransitRouterId"
        },
        "VpnId": {
          "Ref": "VpnId"
        }
      }
    }
  },
  "Outputs": {
    "TransitRouterAttachmentId": {
      "Description": "The ID of the VPN connection.",
      "Value": {
        "Fn::GetAtt": [
          "TransitRouterVpnAttachment",
          "TransitRouterAttachmentId"
        ]
      }
    }
  }
}