Help Center/ Resource Formation Service/ User Guide (ME-Abu Dhabi Region)/ Template Reference/ List of Elements/ NAT.Instance
Updated on 2022-02-22 GMT+08:00
View PDF

NAT.Instance

Element Description

The NAT.Instance element is used to create a NAT gateway instance.

Element Properties

Table 1 Property Description

Property

Mandatory

Descripiton

subnetId

Yes

ID of the subnet to which the NAT gateway belongs

Type: Cloud.VPC.Subnet.Id

Value Description: Obtains the subnet ID from the VPC service or connects to the NAT.Subnet to automatically generate a subnet ID.

Value Constraint: The value must satisfy the UUID rule and contain a maximum of 64 characters.

Suggestion: 1. Use the get_input function to set this field, and then the value can be automatically selected on the AOS console. 2. Connect to a subnet and use the get_reference function to obtain the subnet ID.

flavor

Yes

NAT gateway specifications

Type: string

Default: small

Value Constraint: The value of this parameter must comply with the definition of NAT gateway specifications.

Suggestion: The options are small, middle, large, and xlarge.

vpcId

Yes

ID of the VPC to which the NAT gateway belongs

Type: Cloud.VPC.VPC.Id

Value Description: Use the ID of an existing VPC or a new VPC. To use a new VPC ID, you need to define the VPC object in the template and establish the dependency. You are advised to drag the object to the VPC to automatically establish the dependency.

Value Constraint: The value must satisfy the UUID rule and contain a maximum of 64 characters.

Suggestion: 1. Use the get_input function to set this field, and then the value can be automatically selected on the AOS console. 2. Use the get_reference function to obtain the VPC.VPC element created by the stack. 3. Obtain the ID of the created VPC from the VPC console.

description

No

Description of the NAT gateway instance

Type: string

Value Description: Customize the value.

Value Constraint: Enter a maximum of 255 characters. Only letters and digits are supported.

Suggestion: Customize the value.

name

Yes

NAT name

Type: string

Value Description: Customize the value, for example, my-nat.

Value Constraint: Enter 1 to 64 characters. The value must meet regular expression [-_a-zA-Z0-9]*$.

Suggestion: Customize the value.

Relationships Between Elements

Table 2 Relationship description

Description

Target

Connected

VPC.Subnet

Inclusion

VPC.VPC

Return Value

Property

Type

Description

refName

string

NAT instance name

refID

string

NAT instance ID

Blueprint Example

tosca_definitions_version: cloud_tosca_version_1_0
node_templates:
  nat:
    type: Cloud.NAT.Instance
    properties:
      subnetId:
        get_input: nat_subnetId
      flavor: small
      vpcId:
        get_input: nat_vpcId
      name:
        get_input: nat_name
  snatrule:
    type: Cloud.NAT.SNatRule
    properties:
      subnetId:
        get_input: snatrule_subnetId
      floatingIpId:
        get_input: snatrule_floatingIpId
      natGatewayId:
        get_reference: nat
    requirements:
      - natGatewayId:
          node: nat
inputs:
  nat_subnetId:
    description: ID of the subnet to which the NAT gateway belongs
    label: ''
  nat_vpcId:
    description: ID of the VPC to which the NAT gateway belongs
    label: ''
  nat_name:
    description: NAT name
    label: ''
  snatrule_subnetId:
    description: ID of the subnet to which the source NAT rule belongs
    label: ''
  snatrule_floatingIpId:
    description: ID of the user's elastic IP address
    label: ''
Parent topic: List of Elements