Aviatrix v0.0.11, Jun 17 23

Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixSpokeGateway

Explore with Pulumi AI

Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

astipkovits/pulumi-aviatrix

Import

spoke_gateway can be imported using the gw_name, e.g. ****

 $ pulumi import aviatrix:index/aviatrixSpokeGateway:AviatrixSpokeGateway test gw_name

Create AviatrixSpokeGateway Resource

new AviatrixSpokeGateway(name: string, args: AviatrixSpokeGatewayArgs, opts?: CustomResourceOptions);

@overload
def AviatrixSpokeGateway(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         account_name: Optional[str] = None,
                         allocate_new_eip: Optional[bool] = None,
                         approved_learned_cidrs: Optional[Sequence[str]] = None,
                         availability_domain: Optional[str] = None,
                         azure_eip_name_resource_group: Optional[str] = None,
                         bgp_ecmp: Optional[bool] = None,
                         bgp_hold_time: Optional[int] = None,
                         bgp_polling_time: Optional[int] = None,
                         cloud_type: Optional[int] = None,
                         customer_managed_keys: Optional[str] = None,
                         customized_spoke_vpc_routes: Optional[str] = None,
                         disable_route_propagation: Optional[bool] = None,
                         eip: Optional[str] = None,
                         enable_active_standby: Optional[bool] = None,
                         enable_active_standby_preemptive: Optional[bool] = None,
                         enable_auto_advertise_s2c_cidrs: Optional[bool] = None,
                         enable_bgp: Optional[bool] = None,
                         enable_encrypt_volume: Optional[bool] = None,
                         enable_jumbo_frame: Optional[bool] = None,
                         enable_learned_cidrs_approval: Optional[bool] = None,
                         enable_monitor_gateway_subnets: Optional[bool] = None,
                         enable_preserve_as_path: Optional[bool] = None,
                         enable_private_oob: Optional[bool] = None,
                         enable_private_vpc_default_route: Optional[bool] = None,
                         enable_skip_public_route_table_update: Optional[bool] = None,
                         enable_spot_instance: Optional[bool] = None,
                         enable_vpc_dns_server: Optional[bool] = None,
                         fault_domain: Optional[str] = None,
                         filtered_spoke_vpc_routes: Optional[str] = None,
                         gw_name: Optional[str] = None,
                         gw_size: Optional[str] = None,
                         ha_availability_domain: Optional[str] = None,
                         ha_azure_eip_name_resource_group: Optional[str] = None,
                         ha_eip: Optional[str] = None,
                         ha_fault_domain: Optional[str] = None,
                         ha_gw_size: Optional[str] = None,
                         ha_image_version: Optional[str] = None,
                         ha_insane_mode_az: Optional[str] = None,
                         ha_oob_availability_zone: Optional[str] = None,
                         ha_oob_management_subnet: Optional[str] = None,
                         ha_private_mode_subnet_zone: Optional[str] = None,
                         ha_software_version: Optional[str] = None,
                         ha_subnet: Optional[str] = None,
                         ha_zone: Optional[str] = None,
                         image_version: Optional[str] = None,
                         included_advertised_spoke_routes: Optional[str] = None,
                         insane_mode: Optional[bool] = None,
                         insane_mode_az: Optional[str] = None,
                         learned_cidrs_approval_mode: Optional[str] = None,
                         local_as_number: Optional[str] = None,
                         manage_transit_gateway_attachment: Optional[bool] = None,
                         monitor_exclude_lists: Optional[Sequence[str]] = None,
                         oob_availability_zone: Optional[str] = None,
                         oob_management_subnet: Optional[str] = None,
                         prepend_as_paths: Optional[Sequence[str]] = None,
                         private_mode_lb_vpc_id: Optional[str] = None,
                         private_mode_subnet_zone: Optional[str] = None,
                         rx_queue_size: Optional[str] = None,
                         single_az_ha: Optional[bool] = None,
                         single_ip_snat: Optional[bool] = None,
                         software_version: Optional[str] = None,
                         spoke_bgp_manual_advertise_cidrs: Optional[Sequence[str]] = None,
                         spot_price: Optional[str] = None,
                         subnet: Optional[str] = None,
                         tag_lists: Optional[Sequence[str]] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         transit_gw: Optional[str] = None,
                         tunnel_detection_time: Optional[int] = None,
                         vpc_id: Optional[str] = None,
                         vpc_reg: Optional[str] = None,
                         zone: Optional[str] = None)
@overload
def AviatrixSpokeGateway(resource_name: str,
                         args: AviatrixSpokeGatewayArgs,
                         opts: Optional[ResourceOptions] = None)

func NewAviatrixSpokeGateway(ctx *Context, name string, args AviatrixSpokeGatewayArgs, opts ...ResourceOption) (*AviatrixSpokeGateway, error)

public AviatrixSpokeGateway(string name, AviatrixSpokeGatewayArgs args, CustomResourceOptions? opts = null)

