ALIYUN::VPC::FullNatEntry - Resource Orchestration Service

ALIYUN::VPC::FullNatEntry is used to add a FULLNAT entry to a FULLNAT table.

Syntax

{
  "Type": "ALIYUN::VPC::FullNatEntry",
  "Properties": {
    "NatIp": String,
    "FullNatEntryDescription": String,
    "AccessIp": String,
    "FullNatTableId": String,
    "FullNatEntryName": String,
    "NatIpPort": String,
    "IpProtocol": String,
    "AccessPort": String,
    "NetworkInterfaceId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
NatIp	String	Yes	Yes	The NAT IP address that provides address translation.	None.
FullNatEntryDescription	String	No	Yes	The description of the FULLNAT entry.	The description can be empty or must be 2 to 256 characters in length. It cannot start with `http://` or `https://`.
AccessIp	String	Yes	Yes	The backend IP address to be modified in FULLNAT address translation.	None.
FullNatTableId	String	Yes	No	The ID of the FULLNAT table to which you want to add the FULLNAT entry.	None.
FullNatEntryName	String	No	Yes	The name of the FULLNAT entry.	The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`.
NatIpPort	String	Yes	Yes	The frontend port to be modified in the FULLNAT port mapping.	Valid values: 1 to 65535.
IpProtocol	String	Yes	Yes	The protocol type of the forwarding port.	Valid values: TCP: forwards TCP packets. UDP: forwards UDP packets.
AccessPort	String	Yes	Yes	The backend port to be modified in the FULLNAT port mapping.	Valid values: 1 to 65535.
NetworkInterfaceId	String	Yes	Yes	The ID of the elastic network interface (ENI).	None.

Return values

Fn::GetAtt

FullNatEntryId: the ID of the FULLNAT entry.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AccessIp:
    Description:
      en: The backend IP address to be modified in FULLNAT address translation.
    Required: true
    Type: String
  AccessPort:
    Description:
      en: 'The backend port to be modified in the mapping of FULLNAT port. Valid values:
        1 to 65535.'
    Required: true
    Type: String
  FullNatEntryDescription:
    Description:
      en: 'The description of the FULLNAT entry.

        This parameter is optional. If you enter a description, the description must
        be 2 to 256 characters in length, and cannot start with http:// or https://.'
    Required: false
    Type: String
  FullNatEntryName:
    Description:
      en: The FULLNAT entry name. The name must be 2 to 128 characters in length.
        It must start with a letter but cannot start with http:// or https://.
    Required: false
    Type: String
  FullNatTableId:
    Description:
      en: The ID of the FULLNAT table to which the FULLNAT entry belongs.
    Required: true
    Type: String
  IpProtocol:
    AllowedValues:
    - TCP
    - UDP
    Description:
      en: 'The protocol of the packets that are forwarded by the port. Valid values:

        TCP

        UDP'
    Required: true
    Type: String
  NatIp:
    Description:
      en: The NAT IP address that provides address translation.
    Required: true
    Type: String
  NatIpPort:
    Description:
      en: 'The frontend port to be modified in the mapping of FULLNAT port. Valid
        values: 1 to 65535.'
    Required: true
    Type: String
  NetworkInterfaceId:
    Description:
      en: The elastic network interface (ENI) ID.
    Required: true
    Type: String
Resources:
  FullNatEntry:
    Properties:
      AccessIp:
        Ref: AccessIp
      AccessPort:
        Ref: AccessPort
      FullNatEntryDescription:
        Ref: FullNatEntryDescription
      FullNatEntryName:
        Ref: FullNatEntryName
      FullNatTableId:
        Ref: FullNatTableId
      IpProtocol:
        Ref: IpProtocol
      NatIp:
        Ref: NatIp
      NatIpPort:
        Ref: NatIpPort
      NetworkInterfaceId:
        Ref: NetworkInterfaceId
    Type: ALIYUN::VPC::FullNatEntry
Outputs:
  FullNatEntryId:
    Description: The FULLNAT entry ID.
    Value:
      Fn::GetAtt:
      - FullNatEntry
      - FullNatEntryId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "NatIp": {
      "Type": "String",
      "Description": {
        "en": "The NAT IP address that provides address translation."
      },
      "Required": true
    },
    "FullNatEntryDescription": {
      "Type": "String",
      "Description": {
        "en": "The description of the FULLNAT entry.\nThis parameter is optional. If you enter a description, the description must be 2 to 256 characters in length, and cannot start with http:// or https://."
      },
      "Required": false
    },
    "AccessIp": {
      "Type": "String",
      "Description": {
        "en": "The backend IP address to be modified in FULLNAT address translation."
      },
      "Required": true
    },
    "FullNatTableId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the FULLNAT table to which the FULLNAT entry belongs."
      },
      "Required": true
    },
    "FullNatEntryName": {
      "Type": "String",
      "Description": {
        "en": "The FULLNAT entry name. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://."
      },
      "Required": false
    },
    "IpProtocol": {
      "Type": "String",
      "Description": {
        "en": "The protocol of the packets that are forwarded by the port. Valid values:\nTCP\nUDP"
      },
      "AllowedValues": [
        "TCP",
        "UDP"
      ],
      "Required": true
    },
    "NatIpPort": {
      "Type": "String",
      "Description": {
        "en": "The frontend port to be modified in the mapping of FULLNAT port. Valid values: 1 to 65535."
      },
      "Required": true
    },
    "AccessPort": {
      "Type": "String",
      "Description": {
        "en": "The backend port to be modified in the mapping of FULLNAT port. Valid values: 1 to 65535."
      },
      "Required": true
    },
    "NetworkInterfaceId": {
      "Type": "String",
      "Description": {
        "en": "The elastic network interface (ENI) ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "FullNatEntry": {
      "Type": "ALIYUN::VPC::FullNatEntry",
      "Properties": {
        "NatIp": {
          "Ref": "NatIp"
        },
        "FullNatEntryDescription": {
          "Ref": "FullNatEntryDescription"
        },
        "AccessIp": {
          "Ref": "AccessIp"
        },
        "FullNatTableId": {
          "Ref": "FullNatTableId"
        },
        "FullNatEntryName": {
          "Ref": "FullNatEntryName"
        },
        "IpProtocol": {
          "Ref": "IpProtocol"
        },
        "NatIpPort": {
          "Ref": "NatIpPort"
        },
        "AccessPort": {
          "Ref": "AccessPort"
        },
        "NetworkInterfaceId": {
          "Ref": "NetworkInterfaceId"
        }
      }
    }
  },
  "Outputs": {
    "FullNatEntryId": {
      "Description": "The FULLNAT entry ID.",
      "Value": {
        "Fn::GetAtt": [
          "FullNatEntry",
          "FullNatEntryId"
        ]
      }
    }
  }
}