Skip to main content
Version: v1.2

Alibaba Cloud NETWORK-WITH-NAT

Description

Build VPC and Nat gateway network environment and bind EIP, add SNAT and DNAT entries on AliCloud based on Terraform module

Specification

Properties

NameDescriptionTypeRequiredDefault
availability_zonesList available zones to launch several VSwitches.list(string)false
bandwidth_package_nameThe name of the common bandwidth package.stringfalse
cbp_bandwidthThe bandwidth of the common bandwidth package, in Mbps.numberfalse
cbp_internet_charge_typeThe billing method of the common bandwidth package. Valid values are 'PayByBandwidth' and 'PayBy95' and 'PayByTraffic'. 'PayBy95' is pay by classic 95th percentile pricing. International Account doesn't supports 'PayByBandwidth' and 'PayBy95'. Default to 'PayByTraffic'.stringfalse
cbp_ratioRatio of the common bandwidth package.numberfalse
computed_snat_with_source_cidrList of computed snat entries to create by cidr blocks. Each item valid keys: 'source_cidr'(required), 'snat_ip'(if not, use root parameter 'snat_ips', using comma joinor to set multi ips), 'name'(if not, will return one automatically).list(map(string))false
computed_snat_with_vswitch_idList of computed snat entries to create by vswitch ids. Each item valid keys: 'vswitch_id'(required), 'snat_ip'(if not, use root parameter 'snat_ips', using comma joinor to set multi ips), 'name'(if not, will return one automatically).list(map(string))false
create_dnatWhether to create dnat entries. If true, the 'entries' should be set.boolfalse
create_eipWhether to create new EIP and bind it to this Nat gateway. If true, the 'number_of_dnat_eip' or 'number_of_snat_eip' should not be empty.boolfalse
create_natWhether to create nat gateway.boolfalse
create_snatWhether to create snat entries. If true, the 'snat_with_source_cidrs' or 'snat_with_vswitch_ids' or 'snat_with_instance_ids' should be set.boolfalse
create_vpcWhether to create vpc. If false, you can specify an existing vpc by setting 'existing_vpc_id'.boolfalse
dnat_eip_association_instance_idThe ID of the ECS or SLB instance or Nat Gateway or NetworkInterface or HaVip.stringfalse
dnat_entriesA list of entries to create. Each item valid keys: 'name'(default to a string with prefix 'tf-dnat-entry' and numerical suffix), 'ip_protocol'(default to 'any'), 'external_ip'(if not, use root parameter 'external_ip'), 'external_port'(default to 'any'), 'internal_ip'(required), 'internal_port'(default to the 'external_port').list(map(string))false
dnat_external_ipThe public ip address to use on all dnat entries.stringfalse
dnat_table_idThe value can get from alicloud_nat_gateway Attributes 'forward_table_ids'.stringfalse
eip_bandwidthMaximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second).numberfalse
eip_instance_charge_typeElastic IP instance charge type.stringfalse
eip_internet_charge_typeInternet charge type of the EIP, Valid values are 'PayByBandwidth', 'PayByTraffic'.stringfalse
eip_ispThe line type of the Elastic IP instance.stringfalse
eip_nameName to be used on all eip as prefix. Default to 'TF-EIP-for-Nat'. The final default name would be TF-EIP-for-Nat001, TF-EIP-for-Nat002 and so on.stringfalse
eip_periodThe duration that you will buy the EIP, in month.numberfalse
eip_tagsA mapping of tags to assign to the EIP instance resource.map(string)false
existing_vpc_idThe vpc id used to launch several vswitches.stringfalse
internet_charge_typeThe internet charge type.stringfalse
nat_descriptionThe description of nat gateway.stringfalse
nat_instance_charge_type(Deprecated from version 1.2.0) The charge type of the nat gateway. Choices are 'PostPaid' and 'PrePaid'.stringfalse
nat_nameName of a new nat gateway.stringfalse
nat_periodThe charge duration of the PrePaid nat gateway, in month.numberfalse
nat_specificationThe specification of nat gateway.stringfalse
nat_typeThe type of NAT gateway.stringfalse
number_of_dnat_eipNumber of EIP instance used to bind with this Dnat.numberfalse
number_of_snat_eipNumber of EIP instance used to bind with this Snat.numberfalse
payment_typeThe billing method of the NAT gateway.stringfalse
profile(Deprecated from version 1.1.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable.stringfalse
region(Deprecated from version 1.1.0) The region used to launch this module resources.stringfalse
shared_credentials_file(Deprecated from version 1.1.0) This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used.stringfalse
skip_region_validation(Deprecated from version 1.1.0) Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet).boolfalse
snat_ipsThe public ip addresses to use on all snat entries.list(string)false
snat_with_instance_idsList of snat entries to create by ecs instance ids. Each item valid keys: 'instance_ids'(required, using comma joinor to set multi instance ids), 'snat_ip'(if not, use root parameter 'snat_ips', using comma joinor to set multi ips), 'name'(if not, will return one automatically).list(map(string))false
snat_with_source_cidrsList of snat entries to create by cidr blocks. Each item valid keys: 'source_cidrs'(required, using comma joinor to set multi cidrs), 'snat_ip'(if not, use root parameter 'snat_ips', using comma joinor to set multi ips), 'name'(if not, will return one automatically).list(map(string))false
snat_with_vswitch_idsList of snat entries to create by vswitch ids. Each item valid keys: 'vswitch_ids'(required, using comma joinor to set multi vswitch ids), 'snat_ip'(if not, use root parameter 'snat_ips', using comma joinor to set multi ips), 'name'(if not, will return one automatically).list(map(string))false
tagsThe common tags will apply to all of resources.map(string)false
use_existing_vpcThe vpc id used to launch several vswitches. If set, the 'create_vpc' will be ignored.boolfalse
use_num_suffixAlways append numerical suffix(like 001, 002 and so on) to vswitch name, even if the length of vswitch_cidrs is 1boolfalse
vpc_cidrThe cidr block used to launch a new vpc.stringfalse
vpc_descriptionThe vpc description used to launch a new vpc.stringfalse
vpc_nameThe vpc name used to launch a new vpc.stringfalse
vpc_tagsThe tags used to launch a new vpc.map(string)false
vswitch_cidrsList of cidr blocks used to launch several new vswitches. If not set, there is no new vswitches will be created.list(string)false
vswitch_descriptionThe vswitch description used to launch several new vswitch.stringfalse
vswitch_idID of the vswitch where to create nat gateway.stringfalse
vswitch_idsA list of virtual switch IDs to launch in.list(string)false
vswitch_nameThe vswitch name prefix used to launch several new vswitches.stringfalse
vswitch_tagsThe tags used to launch serveral vswitches.map(string)false
writeConnectionSecretToRefThe secret which the cloud resource connection will be written towriteConnectionSecretToReffalse

writeConnectionSecretToRef

NameDescriptionTypeRequiredDefault
nameThe secret name which the cloud resource connection will be written tostringtrue
namespaceThe secret namespace which the cloud resource connection will be written tostringfalse