public AviatrixSpokeGateway(String name, AviatrixSpokeGatewayArgs args)
public AviatrixSpokeGateway(String name, AviatrixSpokeGatewayArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixSpokeGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AviatrixSpokeGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AviatrixSpokeGatewayArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AviatrixSpokeGatewayArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AviatrixSpokeGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AviatrixSpokeGatewayArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AviatrixSpokeGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AviatrixSpokeGateway resource accepts the following input properties:

AccountName string

This parameter represents the name of a Cloud-Account in Aviatrix controller.

CloudType int

Type of cloud service provider, requires an integer value. Currently, only AWS(1), GCP(4), Azure(8), OCI(16), AzureGov(32), AWSGov(256), AWSChina(1024), AzureChina(2048), Alibaba Cloud(8192), AWS Top Secret(16384) and AWS Secret (32768) are supported.

GwName string

Name of the gateway which is going to be created.

GwSize string

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

Subnet string

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

VpcId string

VPC-ID/VNet-Name of cloud provider. Example: AWS/AWSGov/AWSChina: "vpc-abcd1234", GCP: "vpc-gcp-test~-~project-id", Azure/AzureGov/AzureChina: "vnet_name:rg_name:resource_guid", OCI: "ocid1.vcn.oc1.iad.aaaaaaaaba3pv6wkcr4jqae5f44n2b2m2yt2j6rx32uzr4h25vqstifsfdsq".

VpcReg string

Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west2-a", Azure: "East US 2", OCI: "us-ashburn-1", AzureGov: "USGov Arizona", AWSGov: "us-gov-west-1, AWSChina: "cn-north-1", AzureChina: "China North", AWS Top Secret: "us-iso-east-1", AWS Secret: "us-isob-east-1".

AllocateNewEip bool

When value is false, reuse an idle address in Elastic IP pool for this gateway. Otherwise, allocate a new Elastic IP and use it for this gateway. Available in Controller 4.7+. Valid values: true, false. Default: true.

ApprovedLearnedCidrs List<string>

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

AvailabilityDomain string

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

AzureEipNameResourceGroup string

Name of public IP Address resource and its resource group in Azure to be assigned to the Spoke Gateway instance. Example: "IP_Name:Resource_Group_Name". Required if allocate_new_eip is false and cloud_type is Azure, AzureGov or AzureChina. Available as of provider version 2.20+.

BgpEcmp bool

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

BgpHoldTime int

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

BgpPollingTime int

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

CustomerManagedKeys string

Customer managed key ID.

CustomizedSpokeVpcRoutes string

A list of comma separated CIDRs to be customized for the spoke VPC routes. When configured, it will replace all learned routes in VPC routing tables, including RFC1918 and non-RFC1918 CIDRs. It applies to this spoke gateway only. Example: "10.0.0.0/116,10.2.0.0/16".

DisableRoutePropagation bool

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

Eip string

Required when allocate_new_eip is false. It uses the specified EIP for this gateway. Available in Controller 4.7+. Only available for AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina, AWS Top Secret and AWS Secret.

EnableActiveStandby bool

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

EnableActiveStandbyPreemptive bool

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

EnableAutoAdvertiseS2cCidrs bool

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableBgp bool

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

EnableEncryptVolume bool

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

EnableJumboFrame bool

Enable jumbo frames for this spoke gateway. Default value is true.

EnableLearnedCidrsApproval bool

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

EnableMonitorGatewaySubnets bool

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

EnablePreserveAsPath bool

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

EnablePrivateOob bool

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

EnablePrivateVpcDefaultRoute bool

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableSkipPublicRouteTableUpdate bool

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableSpotInstance bool

Enable spot instance. NOT supported for production deployment.

EnableVpcDnsServer bool

Enable VPC DNS Server for Gateway. Currently only supported for AWS, Azure, AzureGov, AWSGov, AWSChina, AzureChina, Alibaba Cloud, AWS Top Secret and AWS Secret gateways. Valid values: true, false. Default value: false.

FaultDomain string

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

FilteredSpokeVpcRoutes string

A list of comma separated CIDRs to be filtered from the spoke VPC route table. When configured, filtering CIDR(s) or it’s subnet will be deleted from VPC routing tables as well as from spoke gateway’s routing table. It applies to this spoke gateway only. Example: "10.2.0.0/116,10.3.0.0/16".

HaAvailabilityDomain string

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

HaAzureEipNameResourceGroup string

Name of public IP Address resource and its resource group in Azure to be assigned to the HA Spoke Gateway instance. Example: "IP_Name:Resource_Group_Name". Required if ha_eip is set and cloud_type is Azure, AzureGov or AzureChina. Available as of provider version 2.20+.

HaEip string

Public IP address that you want to assign to the HA peering instance. If no value is given, a new EIP will automatically be allocated. Only available for AWS, GCP, Azure, OCI, AzureGov, AWSGov, AWSChina, AzureChina, AWS Top Secret and AWS Secret.

HaFaultDomain string

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

HaGwSize string

HA Gateway Size. Mandatory if enabling HA.

HaImageVersion string

The image version of the HA gateway. Use aviatrix.getAviatrixGatewayImage data source to programmatically retrieve this value for the desired ha_software_version. If set, we will attempt to update the HA gateway to the specified version if current version is different. If left blank, the gateway upgrades can be managed with the aviatrix.AviatrixControllerConfig resource. Type: String. Example: "hvm-cloudx-aws-022021". Available as of provider version R2.20.0.

HaInsaneModeAz string

AZ of subnet being created for Insane Mode Spoke HA Gateway. Required for AWS, AzureGov, AWSGov, AWS Top Secret and AWS Secret if insane_mode is enabled and ha_subnet is set. Example: AWS: "us-west-1a".

HaOobAvailabilityZone string

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

HaOobManagementSubnet string

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

HaPrivateModeSubnetZone string

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

HaSoftwareVersion string

The software version of the HA gateway. If set, we will attempt to update the HA gateway to the specified version if current version is different. If left blank, the HA gateway upgrade can be managed with the aviatrix.AviatrixControllerConfig resource. Type: String. Example: "6.5.821". Available as of provider version R2.20.0.

HaSubnet string

HA Subnet. Required if enabling HA for AWS, AWSGov, AWSChina, Azure, AzureGov, AzureChina, OCI, Alibaba Cloud, AWS Top Secret or AWS Secret gateways. Optional for GCP. Setting to empty/unsetting will disable HA. Setting to a valid subnet CIDR will create an HA gateway on the subnet. Example: "10.12.0.0/24"

HaZone string

HA Zone. Required if enabling HA for GCP gateway. Optional for Azure. For GCP, setting to empty/unsetting will disable HA and setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c". For Azure, this is an optional parameter to place the HA gateway in a specific availability zone. Valid values for Azure gateways are in the form "az-n". Example: "az-2". Available for Azure as of provider version R2.17+.

ImageVersion string

The image version of the gateway. Use aviatrix.getAviatrixGatewayImage data source to programmatically retrieve this value for the desired software_version. If set, we will attempt to update the gateway to the specified version if current version is different. If left blank, the gateway upgrades can be managed with the aviatrix.AviatrixControllerConfig resource. Type: String. Example: "hvm-cloudx-aws-022021". Available as of provider version R2.20.0.

IncludedAdvertisedSpokeRoutes string

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

InsaneMode bool

Enable Insane Mode for Spoke Gateway. Insane Mode gateway size must be at least c5 size (AWS, AWSGov, AWS China, AWS Top Secret and AWS Secret) or Standard_D3_v2 (Azure and AzureGov); for GCP only four size are supported: "n1-highcpu-4", "n1-highcpu-8", "n1-highcpu-16" and "n1-highcpu-32". If enabled, you must specify a valid /26 CIDR segment of the VPC to create a new subnet for AWS, Azure, AzureGov, AWSGov, AWS Top Secret and AWS Secret. Only available for AWS, GCP/OCI, Azure, AzureGov, AzureChina, AWSGov, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

InsaneModeAz string

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

LearnedCidrsApprovalMode string

Learned CIDRs approval mode. Either "gateway" (approval on a per-gateway basis) or "connection" (approval on a per-connection basis). Only "gateway" is supported for BGP SPOKE Gateway. Default value: "gateway". Available as of provider version R2.21+.

LocalAsNumber string

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

ManageTransitGatewayAttachment bool

Enable to manage spoke-to-Aviatrix transit gateway attachments using the aviatrix_spoke_gateway resource with the below transit_gw attribute. If this is set to false, attaching this spoke to transit gateways must be done using the aviatrix_spoke_transit_attachment resource. Valid values: true, false. Default value: true. Available in provider R2.17+.

MonitorExcludeLists List<string>

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

OobAvailabilityZone string

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

OobManagementSubnet string

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

PrependAsPaths List<string>

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

PrivateModeLbVpcId string

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

PrivateModeSubnetZone string

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

RxQueueSize string

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

SingleAzHa bool

Set to true if this feature is desired. Valid values: true, false.

SingleIpSnat bool

Specify whether to enable Source NAT feature in "single_ip" mode on the gateway or not. Please disable AWS NAT instance before enabling this feature. Currently only supports AWS(1) and Azure(8). Valid values: true, false.

SoftwareVersion string

The software version of the gateway. If set, we will attempt to update the gateway to the specified version if current version is different. If left blank, the gateway upgrade can be managed with the aviatrix.AviatrixControllerConfig resource. Type: String. Example: "6.5.821". Available as of provider version R2.20.0.

SpokeBgpManualAdvertiseCidrs List<string>

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

SpotPrice string

Price for spot instance. NOT supported for production deployment.

TagLists List<string>

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

Tags Dictionary<string, string>

Map of tags to assign to the gateway. Only available for AWS, Azure, AzureGov, AWSGov, AWSChina, AzureChina, AWS Top Secret and AWS Secret gateways. Allowed characters vary by cloud type but always include: letters, spaces, and numbers. AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret allow the use of any character. Azure, AzureGov and AzureChina allows the following special characters: + - = . _ : @. Example: {"key1" = "value1", "key2" = "value2"}.

TransitGw string

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

TunnelDetectionTime int

The IPSec tunnel down detection time for the Spoke Gateway.

Zone string

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

AccountName string

This parameter represents the name of a Cloud-Account in Aviatrix controller.

CloudType int

GwName string

Name of the gateway which is going to be created.

GwSize string

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

Subnet string

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

VpcId string

VpcReg string

AllocateNewEip bool

ApprovedLearnedCidrs []string

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

AvailabilityDomain string

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

AzureEipNameResourceGroup string

BgpEcmp bool

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

BgpHoldTime int

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

BgpPollingTime int

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

CustomerManagedKeys string

Customer managed key ID.

CustomizedSpokeVpcRoutes string

DisableRoutePropagation bool

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

Eip string

EnableActiveStandby bool

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

EnableActiveStandbyPreemptive bool

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

EnableAutoAdvertiseS2cCidrs bool

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableBgp bool

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

EnableEncryptVolume bool

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

EnableJumboFrame bool

Enable jumbo frames for this spoke gateway. Default value is true.

EnableLearnedCidrsApproval bool

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

EnableMonitorGatewaySubnets bool

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

EnablePreserveAsPath bool

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

EnablePrivateOob bool

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

EnablePrivateVpcDefaultRoute bool

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableSkipPublicRouteTableUpdate bool

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableSpotInstance bool

Enable spot instance. NOT supported for production deployment.

EnableVpcDnsServer bool

FaultDomain string

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

FilteredSpokeVpcRoutes string

HaAvailabilityDomain string

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

HaAzureEipNameResourceGroup string

HaEip string

HaFaultDomain string

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

HaGwSize string

HA Gateway Size. Mandatory if enabling HA.

HaImageVersion string

HaInsaneModeAz string

HaOobAvailabilityZone string

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

HaOobManagementSubnet string

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

HaPrivateModeSubnetZone string

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

HaSoftwareVersion string

HaSubnet string

HaZone string

ImageVersion string

IncludedAdvertisedSpokeRoutes string

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

InsaneMode bool

InsaneModeAz string

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

LearnedCidrsApprovalMode string

LocalAsNumber string

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

ManageTransitGatewayAttachment bool

MonitorExcludeLists []string

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

OobAvailabilityZone string

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

OobManagementSubnet string

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

PrependAsPaths []string

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

PrivateModeLbVpcId string

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

PrivateModeSubnetZone string

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

RxQueueSize string

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

SingleAzHa bool

Set to true if this feature is desired. Valid values: true, false.

SingleIpSnat bool

SoftwareVersion string

SpokeBgpManualAdvertiseCidrs []string

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

SpotPrice string

Price for spot instance. NOT supported for production deployment.

TagLists []string

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

Tags map[string]string

TransitGw string

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

TunnelDetectionTime int

The IPSec tunnel down detection time for the Spoke Gateway.

Zone string

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

accountName String

This parameter represents the name of a Cloud-Account in Aviatrix controller.

cloudType Integer

gwName String

Name of the gateway which is going to be created.

gwSize String

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

subnet String

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

vpcId String

vpcReg String

allocateNewEip Boolean

approvedLearnedCidrs List<String>

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

availabilityDomain String

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

azureEipNameResourceGroup String

bgpEcmp Boolean

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

bgpHoldTime Integer

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

bgpPollingTime Integer

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

customerManagedKeys String

Customer managed key ID.

customizedSpokeVpcRoutes String

disableRoutePropagation Boolean

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

eip String

enableActiveStandby Boolean

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

enableActiveStandbyPreemptive Boolean

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

enableAutoAdvertiseS2cCidrs Boolean

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableBgp Boolean

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

enableEncryptVolume Boolean

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

enableJumboFrame Boolean

Enable jumbo frames for this spoke gateway. Default value is true.

enableLearnedCidrsApproval Boolean

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

enableMonitorGatewaySubnets Boolean

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

enablePreserveAsPath Boolean

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

enablePrivateOob Boolean

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

enablePrivateVpcDefaultRoute Boolean

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSkipPublicRouteTableUpdate Boolean

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSpotInstance Boolean

Enable spot instance. NOT supported for production deployment.

enableVpcDnsServer Boolean

faultDomain String

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

filteredSpokeVpcRoutes String

haAvailabilityDomain String

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haAzureEipNameResourceGroup String

haEip String

haFaultDomain String

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haGwSize String

HA Gateway Size. Mandatory if enabling HA.

haImageVersion String

haInsaneModeAz String

haOobAvailabilityZone String

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

haOobManagementSubnet String

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

haPrivateModeSubnetZone String

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

haSoftwareVersion String

haSubnet String

haZone String

imageVersion String

includedAdvertisedSpokeRoutes String

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

insaneMode Boolean

insaneModeAz String

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

learnedCidrsApprovalMode String

localAsNumber String

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

manageTransitGatewayAttachment Boolean

monitorExcludeLists List<String>

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

oobAvailabilityZone String

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

oobManagementSubnet String

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

prependAsPaths List<String>

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

privateModeLbVpcId String

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

privateModeSubnetZone String

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

rxQueueSize String

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

singleAzHa Boolean

Set to true if this feature is desired. Valid values: true, false.

singleIpSnat Boolean

softwareVersion String

spokeBgpManualAdvertiseCidrs List<String>

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

spotPrice String

Price for spot instance. NOT supported for production deployment.

tagLists List<String>

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

tags Map<String,String>

transitGw String

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

tunnelDetectionTime Integer

The IPSec tunnel down detection time for the Spoke Gateway.

zone String

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

accountName string

This parameter represents the name of a Cloud-Account in Aviatrix controller.

cloudType number

gwName string

Name of the gateway which is going to be created.

gwSize string

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

subnet string

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

vpcId string

vpcReg string

allocateNewEip boolean

approvedLearnedCidrs string[]

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

availabilityDomain string

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

azureEipNameResourceGroup string

bgpEcmp boolean

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

bgpHoldTime number

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

bgpPollingTime number

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

customerManagedKeys string

Customer managed key ID.

customizedSpokeVpcRoutes string

disableRoutePropagation boolean

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

eip string

enableActiveStandby boolean

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

enableActiveStandbyPreemptive boolean

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

enableAutoAdvertiseS2cCidrs boolean

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableBgp boolean

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

enableEncryptVolume boolean

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

enableJumboFrame boolean

Enable jumbo frames for this spoke gateway. Default value is true.

enableLearnedCidrsApproval boolean

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

enableMonitorGatewaySubnets boolean

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

enablePreserveAsPath boolean

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

enablePrivateOob boolean

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

enablePrivateVpcDefaultRoute boolean

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSkipPublicRouteTableUpdate boolean

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSpotInstance boolean

Enable spot instance. NOT supported for production deployment.

enableVpcDnsServer boolean

faultDomain string

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

filteredSpokeVpcRoutes string

haAvailabilityDomain string

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haAzureEipNameResourceGroup string

haEip string

haFaultDomain string

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haGwSize string

HA Gateway Size. Mandatory if enabling HA.

haImageVersion string

haInsaneModeAz string

haOobAvailabilityZone string

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

haOobManagementSubnet string

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

haPrivateModeSubnetZone string

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

haSoftwareVersion string

haSubnet string

haZone string

imageVersion string

includedAdvertisedSpokeRoutes string

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

insaneMode boolean

insaneModeAz string

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

learnedCidrsApprovalMode string

localAsNumber string

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

manageTransitGatewayAttachment boolean

monitorExcludeLists string[]

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

oobAvailabilityZone string

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

oobManagementSubnet string

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

prependAsPaths string[]

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

privateModeLbVpcId string

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

privateModeSubnetZone string

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

rxQueueSize string

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

singleAzHa boolean

Set to true if this feature is desired. Valid values: true, false.

singleIpSnat boolean

softwareVersion string

spokeBgpManualAdvertiseCidrs string[]

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

spotPrice string

Price for spot instance. NOT supported for production deployment.

tagLists string[]

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

tags {[key: string]: string}

transitGw string

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

tunnelDetectionTime number

The IPSec tunnel down detection time for the Spoke Gateway.

zone string

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

account_name str

This parameter represents the name of a Cloud-Account in Aviatrix controller.

cloud_type int

gw_name str

Name of the gateway which is going to be created.

gw_size str

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

subnet str

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

vpc_id str

vpc_reg str

allocate_new_eip bool

approved_learned_cidrs Sequence[str]

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

availability_domain str

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

azure_eip_name_resource_group str

bgp_ecmp bool

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

bgp_hold_time int

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

bgp_polling_time int

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

customer_managed_keys str

Customer managed key ID.

customized_spoke_vpc_routes str

disable_route_propagation bool

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

eip str

enable_active_standby bool

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

enable_active_standby_preemptive bool

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

enable_auto_advertise_s2c_cidrs bool

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enable_bgp bool

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

enable_encrypt_volume bool

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

enable_jumbo_frame bool

Enable jumbo frames for this spoke gateway. Default value is true.

enable_learned_cidrs_approval bool

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

enable_monitor_gateway_subnets bool

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

enable_preserve_as_path bool

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

enable_private_oob bool

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

enable_private_vpc_default_route bool

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enable_skip_public_route_table_update bool

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enable_spot_instance bool

Enable spot instance. NOT supported for production deployment.

enable_vpc_dns_server bool

fault_domain str

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

filtered_spoke_vpc_routes str

ha_availability_domain str

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

ha_azure_eip_name_resource_group str

ha_eip str

ha_fault_domain str

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

ha_gw_size str

HA Gateway Size. Mandatory if enabling HA.

ha_image_version str

ha_insane_mode_az str

ha_oob_availability_zone str

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

ha_oob_management_subnet str

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

ha_private_mode_subnet_zone str

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

ha_software_version str

ha_subnet str

ha_zone str

image_version str

included_advertised_spoke_routes str

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

insane_mode bool

insane_mode_az str

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

learned_cidrs_approval_mode str

local_as_number str

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

manage_transit_gateway_attachment bool

monitor_exclude_lists Sequence[str]

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

oob_availability_zone str

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

oob_management_subnet str

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

prepend_as_paths Sequence[str]

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

private_mode_lb_vpc_id str

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

private_mode_subnet_zone str

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

rx_queue_size str

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

single_az_ha bool

Set to true if this feature is desired. Valid values: true, false.

single_ip_snat bool

software_version str

spoke_bgp_manual_advertise_cidrs Sequence[str]

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

spot_price str

Price for spot instance. NOT supported for production deployment.

tag_lists Sequence[str]

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

tags Mapping[str, str]

transit_gw str

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

tunnel_detection_time int

The IPSec tunnel down detection time for the Spoke Gateway.

zone str

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

accountName String

This parameter represents the name of a Cloud-Account in Aviatrix controller.

cloudType Number

gwName String

Name of the gateway which is going to be created.

gwSize String

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

subnet String

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

vpcId String

vpcReg String

allocateNewEip Boolean

approvedLearnedCidrs List<String>

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

availabilityDomain String

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

azureEipNameResourceGroup String

bgpEcmp Boolean

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

bgpHoldTime Number

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

bgpPollingTime Number

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

customerManagedKeys String

Customer managed key ID.

customizedSpokeVpcRoutes String

disableRoutePropagation Boolean

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

eip String

enableActiveStandby Boolean

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

enableActiveStandbyPreemptive Boolean

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

enableAutoAdvertiseS2cCidrs Boolean

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableBgp Boolean

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

enableEncryptVolume Boolean

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

enableJumboFrame Boolean

Enable jumbo frames for this spoke gateway. Default value is true.

enableLearnedCidrsApproval Boolean

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

enableMonitorGatewaySubnets Boolean

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

enablePreserveAsPath Boolean

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

enablePrivateOob Boolean

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

enablePrivateVpcDefaultRoute Boolean

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSkipPublicRouteTableUpdate Boolean

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSpotInstance Boolean

Enable spot instance. NOT supported for production deployment.

enableVpcDnsServer Boolean

faultDomain String

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

filteredSpokeVpcRoutes String

haAvailabilityDomain String

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haAzureEipNameResourceGroup String

haEip String

haFaultDomain String

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haGwSize String

HA Gateway Size. Mandatory if enabling HA.

haImageVersion String

haInsaneModeAz String

haOobAvailabilityZone String

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

haOobManagementSubnet String

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

haPrivateModeSubnetZone String

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

haSoftwareVersion String

haSubnet String

haZone String

imageVersion String

includedAdvertisedSpokeRoutes String

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

insaneMode Boolean

insaneModeAz String

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

learnedCidrsApprovalMode String

localAsNumber String

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

manageTransitGatewayAttachment Boolean

monitorExcludeLists List<String>

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

oobAvailabilityZone String

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

oobManagementSubnet String

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

prependAsPaths List<String>

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

privateModeLbVpcId String

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

privateModeSubnetZone String

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

rxQueueSize String

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

singleAzHa Boolean

Set to true if this feature is desired. Valid values: true, false.

singleIpSnat Boolean

softwareVersion String

spokeBgpManualAdvertiseCidrs List<String>

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

spotPrice String

Price for spot instance. NOT supported for production deployment.

tagLists List<String>

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

tags Map<String>

transitGw String

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

tunnelDetectionTime Number

The IPSec tunnel down detection time for the Spoke Gateway.

zone String

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

Outputs

All input properties are implicitly available as output properties. Additionally, the AviatrixSpokeGateway resource produces the following output properties:

CloudInstanceId string: Cloud instance ID of the spoke gateway.
HaCloudInstanceId string: Cloud instance ID of the HA spoke gateway.
HaGwName string: Aviatrix spoke gateway unique name of HA spoke gateway.
HaPrivateIp string: Private IP address of HA spoke gateway.
HaPublicIp string: Public IP address of the HA Spoke Gateway.
HaSecurityGroupId string: HA security group used for the spoke gateway.
Id string: The provider-assigned unique ID for this managed resource.
PrivateIp string: Private IP address of the spoke gateway created.
PublicIp string: Public IP address of the Spoke Gateway created.
SecurityGroupId string: Security group used for the spoke gateway.

CloudInstanceId string: Cloud instance ID of the spoke gateway.
HaCloudInstanceId string: Cloud instance ID of the HA spoke gateway.
HaGwName string: Aviatrix spoke gateway unique name of HA spoke gateway.
HaPrivateIp string: Private IP address of HA spoke gateway.
HaPublicIp string: Public IP address of the HA Spoke Gateway.
HaSecurityGroupId string: HA security group used for the spoke gateway.
Id string: The provider-assigned unique ID for this managed resource.
PrivateIp string: Private IP address of the spoke gateway created.
PublicIp string: Public IP address of the Spoke Gateway created.
SecurityGroupId string: Security group used for the spoke gateway.

cloudInstanceId String: Cloud instance ID of the spoke gateway.
haCloudInstanceId String: Cloud instance ID of the HA spoke gateway.
haGwName String: Aviatrix spoke gateway unique name of HA spoke gateway.
haPrivateIp String: Private IP address of HA spoke gateway.
haPublicIp String: Public IP address of the HA Spoke Gateway.
haSecurityGroupId String: HA security group used for the spoke gateway.
id String: The provider-assigned unique ID for this managed resource.
privateIp String: Private IP address of the spoke gateway created.
publicIp String: Public IP address of the Spoke Gateway created.
securityGroupId String: Security group used for the spoke gateway.

cloudInstanceId string: Cloud instance ID of the spoke gateway.
haCloudInstanceId string: Cloud instance ID of the HA spoke gateway.
haGwName string: Aviatrix spoke gateway unique name of HA spoke gateway.
haPrivateIp string: Private IP address of HA spoke gateway.
haPublicIp string: Public IP address of the HA Spoke Gateway.
haSecurityGroupId string: HA security group used for the spoke gateway.
id string: The provider-assigned unique ID for this managed resource.
privateIp string: Private IP address of the spoke gateway created.
publicIp string: Public IP address of the Spoke Gateway created.
securityGroupId string: Security group used for the spoke gateway.

cloud_instance_id str: Cloud instance ID of the spoke gateway.
ha_cloud_instance_id str: Cloud instance ID of the HA spoke gateway.
ha_gw_name str: Aviatrix spoke gateway unique name of HA spoke gateway.
ha_private_ip str: Private IP address of HA spoke gateway.
ha_public_ip str: Public IP address of the HA Spoke Gateway.
ha_security_group_id str: HA security group used for the spoke gateway.
id str: The provider-assigned unique ID for this managed resource.
private_ip str: Private IP address of the spoke gateway created.
public_ip str: Public IP address of the Spoke Gateway created.
security_group_id str: Security group used for the spoke gateway.

cloudInstanceId String: Cloud instance ID of the spoke gateway.
haCloudInstanceId String: Cloud instance ID of the HA spoke gateway.
haGwName String: Aviatrix spoke gateway unique name of HA spoke gateway.
haPrivateIp String: Private IP address of HA spoke gateway.
haPublicIp String: Public IP address of the HA Spoke Gateway.
haSecurityGroupId String: HA security group used for the spoke gateway.
id String: The provider-assigned unique ID for this managed resource.
privateIp String: Private IP address of the spoke gateway created.
publicIp String: Public IP address of the Spoke Gateway created.
securityGroupId String: Security group used for the spoke gateway.

Look up Existing AviatrixSpokeGateway Resource

Get an existing AviatrixSpokeGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AviatrixSpokeGatewayState, opts?: CustomResourceOptions): AviatrixSpokeGateway

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        allocate_new_eip: Optional[bool] = None,
        approved_learned_cidrs: Optional[Sequence[str]] = None,
        availability_domain: Optional[str] = None,
        azure_eip_name_resource_group: Optional[str] = None,
        bgp_ecmp: Optional[bool] = None,
        bgp_hold_time: Optional[int] = None,
        bgp_polling_time: Optional[int] = None,
        cloud_instance_id: Optional[str] = None,
        cloud_type: Optional[int] = None,
        customer_managed_keys: Optional[str] = None,
        customized_spoke_vpc_routes: Optional[str] = None,
        disable_route_propagation: Optional[bool] = None,
        eip: Optional[str] = None,
        enable_active_standby: Optional[bool] = None,
        enable_active_standby_preemptive: Optional[bool] = None,
        enable_auto_advertise_s2c_cidrs: Optional[bool] = None,
        enable_bgp: Optional[bool] = None,
        enable_encrypt_volume: Optional[bool] = None,
        enable_jumbo_frame: Optional[bool] = None,
        enable_learned_cidrs_approval: Optional[bool] = None,
        enable_monitor_gateway_subnets: Optional[bool] = None,
        enable_preserve_as_path: Optional[bool] = None,
        enable_private_oob: Optional[bool] = None,
        enable_private_vpc_default_route: Optional[bool] = None,
        enable_skip_public_route_table_update: Optional[bool] = None,
        enable_spot_instance: Optional[bool] = None,
        enable_vpc_dns_server: Optional[bool] = None,
        fault_domain: Optional[str] = None,
        filtered_spoke_vpc_routes: Optional[str] = None,
        gw_name: Optional[str] = None,
        gw_size: Optional[str] = None,
        ha_availability_domain: Optional[str] = None,
        ha_azure_eip_name_resource_group: Optional[str] = None,
        ha_cloud_instance_id: Optional[str] = None,
        ha_eip: Optional[str] = None,
        ha_fault_domain: Optional[str] = None,
        ha_gw_name: Optional[str] = None,
        ha_gw_size: Optional[str] = None,
        ha_image_version: Optional[str] = None,
        ha_insane_mode_az: Optional[str] = None,
        ha_oob_availability_zone: Optional[str] = None,
        ha_oob_management_subnet: Optional[str] = None,
        ha_private_ip: Optional[str] = None,
        ha_private_mode_subnet_zone: Optional[str] = None,
        ha_public_ip: Optional[str] = None,
        ha_security_group_id: Optional[str] = None,
        ha_software_version: Optional[str] = None,
        ha_subnet: Optional[str] = None,
        ha_zone: Optional[str] = None,
        image_version: Optional[str] = None,
        included_advertised_spoke_routes: Optional[str] = None,
        insane_mode: Optional[bool] = None,
        insane_mode_az: Optional[str] = None,
        learned_cidrs_approval_mode: Optional[str] = None,
        local_as_number: Optional[str] = None,
        manage_transit_gateway_attachment: Optional[bool] = None,
        monitor_exclude_lists: Optional[Sequence[str]] = None,
        oob_availability_zone: Optional[str] = None,
        oob_management_subnet: Optional[str] = None,
        prepend_as_paths: Optional[Sequence[str]] = None,
        private_ip: Optional[str] = None,
        private_mode_lb_vpc_id: Optional[str] = None,
        private_mode_subnet_zone: Optional[str] = None,
        public_ip: Optional[str] = None,
        rx_queue_size: Optional[str] = None,
        security_group_id: Optional[str] = None,
        single_az_ha: Optional[bool] = None,
        single_ip_snat: Optional[bool] = None,
        software_version: Optional[str] = None,
        spoke_bgp_manual_advertise_cidrs: Optional[Sequence[str]] = None,
        spot_price: Optional[str] = None,
        subnet: Optional[str] = None,
        tag_lists: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        transit_gw: Optional[str] = None,
        tunnel_detection_time: Optional[int] = None,
        vpc_id: Optional[str] = None,
        vpc_reg: Optional[str] = None,
        zone: Optional[str] = None) -> AviatrixSpokeGateway

