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

aviatrix.AviatrixGeoVpn

Explore with Pulumi AI

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

    The aviatrix_geo_vpn resource enables and manages the Aviatrix Geo VPN feature.

    NOTE: If ELBs/gateways are being managed by the Geo VPN, in order to update VPN configurations of the Geo VPN, all the VPN configurations of the ELBs/gateways must be updated simultaneously and share the same values. This can be achieved by managing the VPN configurations through variables and updating their values accordingly.

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix Geo VPN
    var testGeoVpn = new Aviatrix.AviatrixGeoVpn("testGeoVpn", new()
    {
        AccountName = "devops-aws",
        CloudType = 1,
        DomainName = "aviatrix.live",
        ElbDnsNames = new[]
        {
            "elb-test1-497f5e89.elb.us-west-1.amazonaws.com",
            "elb-test2-974f895e.elb.us-east-2.amazonaws.com",
        },
        ServiceName = "vpn",
    });

});

    package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixGeoVpn(ctx, "testGeoVpn", &aviatrix.AviatrixGeoVpnArgs{
			AccountName: pulumi.String("devops-aws"),
			CloudType:   pulumi.Int(1),
			DomainName:  pulumi.String("aviatrix.live"),
			ElbDnsNames: pulumi.StringArray{
				pulumi.String("elb-test1-497f5e89.elb.us-west-1.amazonaws.com"),
				pulumi.String("elb-test2-974f895e.elb.us-east-2.amazonaws.com"),
			},
			ServiceName: pulumi.String("vpn"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixGeoVpn;
import com.pulumi.aviatrix.AviatrixGeoVpnArgs;
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 testGeoVpn = new AviatrixGeoVpn("testGeoVpn", AviatrixGeoVpnArgs.builder()        
            .accountName("devops-aws")
            .cloudType(1)
            .domainName("aviatrix.live")
            .elbDnsNames(            
                "elb-test1-497f5e89.elb.us-west-1.amazonaws.com",
                "elb-test2-974f895e.elb.us-east-2.amazonaws.com")
            .serviceName("vpn")
            .build());

    }
}

    import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix Geo VPN
test_geo_vpn = aviatrix.AviatrixGeoVpn("testGeoVpn",
    account_name="devops-aws",
    cloud_type=1,
    domain_name="aviatrix.live",
    elb_dns_names=[
        "elb-test1-497f5e89.elb.us-west-1.amazonaws.com",
        "elb-test2-974f895e.elb.us-east-2.amazonaws.com",
    ],
    service_name="vpn")

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

// Create an Aviatrix Geo VPN
const testGeoVpn = new aviatrix.AviatrixGeoVpn("test_geo_vpn", {
    accountName: "devops-aws",
    cloudType: 1,
    domainName: "aviatrix.live",
    elbDnsNames: [
        "elb-test1-497f5e89.elb.us-west-1.amazonaws.com",
        "elb-test2-974f895e.elb.us-east-2.amazonaws.com",
    ],
    serviceName: "vpn",
});

    resources:
  # Create an Aviatrix Geo VPN
  testGeoVpn:
    type: aviatrix:AviatrixGeoVpn
    properties:
      accountName: devops-aws
      cloudType: 1
      domainName: aviatrix.live
      elbDnsNames:
        - elb-test1-497f5e89.elb.us-west-1.amazonaws.com
        - elb-test2-974f895e.elb.us-east-2.amazonaws.com
      serviceName: vpn

    Create AviatrixGeoVpn Resource

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

    Constructor syntax

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

@overload
def AviatrixGeoVpn(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   account_name: Optional[str] = None,
                   cloud_type: Optional[int] = None,
                   domain_name: Optional[str] = None,
                   elb_dns_names: Optional[Sequence[str]] = None,
                   service_name: Optional[str] = None)
    func NewAviatrixGeoVpn(ctx *Context, name string, args AviatrixGeoVpnArgs, opts ...ResourceOption) (*AviatrixGeoVpn, error)
    public AviatrixGeoVpn(string name, AviatrixGeoVpnArgs args, CustomResourceOptions? opts = null)
    public AviatrixGeoVpn(String name, AviatrixGeoVpnArgs args)
public AviatrixGeoVpn(String name, AviatrixGeoVpnArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args AviatrixGeoVpnArgs
    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 AviatrixGeoVpnArgs
    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 AviatrixGeoVpnArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixGeoVpnArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixGeoVpnArgs
    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 aviatrixGeoVpnResource = new Aviatrix.AviatrixGeoVpn("aviatrixGeoVpnResource", new()
{
    AccountName = "string",
    CloudType = 0,
    DomainName = "string",
    ElbDnsNames = new[]
    {
        "string",
    },
    ServiceName = "string",
});

    example, err := aviatrix.NewAviatrixGeoVpn(ctx, "aviatrixGeoVpnResource", &aviatrix.AviatrixGeoVpnArgs{
	AccountName: pulumi.String("string"),
	CloudType:   pulumi.Int(0),
	DomainName:  pulumi.String("string"),
	ElbDnsNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceName: pulumi.String("string"),
})

    var aviatrixGeoVpnResource = new AviatrixGeoVpn("aviatrixGeoVpnResource", AviatrixGeoVpnArgs.builder()
    .accountName("string")
    .cloudType(0)
    .domainName("string")
    .elbDnsNames("string")
    .serviceName("string")
    .build());

    aviatrix_geo_vpn_resource = aviatrix.AviatrixGeoVpn("aviatrixGeoVpnResource",
    account_name="string",
    cloud_type=0,
    domain_name="string",
    elb_dns_names=["string"],
    service_name="string")

    const aviatrixGeoVpnResource = new aviatrix.AviatrixGeoVpn("aviatrixGeoVpnResource", {
    accountName: "string",
    cloudType: 0,
    domainName: "string",
    elbDnsNames: ["string"],
    serviceName: "string",
});

    type: aviatrix:AviatrixGeoVpn
properties:
    accountName: string
    cloudType: 0
    domainName: string
    elbDnsNames:
        - string
    serviceName: string

    AviatrixGeoVpn 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 AviatrixGeoVpn 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) is supported.
    DomainName string
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    ElbDnsNames List<string>
    List of ELB names to attach to this Geo VPN name.
    ServiceName string
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    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) is supported.
    DomainName string
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    ElbDnsNames []string
    List of ELB names to attach to this Geo VPN name.
    ServiceName string
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    accountName String
    This parameter represents the name of a Cloud-Account in Aviatrix controller.
    cloudType Integer
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    domainName String
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    elbDnsNames List<String>
    List of ELB names to attach to this Geo VPN name.
    serviceName String
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    accountName string
    This parameter represents the name of a Cloud-Account in Aviatrix controller.
    cloudType number
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    domainName string
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    elbDnsNames string[]
    List of ELB names to attach to this Geo VPN name.
    serviceName string
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    account_name str
    This parameter represents the name of a Cloud-Account in Aviatrix controller.
    cloud_type int
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    domain_name str
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    elb_dns_names Sequence[str]
    List of ELB names to attach to this Geo VPN name.
    service_name str
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    accountName String
    This parameter represents the name of a Cloud-Account in Aviatrix controller.
    cloudType Number
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    domainName String
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    elbDnsNames List<String>
    List of ELB names to attach to this Geo VPN name.
    serviceName String
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AviatrixGeoVpn Resource

    Get an existing AviatrixGeoVpn 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?: AviatrixGeoVpnState, opts?: CustomResourceOptions): AviatrixGeoVpn
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        cloud_type: Optional[int] = None,
        domain_name: Optional[str] = None,
        elb_dns_names: Optional[Sequence[str]] = None,
        service_name: Optional[str] = None) -> AviatrixGeoVpn
    func GetAviatrixGeoVpn(ctx *Context, name string, id IDInput, state *AviatrixGeoVpnState, opts ...ResourceOption) (*AviatrixGeoVpn, error)
    public static AviatrixGeoVpn Get(string name, Input<string> id, AviatrixGeoVpnState? state, CustomResourceOptions? opts = null)
    public static AviatrixGeoVpn get(String name, Output<String> id, AviatrixGeoVpnState 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.
    CloudType int
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    DomainName string
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    ElbDnsNames List<string>
    List of ELB names to attach to this Geo VPN name.
    ServiceName string
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    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) is supported.
    DomainName string
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    ElbDnsNames []string
    List of ELB names to attach to this Geo VPN name.
    ServiceName string
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    accountName String
    This parameter represents the name of a Cloud-Account in Aviatrix controller.
    cloudType Integer
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    domainName String
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    elbDnsNames List<String>
    List of ELB names to attach to this Geo VPN name.
    serviceName String
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    accountName string
    This parameter represents the name of a Cloud-Account in Aviatrix controller.
    cloudType number
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    domainName string
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    elbDnsNames string[]
    List of ELB names to attach to this Geo VPN name.
    serviceName string
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    account_name str
    This parameter represents the name of a Cloud-Account in Aviatrix controller.
    cloud_type int
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    domain_name str
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    elb_dns_names Sequence[str]
    List of ELB names to attach to this Geo VPN name.
    service_name str
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.
    accountName String
    This parameter represents the name of a Cloud-Account in Aviatrix controller.
    cloudType Number
    Type of cloud service provider, requires an integer value. Currently only AWS(1) is supported.
    domainName String
    The hosted domain name. It must be hosted by AWS Route53 or Azure DNS in the selected account.
    elbDnsNames List<String>
    List of ELB names to attach to this Geo VPN name.
    serviceName String
    The hostname that users will connect to. A DNS record will be created for this name in the specified domain name.

    Import

    geo_vpn can be imported using the service_name and domain_name, e.g.

     $ pulumi import aviatrix:index/aviatrixGeoVpn:AviatrixGeoVpn test service_name~domain_name

    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 logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
    astipkovits/pulumi-aviatrix