All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::VPC::Ipv6Gateway

Last Updated:Apr 18, 2023

ALIYUN::VPC::Ipv6Gateway is used to create an IPv6 gateway.

Syntax

{
  "Type": "ALIYUN::VPC::Ipv6Gateway",
  "Properties": {
    "Description": String,
    "VpcId": String,
    "Spec": String,
    "Name": String,
    "Tags": List
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Description

String

No

Yes

The description of the IPv6 gateway.

The description must be 2 to 256 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

VpcId

String

Yes

No

The ID of the virtual private cloud (VPC) for which you want to create the IPv6 gateway.

None

Spec

String

No

Yes

The specification of the IPv6 gateway.

Default value: Small. Valid values:

  • Small: Free Edition

  • Medium: Enterprise Edition

  • Large: Enhanced Enterprise Edition

Name

String

No

Yes

The name of the IPv6 gateway.

The name must be 2 to 256 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

Tags

List

No

Yes

The tags of the IPv6 gateway.

A maximum of 20 tags can be specified.

For more information, see the Tags properties section in this topic.

Tags syntax

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

Tags properties

Property

Type

Required

Editable

Description

Constraint

Key

String

Yes

No

The tag key.

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

Value

String

No

No

The tag value.

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

Response parameters

Fn::GetAtt

Ipv6GatewayId: the ID of the IPv6 gateway.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VPC:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description: Please search the ID starts with (vpc-xxx)from console-Virtual Private Cloud
    Label: Existing VPC Instance ID
Resources:
  Ipv6Gateway:
    Type: ALIYUN::VPC::Ipv6Gateway
    Properties:
      VpcId:
        Ref: VPC
      Spec: Small
Outputs:
  Ipv6GatewayId:
    Description: ID IPv6 gateway.
    Value:
      Fn::GetAtt:
        - Ipv6Gateway
        - Ipv6GatewayId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VPC": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": "Please search the ID starts with (vpc-xxx)from console-Virtual Private Cloud",
      "Label": "Existing VPC Instance ID"
    }
  },
  "Resources": {
    "Ipv6Gateway": {
      "Type": "ALIYUN::VPC::Ipv6Gateway",
      "Properties": {
        "VpcId": {
          "Ref": "VPC"
        },
        "Spec": "Small"
      }
    }
  },
  "Outputs": {
    "Ipv6GatewayId": {
      "Description": "ID IPv6 gateway.",
      "Value": {
        "Fn::GetAtt": [
          "Ipv6Gateway",
          "Ipv6GatewayId"
        ]
      }
    }
  }
}

For more examples, visit SnatEntry.json and SnatEntry.yml. In the examples, the ALIYUN::ECS::VPC, ALIYUN::ECS::VSwitch, ALIYUN::VPC::SnatEntry, ALIYUN::VPC::CommonBandwidthPackage, ALIYUN::VPC::CommonBandwidthPackageIp, ALIYUN::VPC::Ipv6Gateway, and ALIYUN::VPC::Ipv6InternetBandwidth resource types are involved.