func GetAviatrixSpokeGateway(ctx *Context, name string, id IDInput, state *AviatrixSpokeGatewayState, opts ...ResourceOption) (*AviatrixSpokeGateway, error)

public static AviatrixSpokeGateway Get(string name, Input<string> id, AviatrixSpokeGatewayState? state, CustomResourceOptions? opts = null)

public static AviatrixSpokeGateway get(String name, Output<String> id, AviatrixSpokeGatewayState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountName string

This parameter represents the name of a Cloud-Account in Aviatrix controller.

AllocateNewEip bool

ApprovedLearnedCidrs List<string>

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

AvailabilityDomain string

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

AzureEipNameResourceGroup string

BgpEcmp bool

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

BgpHoldTime int

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

BgpPollingTime int

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

CloudInstanceId string

Cloud instance ID of the spoke gateway.

CloudType int

CustomerManagedKeys string

Customer managed key ID.

CustomizedSpokeVpcRoutes string

DisableRoutePropagation bool

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

Eip string

EnableActiveStandby bool

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

EnableActiveStandbyPreemptive bool

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

EnableAutoAdvertiseS2cCidrs bool

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableBgp bool

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

EnableEncryptVolume bool

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

EnableJumboFrame bool

Enable jumbo frames for this spoke gateway. Default value is true.

EnableLearnedCidrsApproval bool

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

EnableMonitorGatewaySubnets bool

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

EnablePreserveAsPath bool

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

EnablePrivateOob bool

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

EnablePrivateVpcDefaultRoute bool

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableSkipPublicRouteTableUpdate bool

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableSpotInstance bool

Enable spot instance. NOT supported for production deployment.

EnableVpcDnsServer bool

FaultDomain string

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

FilteredSpokeVpcRoutes string

GwName string

Name of the gateway which is going to be created.

GwSize string

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

HaAvailabilityDomain string

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

HaAzureEipNameResourceGroup string

HaCloudInstanceId string

Cloud instance ID of the HA spoke gateway.

HaEip string

HaFaultDomain string

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

HaGwName string

Aviatrix spoke gateway unique name of HA spoke gateway.

HaGwSize string

HA Gateway Size. Mandatory if enabling HA.

HaImageVersion string

HaInsaneModeAz string

HaOobAvailabilityZone string

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

HaOobManagementSubnet string

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

HaPrivateIp string

Private IP address of HA spoke gateway.

HaPrivateModeSubnetZone string

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

HaPublicIp string

Public IP address of the HA Spoke Gateway.

HaSecurityGroupId string

HA security group used for the spoke gateway.

HaSoftwareVersion string

HaSubnet string

HaZone string

ImageVersion string

IncludedAdvertisedSpokeRoutes string

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

InsaneMode bool

InsaneModeAz string

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

LearnedCidrsApprovalMode string

LocalAsNumber string

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

ManageTransitGatewayAttachment bool

MonitorExcludeLists List<string>

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

OobAvailabilityZone string

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

OobManagementSubnet string

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

PrependAsPaths List<string>

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

PrivateIp string

Private IP address of the spoke gateway created.

PrivateModeLbVpcId string

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

PrivateModeSubnetZone string

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

PublicIp string

Public IP address of the Spoke Gateway created.

RxQueueSize string

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

SecurityGroupId string

Security group used for the spoke gateway.

SingleAzHa bool

Set to true if this feature is desired. Valid values: true, false.

SingleIpSnat bool

SoftwareVersion string

SpokeBgpManualAdvertiseCidrs List<string>

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

SpotPrice string

Price for spot instance. NOT supported for production deployment.

Subnet string

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

TagLists List<string>

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

Tags Dictionary<string, string>

TransitGw string

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

TunnelDetectionTime int

The IPSec tunnel down detection time for the Spoke Gateway.

VpcId string

VpcReg string

Zone string

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

AccountName string

This parameter represents the name of a Cloud-Account in Aviatrix controller.

AllocateNewEip bool

ApprovedLearnedCidrs []string

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

AvailabilityDomain string

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

AzureEipNameResourceGroup string

BgpEcmp bool

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

BgpHoldTime int

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

BgpPollingTime int

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

CloudInstanceId string

Cloud instance ID of the spoke gateway.

CloudType int

CustomerManagedKeys string

Customer managed key ID.

CustomizedSpokeVpcRoutes string

DisableRoutePropagation bool

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

Eip string

EnableActiveStandby bool

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

EnableActiveStandbyPreemptive bool

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

EnableAutoAdvertiseS2cCidrs bool

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableBgp bool

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

EnableEncryptVolume bool

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

EnableJumboFrame bool

Enable jumbo frames for this spoke gateway. Default value is true.

EnableLearnedCidrsApproval bool

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

EnableMonitorGatewaySubnets bool

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

EnablePreserveAsPath bool

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

EnablePrivateOob bool

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

EnablePrivateVpcDefaultRoute bool

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableSkipPublicRouteTableUpdate bool

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

EnableSpotInstance bool

Enable spot instance. NOT supported for production deployment.

EnableVpcDnsServer bool

FaultDomain string

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

FilteredSpokeVpcRoutes string

GwName string

Name of the gateway which is going to be created.

GwSize string

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

HaAvailabilityDomain string

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

HaAzureEipNameResourceGroup string

HaCloudInstanceId string

Cloud instance ID of the HA spoke gateway.

HaEip string

HaFaultDomain string

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

HaGwName string

Aviatrix spoke gateway unique name of HA spoke gateway.

HaGwSize string

HA Gateway Size. Mandatory if enabling HA.

HaImageVersion string

HaInsaneModeAz string

HaOobAvailabilityZone string

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

HaOobManagementSubnet string

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

HaPrivateIp string

Private IP address of HA spoke gateway.

HaPrivateModeSubnetZone string

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

HaPublicIp string

Public IP address of the HA Spoke Gateway.

HaSecurityGroupId string

HA security group used for the spoke gateway.

HaSoftwareVersion string

HaSubnet string

HaZone string

ImageVersion string

IncludedAdvertisedSpokeRoutes string

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

InsaneMode bool

InsaneModeAz string

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

LearnedCidrsApprovalMode string

LocalAsNumber string

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

ManageTransitGatewayAttachment bool

MonitorExcludeLists []string

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

OobAvailabilityZone string

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

OobManagementSubnet string

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

PrependAsPaths []string

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

PrivateIp string

Private IP address of the spoke gateway created.

PrivateModeLbVpcId string

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

PrivateModeSubnetZone string

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

PublicIp string

Public IP address of the Spoke Gateway created.

RxQueueSize string

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

SecurityGroupId string

Security group used for the spoke gateway.

SingleAzHa bool

Set to true if this feature is desired. Valid values: true, false.

SingleIpSnat bool

SoftwareVersion string

SpokeBgpManualAdvertiseCidrs []string

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

SpotPrice string

Price for spot instance. NOT supported for production deployment.

Subnet string

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

TagLists []string

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

Tags map[string]string

TransitGw string

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

TunnelDetectionTime int

The IPSec tunnel down detection time for the Spoke Gateway.

VpcId string

VpcReg string

Zone string

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

accountName String

This parameter represents the name of a Cloud-Account in Aviatrix controller.

allocateNewEip Boolean

approvedLearnedCidrs List<String>

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

availabilityDomain String

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

azureEipNameResourceGroup String

bgpEcmp Boolean

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

bgpHoldTime Integer

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

bgpPollingTime Integer

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

cloudInstanceId String

Cloud instance ID of the spoke gateway.

cloudType Integer

customerManagedKeys String

Customer managed key ID.

customizedSpokeVpcRoutes String

disableRoutePropagation Boolean

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

eip String

enableActiveStandby Boolean

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

enableActiveStandbyPreemptive Boolean

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

enableAutoAdvertiseS2cCidrs Boolean

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableBgp Boolean

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

enableEncryptVolume Boolean

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

enableJumboFrame Boolean

Enable jumbo frames for this spoke gateway. Default value is true.

enableLearnedCidrsApproval Boolean

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

enableMonitorGatewaySubnets Boolean

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

enablePreserveAsPath Boolean

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

enablePrivateOob Boolean

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

enablePrivateVpcDefaultRoute Boolean

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSkipPublicRouteTableUpdate Boolean

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSpotInstance Boolean

Enable spot instance. NOT supported for production deployment.

enableVpcDnsServer Boolean

faultDomain String

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

filteredSpokeVpcRoutes String

gwName String

Name of the gateway which is going to be created.

gwSize String

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

haAvailabilityDomain String

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haAzureEipNameResourceGroup String

haCloudInstanceId String

Cloud instance ID of the HA spoke gateway.

haEip String

haFaultDomain String

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haGwName String

Aviatrix spoke gateway unique name of HA spoke gateway.

haGwSize String

HA Gateway Size. Mandatory if enabling HA.

haImageVersion String

haInsaneModeAz String

haOobAvailabilityZone String

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

haOobManagementSubnet String

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

haPrivateIp String

Private IP address of HA spoke gateway.

haPrivateModeSubnetZone String

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

haPublicIp String

Public IP address of the HA Spoke Gateway.

haSecurityGroupId String

HA security group used for the spoke gateway.

haSoftwareVersion String

haSubnet String

haZone String

imageVersion String

includedAdvertisedSpokeRoutes String

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

insaneMode Boolean

insaneModeAz String

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

learnedCidrsApprovalMode String

localAsNumber String

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

manageTransitGatewayAttachment Boolean

monitorExcludeLists List<String>

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

oobAvailabilityZone String

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

oobManagementSubnet String

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

prependAsPaths List<String>

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

privateIp String

Private IP address of the spoke gateway created.

privateModeLbVpcId String

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

privateModeSubnetZone String

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

publicIp String

Public IP address of the Spoke Gateway created.

rxQueueSize String

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

securityGroupId String

Security group used for the spoke gateway.

singleAzHa Boolean

Set to true if this feature is desired. Valid values: true, false.

singleIpSnat Boolean

softwareVersion String

spokeBgpManualAdvertiseCidrs List<String>

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

spotPrice String

Price for spot instance. NOT supported for production deployment.

subnet String

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

tagLists List<String>

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

tags Map<String,String>

transitGw String

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

tunnelDetectionTime Integer

The IPSec tunnel down detection time for the Spoke Gateway.

vpcId String

vpcReg String

zone String

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

accountName string

This parameter represents the name of a Cloud-Account in Aviatrix controller.

allocateNewEip boolean

approvedLearnedCidrs string[]

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

availabilityDomain string

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

azureEipNameResourceGroup string

bgpEcmp boolean

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

bgpHoldTime number

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

bgpPollingTime number

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

cloudInstanceId string

Cloud instance ID of the spoke gateway.

cloudType number

customerManagedKeys string

Customer managed key ID.

customizedSpokeVpcRoutes string

disableRoutePropagation boolean

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

eip string

enableActiveStandby boolean

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

enableActiveStandbyPreemptive boolean

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

enableAutoAdvertiseS2cCidrs boolean

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableBgp boolean

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

enableEncryptVolume boolean

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

enableJumboFrame boolean

Enable jumbo frames for this spoke gateway. Default value is true.

enableLearnedCidrsApproval boolean

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

enableMonitorGatewaySubnets boolean

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

enablePreserveAsPath boolean

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

enablePrivateOob boolean

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

enablePrivateVpcDefaultRoute boolean

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSkipPublicRouteTableUpdate boolean

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSpotInstance boolean

Enable spot instance. NOT supported for production deployment.

enableVpcDnsServer boolean

faultDomain string

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

filteredSpokeVpcRoutes string

gwName string

Name of the gateway which is going to be created.

gwSize string

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

haAvailabilityDomain string

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haAzureEipNameResourceGroup string

haCloudInstanceId string

Cloud instance ID of the HA spoke gateway.

haEip string

haFaultDomain string

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haGwName string

Aviatrix spoke gateway unique name of HA spoke gateway.

haGwSize string

HA Gateway Size. Mandatory if enabling HA.

haImageVersion string

haInsaneModeAz string

haOobAvailabilityZone string

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

haOobManagementSubnet string

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

haPrivateIp string

Private IP address of HA spoke gateway.

haPrivateModeSubnetZone string

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

haPublicIp string

Public IP address of the HA Spoke Gateway.

haSecurityGroupId string

HA security group used for the spoke gateway.

haSoftwareVersion string

haSubnet string

haZone string

imageVersion string

includedAdvertisedSpokeRoutes string

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

insaneMode boolean

insaneModeAz string

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

learnedCidrsApprovalMode string

localAsNumber string

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

manageTransitGatewayAttachment boolean

monitorExcludeLists string[]

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

oobAvailabilityZone string

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

oobManagementSubnet string

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

prependAsPaths string[]

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

privateIp string

Private IP address of the spoke gateway created.

privateModeLbVpcId string

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

privateModeSubnetZone string

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

publicIp string

Public IP address of the Spoke Gateway created.

rxQueueSize string

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

securityGroupId string

Security group used for the spoke gateway.

singleAzHa boolean

Set to true if this feature is desired. Valid values: true, false.

singleIpSnat boolean

softwareVersion string

spokeBgpManualAdvertiseCidrs string[]

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

spotPrice string

Price for spot instance. NOT supported for production deployment.

subnet string

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

tagLists string[]

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

tags {[key: string]: string}

transitGw string

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

tunnelDetectionTime number

The IPSec tunnel down detection time for the Spoke Gateway.

vpcId string

vpcReg string

zone string

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

account_name str

This parameter represents the name of a Cloud-Account in Aviatrix controller.

allocate_new_eip bool

approved_learned_cidrs Sequence[str]

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

availability_domain str

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

azure_eip_name_resource_group str

bgp_ecmp bool

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

bgp_hold_time int

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

bgp_polling_time int

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

cloud_instance_id str

Cloud instance ID of the spoke gateway.

cloud_type int

customer_managed_keys str

Customer managed key ID.

customized_spoke_vpc_routes str

disable_route_propagation bool

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

eip str

enable_active_standby bool

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

enable_active_standby_preemptive bool

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

enable_auto_advertise_s2c_cidrs bool

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enable_bgp bool

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

enable_encrypt_volume bool

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

enable_jumbo_frame bool

Enable jumbo frames for this spoke gateway. Default value is true.

enable_learned_cidrs_approval bool

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

enable_monitor_gateway_subnets bool

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

enable_preserve_as_path bool

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

enable_private_oob bool

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

enable_private_vpc_default_route bool

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enable_skip_public_route_table_update bool

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enable_spot_instance bool

Enable spot instance. NOT supported for production deployment.

enable_vpc_dns_server bool

fault_domain str

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

filtered_spoke_vpc_routes str

gw_name str

Name of the gateway which is going to be created.

gw_size str

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

ha_availability_domain str

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

ha_azure_eip_name_resource_group str

ha_cloud_instance_id str

Cloud instance ID of the HA spoke gateway.

ha_eip str

ha_fault_domain str

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

ha_gw_name str

Aviatrix spoke gateway unique name of HA spoke gateway.

ha_gw_size str

HA Gateway Size. Mandatory if enabling HA.

ha_image_version str

ha_insane_mode_az str

ha_oob_availability_zone str

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

ha_oob_management_subnet str

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

ha_private_ip str

Private IP address of HA spoke gateway.

ha_private_mode_subnet_zone str

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

ha_public_ip str

Public IP address of the HA Spoke Gateway.

ha_security_group_id str

HA security group used for the spoke gateway.

ha_software_version str

ha_subnet str

ha_zone str

image_version str

included_advertised_spoke_routes str

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

insane_mode bool

insane_mode_az str

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

learned_cidrs_approval_mode str

local_as_number str

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

manage_transit_gateway_attachment bool

monitor_exclude_lists Sequence[str]

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

oob_availability_zone str

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

oob_management_subnet str

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

prepend_as_paths Sequence[str]

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

private_ip str

Private IP address of the spoke gateway created.

private_mode_lb_vpc_id str

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

private_mode_subnet_zone str

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

public_ip str

Public IP address of the Spoke Gateway created.

rx_queue_size str

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

security_group_id str

Security group used for the spoke gateway.

single_az_ha bool

Set to true if this feature is desired. Valid values: true, false.

single_ip_snat bool

software_version str

spoke_bgp_manual_advertise_cidrs Sequence[str]

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

spot_price str

Price for spot instance. NOT supported for production deployment.

subnet str

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

tag_lists Sequence[str]

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

tags Mapping[str, str]

transit_gw str

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

tunnel_detection_time int

The IPSec tunnel down detection time for the Spoke Gateway.

vpc_id str

vpc_reg str

zone str

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

accountName String

This parameter represents the name of a Cloud-Account in Aviatrix controller.

allocateNewEip Boolean

approvedLearnedCidrs List<String>

A set of approved learned CIDRs. Only valid when enable_learned_cidrs_approval is set to true. Example: ["10.250.0.0/16", "10.251.0.0/16"]. Available as of provider version R2.21+.

availabilityDomain String

Availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

azureEipNameResourceGroup String

bgpEcmp Boolean

Enable Equal Cost Multi Path (ECMP) routing for the next hop. Default value: false.

bgpHoldTime Number

BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.

bgpPollingTime Number

BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: "50".

cloudInstanceId String

Cloud instance ID of the spoke gateway.

cloudType Number

customerManagedKeys String

Customer managed key ID.

customizedSpokeVpcRoutes String

disableRoutePropagation Boolean

Disables route propagation on BGP Spoke to attached Transit Gateway. Default value: false.

eip String

enableActiveStandby Boolean

Enables Active-Standby Mode. Available only with HA enabled. Valid values: true, false. Default value: false.

enableActiveStandbyPreemptive Boolean

Enables Preemptive Mode for Active-Standby. Available only with BGP enabled, HA enabled and Active-Standby enabled. Valid values: true, false. Default value: false.

enableAutoAdvertiseS2cCidrs Boolean

Auto Advertise Spoke Site2Cloud CIDRs. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableBgp Boolean

Enable BGP for this spoke gateway. Only available for AWS and Azure. Valid values: true, false. Default value: false. Available in provider R2.21.0+.

enableEncryptVolume Boolean

Enable EBS volume encryption for Gateway. Only supports AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret providers. Valid values: true, false. Default value: false.

enableJumboFrame Boolean

Enable jumbo frames for this spoke gateway. Default value is true.

enableLearnedCidrsApproval Boolean

Switch to enable/disable learned CIDR approval for BGP Spoke Gateway. Valid values: true, false. Default value: false.

enableMonitorGatewaySubnets Boolean

If set to true, the Monitor Gateway Subnets feature is enabled. Default value is false. Available in provider version R2.18+.

enablePreserveAsPath Boolean

Enable preserve as_path when advertising manual summary cidrs on BGP spoke gateway. Valid values: true, false. Default value: false. Available as of provider version R.2.22.1+

enablePrivateOob Boolean

Enable Private OOB feature. Only available for AWS, AWSGov, AWSChina, AWS Top Secret and AWS Secret. Valid values: true, false. Default value: false.

enablePrivateVpcDefaultRoute Boolean

Program default route in VPC private route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSkipPublicRouteTableUpdate Boolean

Skip programming VPC public route table. Default: false. Valid values: true or false. Available as of provider version R2.19+.

enableSpotInstance Boolean

Enable spot instance. NOT supported for production deployment.

enableVpcDnsServer Boolean

faultDomain String

Fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

filteredSpokeVpcRoutes String

gwName String

Name of the gateway which is going to be created.

gwSize String

Size of the gateway instance. Example: AWS/AWSGov/AWSChina: "t2.large", Azure/AzureGov/AzureChina: "Standard_B1s", OCI: "VM.Standard2.2", GCP: "n1-standard-1".

haAvailabilityDomain String

HA gateway availability domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haAzureEipNameResourceGroup String

haCloudInstanceId String

Cloud instance ID of the HA spoke gateway.

haEip String

haFaultDomain String

HA gateway fault domain. Required and valid only for OCI. Available as of provider version R2.19.3.

haGwName String

Aviatrix spoke gateway unique name of HA spoke gateway.

haGwSize String

HA Gateway Size. Mandatory if enabling HA.

haImageVersion String

haInsaneModeAz String

haOobAvailabilityZone String

HA OOB availability zone. Required if enabling Private OOB and HA. Example: "us-west-1b".

haOobManagementSubnet String

HA OOB management subnet. Required if enabling Private OOB and HA. Example: "11.0.0.48/28".

haPrivateIp String

Private IP address of HA spoke gateway.

haPrivateModeSubnetZone String

Availability Zone of the HA subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov with HA. Available in Provider version R2.23+.

haPublicIp String

Public IP address of the HA Spoke Gateway.

haSecurityGroupId String

HA security group used for the spoke gateway.

haSoftwareVersion String

haSubnet String

haZone String

imageVersion String

includedAdvertisedSpokeRoutes String

A list of comma separated CIDRs to be advertised to on-prem as 'Included CIDR List'. When configured, it will replace all advertised routes from this VPC. Example: "10.4.0.0/116,10.5.0.0/16".

insaneMode Boolean

insaneModeAz String

AZ of subnet being created for Insane Mode Spoke Gateway. Required for AWS, AWSGov, AWS China, AWS Top Secret or AWS Secret if insane_mode is enabled. Example: AWS: "us-west-1a".

learnedCidrsApprovalMode String

localAsNumber String

Changes the Aviatrix Spoke Gateway ASN number before you setup Aviatrix Spoke Gateway connection configurations.

manageTransitGatewayAttachment Boolean

monitorExcludeLists List<String>

Set of monitored instance ids. Only valid when 'enable_monitor_gateway_subnets' = true. Available in provider version R2.18+.

oobAvailabilityZone String

OOB availability zone. Required if enabling Private OOB. Example: "us-west-1a".

oobManagementSubnet String

OOB management subnet. Required if enabling Private OOB. Example: "11.0.2.0/24".

prependAsPaths List<String>

List of AS numbers to populate BGP AS_PATH field when it advertises to VGW or peer devices.

privateIp String

Private IP address of the spoke gateway created.

privateModeLbVpcId String

VPC ID of Private Mode load balancer. Required when Private Mode is enabled on the Controller. Available in provider version R2.23+.

privateModeSubnetZone String

Availability Zone of the subnet. Required when Private Mode is enabled on the Controller and cloud_type is AWS or AWSGov. Available in Provider version R2.23+.

publicIp String

Public IP address of the Spoke Gateway created.

rxQueueSize String

Gateway ethernet interface RX queue size. Once set, can't be deleted or disabled. Available for AWS as of provider version R2.22+.

securityGroupId String

Security group used for the spoke gateway.

singleAzHa Boolean

Set to true if this feature is desired. Valid values: true, false.

singleIpSnat Boolean

softwareVersion String

spokeBgpManualAdvertiseCidrs List<String>

Intended CIDR list to be advertised to external BGP router. Empty list is not valid. Example: ["10.2.0.0/16", "10.4.0.0/16"].

spotPrice String

Price for spot instance. NOT supported for production deployment.

subnet String

A VPC Network address range selected from one of the available network ranges. Example: "172.31.0.0/20". NOTE: If using insane_mode, please see notes here.

tagLists List<String>

(Optional) Instance tag of cloud provider. Only supported for AWS, Azure, AzureGov, AWSGov, AWSChina and AzureChina. Example: ["key1:value1", "key2:value2"].

Deprecated:

Use tags instead.

tags Map<String>

transitGw String

Specify the Aviatrix transit gateways to attach this spoke gateway to. Format is a comma separated list of transit gateway names. For example: "transit-gw1,transit-gw2".

Deprecated:

Please set manage_transit_gateway_attachment to false, and use the standalone aviatrix_spoke_transit_attachment resource instead.

tunnelDetectionTime Number

The IPSec tunnel down detection time for the Spoke Gateway.

vpcId String

vpcReg String

zone String

Availability Zone. Only available for cloud_type = 8 (Azure). Must be in the form 'az-n', for example, 'az-2'. Available in provider version R2.17+.

Package Details

Repository: aviatrix astipkovits/pulumi-aviatrix
License: Apache-2.0
Notes: This Pulumi package is based on the aviatrix Terraform Provider.

Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

astipkovits/pulumi-aviatrix

aviatrix.AviatrixSpokeGateway

On this page

On this page

Import

Create AviatrixSpokeGateway Resource

AviatrixSpokeGateway Resource Properties

Inputs

Outputs

Look up Existing AviatrixSpokeGateway Resource

Package Details

On this page

On this page