ALIYUN::VPC::Ipv6EgressRule - Resource Orchestration Service

The ALIYUN::VPC::Ipv6EgressRule resource creates an egress-only rule for an IPv6 address.

Syntax

{
  "Type": "ALIYUN::VPC::Ipv6EgressRule",
  "Properties": {
    "InstanceId": String,
    "Ipv6GatewayId": String,
    "Description": String,
    "Ipv6EgressRuleName": String,
    "InstanceType": String
  }
}

Properties

Parameter	Type	Required	Editable	Description	Constraints
InstanceId	String	Yes	No	The ID of the IPv6 address to which the egress-only rule applies.	None
Ipv6GatewayId	String	Yes	No	The ID of the IPv6 gateway.	None
Description	String	No	No	The description of the egress-only rule.	The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.
InstanceType	String	No	No	The type of instance to which the egress-only rule applies.	Valid values: IPv6Address (default) IPv6Prefix
Ipv6EgressRuleName	String	No	No	The name of the egress-only rule.	The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.

Return values

Fn::GetAtt

Ipv6EgressRuleId: The ID of the egress-only rule.
Description: The description of the egress-only rule.
InstanceId: The ID of the IPv6 address to which the egress-only rule applies.
Ipv6EgressRuleName: The name of the egress-only rule.
InstanceType: The type of instance to which the egress-only rule applies.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description:
      en: The ID of the IPv6 address to which the egress-only rule applies.
    Required: true
  Ipv6EgressRuleName:
    Type: String
    Description:
      en: |-
        The name of the egress-only rule.
        The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.
    MinLength: 0
    MaxLength: 128
    Default: Null
    Required: false
  Description:
    Type: String
    Description:
      en: |-
        The description of the egress-only rule.
        The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.
    AssociationProperty: TextArea
    MinLength: 0
    MaxLength: 256
    Default: Null
    Required: false
  Ipv6GatewayId:
    Type: String
    Description:
      en: The ID of the IPv6 gateway.
    Required: true
  InstanceType:
    Type: String
    Description:
      en: |-
        The type of instance to which the egress-only rule applies. Valid values:
        *   IPv6Address (default)
        *   IPv6Prefix
    AllowedValues:
      - Ipv6Address
      - IPv6Prefix
    Default: Null
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::VPC::Ipv6EgressRule
    Properties:
      InstanceId:
        Ref: InstanceId
      Ipv6EgressRuleName:
        Ref: Ipv6EgressRuleName
      Description:
        Ref: Description
      Ipv6GatewayId:
        Ref: Ipv6GatewayId
      InstanceType:
        Ref: InstanceType
Outputs:
  InstanceId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - InstanceId
    Description: The ID of the IPv6 address to which the egress-only rule applies.
  Ipv6EgressRuleName:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Ipv6EgressRuleName
    Description: The name of the egress-only rule.
  Ipv6EgressRuleId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Ipv6EgressRuleId
    Description: The ID of the egress-only rule.
  Description:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
    Description: The description of the egress-only rule.
  InstanceType:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - InstanceType
    Description: The type of instance to which the egress-only rule applies.

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the IPv6 address to which the egress-only rule applies."
      },
      "Required": true
    },
    "Ipv6EgressRuleName": {
      "Type": "String",
      "Description": {
        "en": "The name of the egress-only rule.\nThe name must be 0 to 128 characters in length and cannot start with `http://` or `https://`."
      },
      "MinLength": 0,
      "MaxLength": 128,
      "Default": null,
      "Required": false
    },
    "Description": {
      "Type": "String",
      "Description": {
        "en": "The description of the egress-only rule.\nThe description must be 0 to 256 characters in length and cannot start with `http://` or `https://`."
      },
      "AssociationProperty": "TextArea",
      "MinLength": 0,
      "MaxLength": 256,
      "Default": null,
      "Required": false
    },
    "Ipv6GatewayId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the IPv6 gateway."
      },
      "Required": true
    },
    "InstanceType": {
      "Type": "String",
      "Description": {
        "en": "The type of instance to which the egress-only rule applies. Valid values:\n*   IPv6Address (default)\n*   IPv6Prefix"
      },
      "AllowedValues": [
        "Ipv6Address",
        "IPv6Prefix"
      ],
      "Default": null,
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::Ipv6EgressRule",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "Ipv6EgressRuleName": {
          "Ref": "Ipv6EgressRuleName"
        },
        "Description": {
          "Ref": "Description"
        },
        "Ipv6GatewayId": {
          "Ref": "Ipv6GatewayId"
        },
        "InstanceType": {
          "Ref": "InstanceType"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "InstanceId"
        ]
      },
      "Description": "The ID of the IPv6 address to which the egress-only rule applies."
    },
    "Ipv6EgressRuleName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Ipv6EgressRuleName"
        ]
      },
      "Description": "The name of the egress-only rule."
    },
    "Ipv6EgressRuleId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Ipv6EgressRuleId"
        ]
      },
      "Description": "The ID of the egress-only rule."
    },
    "Description": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      },
      "Description": "The description of the egress-only rule."
    },
    "InstanceType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "InstanceType"
        ]
      },
      "Description": "The type of instance to which the egress-only rule applies."
    }
  }
}