Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixSpokeVpc
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixSpokeVpc

Explore with Pulumi AI

Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

The aviatrix.AviatrixSpokeVpc resource allows to create and manage Aviatrix Spoke Gateways.

!> WARNING: The aviatrix.AviatrixSpokeVpc resource is deprecated as of Release 2.0. It is currently kept for backward-compatibility and will be removed in the future. Please use the spoke gateway resource instead. If this is already in the state, please remove it from the state file and import as aviatrix.AviatrixSpokeGateway.

Example Usage

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixSpokeVpc;
import com.pulumi.aviatrix.AviatrixSpokeVpcArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testSpokeVpcAws = new AviatrixSpokeVpc("testSpokeVpcAws", AviatrixSpokeVpcArgs.builder()        
            .accountName("my-aws")
            .cloudType(1)
            .dnsServer("8.8.8.8")
            .enableNat("no")
            .gwName("spoke-gw-aws")
            .subnet("10.11.0.0/24~~us-west-1b~~spoke-vpc-01-pubsub")
            .tagLists(            
                "k1:v1",
                "k2:v2")
            .vpcId("vpc-abcd123~~spoke-vpc-01")
            .vpcReg("us-west-1")
            .vpcSize("t2.micro")
            .build());

        var testSpokeVpcGcp = new AviatrixSpokeVpc("testSpokeVpcGcp", AviatrixSpokeVpcArgs.builder()        
            .accountName("my-gcp")
            .cloudType(4)
            .enableNat("no")
            .gwName("spoke-gw-gcp")
            .subnet("10.12.0.0/24")
            .vpcId("gcp-spoke-vpc")
            .vpcReg("us-west1-b")
            .vpcSize("t2.micro")
            .build());

        var testSpokeVpcArm = new AviatrixSpokeVpc("testSpokeVpcArm", AviatrixSpokeVpcArgs.builder()        
            .accountName("my-arm")
            .cloudType(8)
            .enableNat("no")
            .gwName("spoke-gw-01")
            .subnet("10.13.0.0/24")
            .vpcId("spoke:test-spoke-gw-123")
            .vpcReg("West US")
            .vpcSize("t2.micro")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Set Aviatrix aws spoke_vpc
const testSpokeVpcAws = new aviatrix.AviatrixSpokeVpc("test_spoke_vpc_aws", {
    accountName: "my-aws",
    cloudType: 1,
    dnsServer: "8.8.8.8",
    enableNat: "no",
    gwName: "spoke-gw-aws",
    subnet: "10.11.0.0/24~~us-west-1b~~spoke-vpc-01-pubsub",
    tagLists: [
        "k1:v1",
        "k2:v2",
    ],
    vpcId: "vpc-abcd123~~spoke-vpc-01",
    vpcReg: "us-west-1",
    vpcSize: "t2.micro",
});
// Set Aviatrix gcp spoke_vpc
const testSpokeVpcGcp = new aviatrix.AviatrixSpokeVpc("test_spoke_vpc_gcp", {
    accountName: "my-gcp",
    cloudType: 4,
    enableNat: "no",
    gwName: "spoke-gw-gcp",
    subnet: "10.12.0.0/24",
    vpcId: "gcp-spoke-vpc",
    vpcReg: "us-west1-b",
    vpcSize: "t2.micro",
});
// Set Aviatrix arm spoke_vpc
const testSpokeVpcArm = new aviatrix.AviatrixSpokeVpc("test_spoke_vpc_arm", {
    accountName: "my-arm",
    cloudType: 8,
    enableNat: "no",
    gwName: "spoke-gw-01",
    subnet: "10.13.0.0/24",
    vpcId: "spoke:test-spoke-gw-123",
    vpcReg: "West US",
    vpcSize: "t2.micro",
});
Copy

Coming soon!

resources:
  # Set Aviatrix aws spoke_vpc
  testSpokeVpcAws:
    type: aviatrix:AviatrixSpokeVpc
    properties:
      accountName: my-aws
      cloudType: 1
      dnsServer: 8.8.8.8
      enableNat: no
      gwName: spoke-gw-aws
      subnet: 10.11.0.0/24~~us-west-1b~~spoke-vpc-01-pubsub
      tagLists:
        - k1:v1
        - k2:v2
      vpcId: vpc-abcd123~~spoke-vpc-01
      vpcReg: us-west-1
      vpcSize: t2.micro
  # Set Aviatrix gcp spoke_vpc
  testSpokeVpcGcp:
    type: aviatrix:AviatrixSpokeVpc
    properties:
      accountName: my-gcp
      cloudType: 4
      enableNat: no
      gwName: spoke-gw-gcp
      subnet: 10.12.0.0/24
      vpcId: gcp-spoke-vpc
      vpcReg: us-west1-b
      vpcSize: t2.micro
  # Set Aviatrix arm spoke_vpc
  testSpokeVpcArm:
    type: aviatrix:AviatrixSpokeVpc
    properties:
      accountName: my-arm
      cloudType: 8
      enableNat: no
      gwName: spoke-gw-01
      subnet: 10.13.0.0/24
      vpcId: spoke:test-spoke-gw-123
      vpcReg: West US
      vpcSize: t2.micro
Copy

Create AviatrixSpokeVpc Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AviatrixSpokeVpc(name: string, args: AviatrixSpokeVpcArgs, opts?: CustomResourceOptions);
@overload
def AviatrixSpokeVpc(resource_name: str,
                     args: AviatrixSpokeVpcArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def AviatrixSpokeVpc(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     subnet: Optional[str] = None,
                     cloud_type: Optional[int] = None,
                     vpc_size: Optional[str] = None,
                     gw_name: Optional[str] = None,
                     vpc_reg: Optional[str] = None,
                     vpc_id: Optional[str] = None,
                     account_name: Optional[str] = None,
                     ha_zone: Optional[str] = None,
                     single_az_ha: Optional[str] = None,
                     tag_lists: Optional[Sequence[str]] = None,
                     transit_gw: Optional[str] = None,
                     ha_subnet: Optional[str] = None,
                     ha_gw_size: Optional[str] = None,
                     enable_nat: Optional[str] = None)
func NewAviatrixSpokeVpc(ctx *Context, name string, args AviatrixSpokeVpcArgs, opts ...ResourceOption) (*AviatrixSpokeVpc, error)
public AviatrixSpokeVpc(string name, AviatrixSpokeVpcArgs args, CustomResourceOptions? opts = null)
public AviatrixSpokeVpc(String name, AviatrixSpokeVpcArgs args)
public AviatrixSpokeVpc(String name, AviatrixSpokeVpcArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AviatrixSpokeVpcArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AviatrixSpokeVpcArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AviatrixSpokeVpcArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AviatrixSpokeVpcArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AviatrixSpokeVpcArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var aviatrixSpokeVpcResource = new Aviatrix.AviatrixSpokeVpc("aviatrixSpokeVpcResource", new()
{
    Subnet = "string",
    CloudType = 0,
    VpcSize = "string",
    GwName = "string",
    VpcReg = "string",
    VpcId = "string",
    AccountName = "string",
    HaZone = "string",
    SingleAzHa = "string",
    TagLists = new[]
    {
        "string",
    },
    TransitGw = "string",
    HaSubnet = "string",
    HaGwSize = "string",
    EnableNat = "string",
});
Copy
example, err := aviatrix.NewAviatrixSpokeVpc(ctx, "aviatrixSpokeVpcResource", &aviatrix.AviatrixSpokeVpcArgs{
	Subnet:      pulumi.String("string"),
	CloudType:   pulumi.Int(0),
	VpcSize:     pulumi.String("string"),
	GwName:      pulumi.String("string"),
	VpcReg:      pulumi.String("string"),
	VpcId:       pulumi.String("string"),
	AccountName: pulumi.String("string"),
	HaZone:      pulumi.String("string"),
	SingleAzHa:  pulumi.String("string"),
	TagLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	TransitGw: pulumi.String("string"),
	HaSubnet:  pulumi.String("string"),
	HaGwSize:  pulumi.String("string"),
	EnableNat: pulumi.String("string"),
})
Copy
var aviatrixSpokeVpcResource = new AviatrixSpokeVpc("aviatrixSpokeVpcResource", AviatrixSpokeVpcArgs.builder()
    .subnet("string")
    .cloudType(0)
    .vpcSize("string")
    .gwName("string")
    .vpcReg("string")
    .vpcId("string")
    .accountName("string")
    .haZone("string")
    .singleAzHa("string")
    .tagLists("string")
    .transitGw("string")
    .haSubnet("string")
    .haGwSize("string")
    .enableNat("string")
    .build());
Copy
aviatrix_spoke_vpc_resource = aviatrix.AviatrixSpokeVpc("aviatrixSpokeVpcResource",
    subnet="string",
    cloud_type=0,
    vpc_size="string",
    gw_name="string",
    vpc_reg="string",
    vpc_id="string",
    account_name="string",
    ha_zone="string",
    single_az_ha="string",
    tag_lists=["string"],
    transit_gw="string",
    ha_subnet="string",
    ha_gw_size="string",
    enable_nat="string")
Copy
const aviatrixSpokeVpcResource = new aviatrix.AviatrixSpokeVpc("aviatrixSpokeVpcResource", {
    subnet: "string",
    cloudType: 0,
    vpcSize: "string",
    gwName: "string",
    vpcReg: "string",
    vpcId: "string",
    accountName: "string",
    haZone: "string",
    singleAzHa: "string",
    tagLists: ["string"],
    transitGw: "string",
    haSubnet: "string",
    haGwSize: "string",
    enableNat: "string",
});
Copy
type: aviatrix:AviatrixSpokeVpc
properties:
    accountName: string
    cloudType: 0
    enableNat: string
    gwName: string
    haGwSize: string
    haSubnet: string
    haZone: string
    singleAzHa: string
    subnet: string
    tagLists:
        - string
    transitGw: string
    vpcId: string
    vpcReg: string
    vpcSize: string
Copy

AviatrixSpokeVpc Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AviatrixSpokeVpc resource accepts the following input properties:

AccountName This property is required. string
This parameter represents the name of a Cloud-Account in Aviatrix controller.
CloudType This property is required. int
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
GwName This property is required. string
Name of the gateway which is going to be created.
Subnet This property is required. string
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
VpcId This property is required. string
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
VpcReg This property is required. string
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
VpcSize This property is required. string
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
EnableNat string
Specify whether enabling NAT feature on the gateway or not.
HaGwSize string
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
HaSubnet string
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
HaZone string
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
SingleAzHa string
Set to "enabled" if this feature is desired.
TagLists List<string>
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
TransitGw string
Specify the transit Gateway.
AccountName This property is required. string
This parameter represents the name of a Cloud-Account in Aviatrix controller.
CloudType This property is required. int
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
GwName This property is required. string
Name of the gateway which is going to be created.
Subnet This property is required. string
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
VpcId This property is required. string
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
VpcReg This property is required. string
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
VpcSize This property is required. string
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
EnableNat string
Specify whether enabling NAT feature on the gateway or not.
HaGwSize string
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
HaSubnet string
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
HaZone string
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
SingleAzHa string
Set to "enabled" if this feature is desired.
TagLists []string
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
TransitGw string
Specify the transit Gateway.
accountName This property is required. String
This parameter represents the name of a Cloud-Account in Aviatrix controller.
cloudType This property is required. Integer
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
gwName This property is required. String
Name of the gateway which is going to be created.
subnet This property is required. String
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
vpcId This property is required. String
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
vpcReg This property is required. String
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
vpcSize This property is required. String
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
enableNat String
Specify whether enabling NAT feature on the gateway or not.
haGwSize String
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
haSubnet String
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
haZone String
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
singleAzHa String
Set to "enabled" if this feature is desired.
tagLists List<String>
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
transitGw String
Specify the transit Gateway.
accountName This property is required. string
This parameter represents the name of a Cloud-Account in Aviatrix controller.
cloudType This property is required. number
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
gwName This property is required. string
Name of the gateway which is going to be created.
subnet This property is required. string
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
vpcId This property is required. string
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
vpcReg This property is required. string
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
vpcSize This property is required. string
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
enableNat string
Specify whether enabling NAT feature on the gateway or not.
haGwSize string
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
haSubnet string
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
haZone string
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
singleAzHa string
Set to "enabled" if this feature is desired.
tagLists string[]
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
transitGw string
Specify the transit Gateway.
account_name This property is required. str
This parameter represents the name of a Cloud-Account in Aviatrix controller.
cloud_type This property is required. int
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
gw_name This property is required. str
Name of the gateway which is going to be created.
subnet This property is required. str
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
vpc_id This property is required. str
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
vpc_reg This property is required. str
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
vpc_size This property is required. str
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
enable_nat str
Specify whether enabling NAT feature on the gateway or not.
ha_gw_size str
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
ha_subnet str
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
ha_zone str
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
single_az_ha str
Set to "enabled" if this feature is desired.
tag_lists Sequence[str]
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
transit_gw str
Specify the transit Gateway.
accountName This property is required. String
This parameter represents the name of a Cloud-Account in Aviatrix controller.
cloudType This property is required. Number
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
gwName This property is required. String
Name of the gateway which is going to be created.
subnet This property is required. String
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
vpcId This property is required. String
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
vpcReg This property is required. String
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
vpcSize This property is required. String
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
enableNat String
Specify whether enabling NAT feature on the gateway or not.
haGwSize String
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
haSubnet String
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
haZone String
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
singleAzHa String
Set to "enabled" if this feature is desired.
tagLists List<String>
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
transitGw String
Specify the transit Gateway.

Outputs

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

CloudInstanceId string
Cloud instance ID.
Id string
The provider-assigned unique ID for this managed resource.
CloudInstanceId string
Cloud instance ID.
Id string
The provider-assigned unique ID for this managed resource.
cloudInstanceId String
Cloud instance ID.
id String
The provider-assigned unique ID for this managed resource.
cloudInstanceId string
Cloud instance ID.
id string
The provider-assigned unique ID for this managed resource.
cloud_instance_id str
Cloud instance ID.
id str
The provider-assigned unique ID for this managed resource.
cloudInstanceId String
Cloud instance ID.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AviatrixSpokeVpc Resource

Get an existing AviatrixSpokeVpc 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?: AviatrixSpokeVpcState, opts?: CustomResourceOptions): AviatrixSpokeVpc
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        cloud_instance_id: Optional[str] = None,
        cloud_type: Optional[int] = None,
        enable_nat: Optional[str] = None,
        gw_name: Optional[str] = None,
        ha_gw_size: Optional[str] = None,
        ha_subnet: Optional[str] = None,
        ha_zone: Optional[str] = None,
        single_az_ha: Optional[str] = None,
        subnet: Optional[str] = None,
        tag_lists: Optional[Sequence[str]] = None,
        transit_gw: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_reg: Optional[str] = None,
        vpc_size: Optional[str] = None) -> AviatrixSpokeVpc
func GetAviatrixSpokeVpc(ctx *Context, name string, id IDInput, state *AviatrixSpokeVpcState, opts ...ResourceOption) (*AviatrixSpokeVpc, error)
public static AviatrixSpokeVpc Get(string name, Input<string> id, AviatrixSpokeVpcState? state, CustomResourceOptions? opts = null)
public static AviatrixSpokeVpc get(String name, Output<String> id, AviatrixSpokeVpcState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixSpokeVpc    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
CloudInstanceId string
Cloud instance ID.
CloudType int
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
EnableNat string
Specify whether enabling NAT feature on the gateway or not.
GwName string
Name of the gateway which is going to be created.
HaGwSize string
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
HaSubnet string
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
HaZone string
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
SingleAzHa string
Set to "enabled" if this feature is desired.
Subnet string
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
TagLists List<string>
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
TransitGw string
Specify the transit Gateway.
VpcId string
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
VpcReg string
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
VpcSize string
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
AccountName string
This parameter represents the name of a Cloud-Account in Aviatrix controller.
CloudInstanceId string
Cloud instance ID.
CloudType int
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
EnableNat string
Specify whether enabling NAT feature on the gateway or not.
GwName string
Name of the gateway which is going to be created.
HaGwSize string
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
HaSubnet string
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
HaZone string
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
SingleAzHa string
Set to "enabled" if this feature is desired.
Subnet string
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
TagLists []string
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
TransitGw string
Specify the transit Gateway.
VpcId string
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
VpcReg string
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
VpcSize string
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
accountName String
This parameter represents the name of a Cloud-Account in Aviatrix controller.
cloudInstanceId String
Cloud instance ID.
cloudType Integer
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
enableNat String
Specify whether enabling NAT feature on the gateway or not.
gwName String
Name of the gateway which is going to be created.
haGwSize String
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
haSubnet String
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
haZone String
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
singleAzHa String
Set to "enabled" if this feature is desired.
subnet String
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
tagLists List<String>
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
transitGw String
Specify the transit Gateway.
vpcId String
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
vpcReg String
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
vpcSize String
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
accountName string
This parameter represents the name of a Cloud-Account in Aviatrix controller.
cloudInstanceId string
Cloud instance ID.
cloudType number
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
enableNat string
Specify whether enabling NAT feature on the gateway or not.
gwName string
Name of the gateway which is going to be created.
haGwSize string
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
haSubnet string
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
haZone string
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
singleAzHa string
Set to "enabled" if this feature is desired.
subnet string
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
tagLists string[]
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
transitGw string
Specify the transit Gateway.
vpcId string
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
vpcReg string
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
vpcSize string
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
account_name str
This parameter represents the name of a Cloud-Account in Aviatrix controller.
cloud_instance_id str
Cloud instance ID.
cloud_type int
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
enable_nat str
Specify whether enabling NAT feature on the gateway or not.
gw_name str
Name of the gateway which is going to be created.
ha_gw_size str
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
ha_subnet str
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
ha_zone str
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
single_az_ha str
Set to "enabled" if this feature is desired.
subnet str
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
tag_lists Sequence[str]
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
transit_gw str
Specify the transit Gateway.
vpc_id str
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
vpc_reg str
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
vpc_size str
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...
accountName String
This parameter represents the name of a Cloud-Account in Aviatrix controller.
cloudInstanceId String
Cloud instance ID.
cloudType Number
Type of cloud service provider. AWS=1, GCP=4, ARM=8.
enableNat String
Specify whether enabling NAT feature on the gateway or not.
gwName String
Name of the gateway which is going to be created.
haGwSize String
HA Gateway Size. Mandatory if HA is enabled (ha_subnet is set). Example: "t2.micro".
haSubnet String
HA Subnet. Required for enabling HA for AWS/ARM gateways. Setting to empty/unset will disable HA. Setting to a valid subnet (Example: 10.12.0.0/24) will create an HA gateway on the subnet.
haZone String
HA Zone. Required for enabling HA for GCP gateway. Setting to empty/unset will disable HA. Setting to a valid zone will create an HA gateway in the zone. Example: "us-west1-c".
singleAzHa String
Set to "enabled" if this feature is desired.
subnet String
Public Subnet Info. Example: AWS: "CIDRZONESubnetName", etc...
tagLists List<String>
Instance tag of cloud provider. Example: key1:value1,key002:value002, etc... Only AWS (cloud_type is "1") is supported
transitGw String
Specify the transit Gateway.
vpcId String
VPC-ID/VNet-Name of cloud provider. Required if cloud_type is "1" or "4". Example: AWS: "vpc-abcd1234", etc...
vpcReg String
Region of cloud provider. Example: AWS: "us-east-1", GCP: "us-west1-b", ARM: "East US 2", etc...
vpcSize String
Size of the gateway instance. Example: AWS: "t2.large", GCP: "f1.micro", ARM: "StandardD2", etc...

Import

Instance spoke_vpc can be imported using the gw_name, e.g.

 $ pulumi import aviatrix:index/aviatrixSpokeVpc:AviatrixSpokeVpc test gw_name
Copy

To learn more about importing existing cloud resources, see Importing resources.

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