Help Center/ Resource Formation Service/ Template Reference/ Application Orchestration Service/ List of Elements/ NAT.Instance
Updated on 2023-12-13 GMT+08:00
View PDF
Share

NAT.Instance

Element Description

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

Element Properties

Table 1 Property Description

Property

Required

Descripiton

subnetId

Yes

ID of the Subnet to which the NatGateWay belongs

Type: HuaweiCloud.VPC.Subnet.Id

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

Suggestion: Use the get_input function to pass this parameter. Its value can then be automatically selected when you create a stack on the AOS console. Connect to a subnet object and use the get_reference function to the ID of the newly created subnet.

flavor

Yes

NatGateWay specification

Type: string

Default: small

Value Constraint: The NAT specification and definition must be complied with

Suggestion: Valid value:[small middle large xlarge]

vpcId

Yes

ID of the VPC to which the NatGateWay belongs

Type: HuaweiCloud.VPC.VPC.Id

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

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

Suggestion: Use the get_input function to pass this parameter. Its value can then be automatically selected when you create a stack on the AOS console. Use the get_reference function to reference a VPC.VPC element created by the current stack. The group ID can then be automatically specified when you use the designer to create a dependency on the VPC.VPC element. Obtain the ID of the created VPC on the VPC console at https://console.huaweicloud.com/vpc?&locale=en-us.

description

No

NatGateWay instance

Type: string

Value Description: Supports customization.

Value Constraint: The value contains a maximum of 255 characters, including letters and digits.

Suggestion: Customize the value.

name

Yes

Name of the NatGateWay instance

Type: string

Value Description: Supports customization, for example, my-nat.

Value Constraint: The value must contain 1 to 64 characters and meet the following requirement: [-_a-zA-Z0-9]*$.

Suggestion: Customize the value.

Relationships Between Elements

Table 2 Relationship description

Description

Target

Connected

VPC.Subnet

ContainedIn

VPC.VPC

Return Value

Property

Type

Description

refName

string

NAT Instance Name

refID

string

ID of NAT Instance

Blueprint Example

tosca_definitions_version: huaweicloud_tosca_version_1_0
node_templates:
  nat:
    type: HuaweiCloud.NAT.Instance
    properties:
      subnetId:
        get_input: nat_subnetId
      flavor: small
      vpcId:
        get_input: nat_vpcId
      name:
        get_input: nat_name
  snatrule:
    type: HuaweiCloud.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