1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixEdgeSpokeExternalDeviceConn
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixEdgeSpokeExternalDeviceConn

Explore with Pulumi AI

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

    The aviatrix_edge_spoke_external_device_conn resource creates and manages the connection between Edge as a Spoke and an External Device. This resource is available as of provider version R2.23+.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Edge as a Spoke External Device Connection
        var test = new Aviatrix.AviatrixEdgeSpokeExternalDeviceConn("test", new()
        {
            BgpLocalAsNum = "123",
            BgpRemoteAsNum = "345",
            ConnectionName = "conn",
            GwName = "eaas",
            LocalLanIp = "10.230.3.23",
            RemoteLanIp = "10.0.60.1",
            SiteId = "site-abcd1234",
        });
    
    });
    
    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.NewAviatrixEdgeSpokeExternalDeviceConn(ctx, "test", &aviatrix.AviatrixEdgeSpokeExternalDeviceConnArgs{
    			BgpLocalAsNum:  pulumi.String("123"),
    			BgpRemoteAsNum: pulumi.String("345"),
    			ConnectionName: pulumi.String("conn"),
    			GwName:         pulumi.String("eaas"),
    			LocalLanIp:     pulumi.String("10.230.3.23"),
    			RemoteLanIp:    pulumi.String("10.0.60.1"),
    			SiteId:         pulumi.String("site-abcd1234"),
    		})
    		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.AviatrixEdgeSpokeExternalDeviceConn;
    import com.pulumi.aviatrix.AviatrixEdgeSpokeExternalDeviceConnArgs;
    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 test = new AviatrixEdgeSpokeExternalDeviceConn("test", AviatrixEdgeSpokeExternalDeviceConnArgs.builder()        
                .bgpLocalAsNum("123")
                .bgpRemoteAsNum("345")
                .connectionName("conn")
                .gwName("eaas")
                .localLanIp("10.230.3.23")
                .remoteLanIp("10.0.60.1")
                .siteId("site-abcd1234")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Edge as a Spoke External Device Connection
    test = aviatrix.AviatrixEdgeSpokeExternalDeviceConn("test",
        bgp_local_as_num="123",
        bgp_remote_as_num="345",
        connection_name="conn",
        gw_name="eaas",
        local_lan_ip="10.230.3.23",
        remote_lan_ip="10.0.60.1",
        site_id="site-abcd1234")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create an Edge as a Spoke External Device Connection
    const test = new aviatrix.AviatrixEdgeSpokeExternalDeviceConn("test", {
        bgpLocalAsNum: "123",
        bgpRemoteAsNum: "345",
        connectionName: "conn",
        gwName: "eaas",
        localLanIp: "10.230.3.23",
        remoteLanIp: "10.0.60.1",
        siteId: "site-abcd1234",
    });
    
    resources:
      # Create an Edge as a Spoke External Device Connection
      test:
        type: aviatrix:AviatrixEdgeSpokeExternalDeviceConn
        properties:
          bgpLocalAsNum: '123'
          bgpRemoteAsNum: '345'
          connectionName: conn
          gwName: eaas
          localLanIp: 10.230.3.23
          remoteLanIp: 10.0.60.1
          siteId: site-abcd1234
    

    Create AviatrixEdgeSpokeExternalDeviceConn Resource

    new AviatrixEdgeSpokeExternalDeviceConn(name: string, args: AviatrixEdgeSpokeExternalDeviceConnArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixEdgeSpokeExternalDeviceConn(resource_name: str,
                                            opts: Optional[ResourceOptions] = None,
                                            bgp_local_as_num: Optional[str] = None,
                                            bgp_remote_as_num: Optional[str] = None,
                                            connection_name: Optional[str] = None,
                                            connection_type: Optional[str] = None,
                                            gw_name: Optional[str] = None,
                                            local_lan_ip: Optional[str] = None,
                                            remote_lan_ip: Optional[str] = None,
                                            site_id: Optional[str] = None,
                                            tunnel_protocol: Optional[str] = None)
    @overload
    def AviatrixEdgeSpokeExternalDeviceConn(resource_name: str,
                                            args: AviatrixEdgeSpokeExternalDeviceConnArgs,
                                            opts: Optional[ResourceOptions] = None)
    func NewAviatrixEdgeSpokeExternalDeviceConn(ctx *Context, name string, args AviatrixEdgeSpokeExternalDeviceConnArgs, opts ...ResourceOption) (*AviatrixEdgeSpokeExternalDeviceConn, error)
    public AviatrixEdgeSpokeExternalDeviceConn(string name, AviatrixEdgeSpokeExternalDeviceConnArgs args, CustomResourceOptions? opts = null)
    public AviatrixEdgeSpokeExternalDeviceConn(String name, AviatrixEdgeSpokeExternalDeviceConnArgs args)
    public AviatrixEdgeSpokeExternalDeviceConn(String name, AviatrixEdgeSpokeExternalDeviceConnArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixEdgeSpokeExternalDeviceConn
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AviatrixEdgeSpokeExternalDeviceConnArgs
    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 AviatrixEdgeSpokeExternalDeviceConnArgs
    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 AviatrixEdgeSpokeExternalDeviceConnArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixEdgeSpokeExternalDeviceConnArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixEdgeSpokeExternalDeviceConnArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AviatrixEdgeSpokeExternalDeviceConn 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 AviatrixEdgeSpokeExternalDeviceConn resource accepts the following input properties:

    BgpLocalAsNum string
    BGP local AS number.
    BgpRemoteAsNum string
    BGP remote AS number.
    ConnectionName string
    Connection name.
    GwName string
    Edge as a Spoke name.
    LocalLanIp string
    Local LAN IP.
    RemoteLanIp string
    Remote LAN IP.
    SiteId string
    Edge as a Spoke site iD.
    ConnectionType string
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    TunnelProtocol string
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    BgpLocalAsNum string
    BGP local AS number.
    BgpRemoteAsNum string
    BGP remote AS number.
    ConnectionName string
    Connection name.
    GwName string
    Edge as a Spoke name.
    LocalLanIp string
    Local LAN IP.
    RemoteLanIp string
    Remote LAN IP.
    SiteId string
    Edge as a Spoke site iD.
    ConnectionType string
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    TunnelProtocol string
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    bgpLocalAsNum String
    BGP local AS number.
    bgpRemoteAsNum String
    BGP remote AS number.
    connectionName String
    Connection name.
    gwName String
    Edge as a Spoke name.
    localLanIp String
    Local LAN IP.
    remoteLanIp String
    Remote LAN IP.
    siteId String
    Edge as a Spoke site iD.
    connectionType String
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    tunnelProtocol String
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    bgpLocalAsNum string
    BGP local AS number.
    bgpRemoteAsNum string
    BGP remote AS number.
    connectionName string
    Connection name.
    gwName string
    Edge as a Spoke name.
    localLanIp string
    Local LAN IP.
    remoteLanIp string
    Remote LAN IP.
    siteId string
    Edge as a Spoke site iD.
    connectionType string
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    tunnelProtocol string
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    bgp_local_as_num str
    BGP local AS number.
    bgp_remote_as_num str
    BGP remote AS number.
    connection_name str
    Connection name.
    gw_name str
    Edge as a Spoke name.
    local_lan_ip str
    Local LAN IP.
    remote_lan_ip str
    Remote LAN IP.
    site_id str
    Edge as a Spoke site iD.
    connection_type str
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    tunnel_protocol str
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    bgpLocalAsNum String
    BGP local AS number.
    bgpRemoteAsNum String
    BGP remote AS number.
    connectionName String
    Connection name.
    gwName String
    Edge as a Spoke name.
    localLanIp String
    Local LAN IP.
    remoteLanIp String
    Remote LAN IP.
    siteId String
    Edge as a Spoke site iD.
    connectionType String
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    tunnelProtocol String
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AviatrixEdgeSpokeExternalDeviceConn 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 AviatrixEdgeSpokeExternalDeviceConn Resource

    Get an existing AviatrixEdgeSpokeExternalDeviceConn 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?: AviatrixEdgeSpokeExternalDeviceConnState, opts?: CustomResourceOptions): AviatrixEdgeSpokeExternalDeviceConn
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bgp_local_as_num: Optional[str] = None,
            bgp_remote_as_num: Optional[str] = None,
            connection_name: Optional[str] = None,
            connection_type: Optional[str] = None,
            gw_name: Optional[str] = None,
            local_lan_ip: Optional[str] = None,
            remote_lan_ip: Optional[str] = None,
            site_id: Optional[str] = None,
            tunnel_protocol: Optional[str] = None) -> AviatrixEdgeSpokeExternalDeviceConn
    func GetAviatrixEdgeSpokeExternalDeviceConn(ctx *Context, name string, id IDInput, state *AviatrixEdgeSpokeExternalDeviceConnState, opts ...ResourceOption) (*AviatrixEdgeSpokeExternalDeviceConn, error)
    public static AviatrixEdgeSpokeExternalDeviceConn Get(string name, Input<string> id, AviatrixEdgeSpokeExternalDeviceConnState? state, CustomResourceOptions? opts = null)
    public static AviatrixEdgeSpokeExternalDeviceConn get(String name, Output<String> id, AviatrixEdgeSpokeExternalDeviceConnState 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:
    BgpLocalAsNum string
    BGP local AS number.
    BgpRemoteAsNum string
    BGP remote AS number.
    ConnectionName string
    Connection name.
    ConnectionType string
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    GwName string
    Edge as a Spoke name.
    LocalLanIp string
    Local LAN IP.
    RemoteLanIp string
    Remote LAN IP.
    SiteId string
    Edge as a Spoke site iD.
    TunnelProtocol string
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    BgpLocalAsNum string
    BGP local AS number.
    BgpRemoteAsNum string
    BGP remote AS number.
    ConnectionName string
    Connection name.
    ConnectionType string
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    GwName string
    Edge as a Spoke name.
    LocalLanIp string
    Local LAN IP.
    RemoteLanIp string
    Remote LAN IP.
    SiteId string
    Edge as a Spoke site iD.
    TunnelProtocol string
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    bgpLocalAsNum String
    BGP local AS number.
    bgpRemoteAsNum String
    BGP remote AS number.
    connectionName String
    Connection name.
    connectionType String
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    gwName String
    Edge as a Spoke name.
    localLanIp String
    Local LAN IP.
    remoteLanIp String
    Remote LAN IP.
    siteId String
    Edge as a Spoke site iD.
    tunnelProtocol String
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    bgpLocalAsNum string
    BGP local AS number.
    bgpRemoteAsNum string
    BGP remote AS number.
    connectionName string
    Connection name.
    connectionType string
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    gwName string
    Edge as a Spoke name.
    localLanIp string
    Local LAN IP.
    remoteLanIp string
    Remote LAN IP.
    siteId string
    Edge as a Spoke site iD.
    tunnelProtocol string
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    bgp_local_as_num str
    BGP local AS number.
    bgp_remote_as_num str
    BGP remote AS number.
    connection_name str
    Connection name.
    connection_type str
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    gw_name str
    Edge as a Spoke name.
    local_lan_ip str
    Local LAN IP.
    remote_lan_ip str
    Remote LAN IP.
    site_id str
    Edge as a Spoke site iD.
    tunnel_protocol str
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
    bgpLocalAsNum String
    BGP local AS number.
    bgpRemoteAsNum String
    BGP remote AS number.
    connectionName String
    Connection name.
    connectionType String
    Connection type. Valid value: 'bgp'. Default value: 'bgp'.
    gwName String
    Edge as a Spoke name.
    localLanIp String
    Local LAN IP.
    remoteLanIp String
    Remote LAN IP.
    siteId String
    Edge as a Spoke site iD.
    tunnelProtocol String
    Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.

    Import

    edge_spoke_external_device_conn can be imported using the connection_name and site_id, e.g.

     $ pulumi import aviatrix:index/aviatrixEdgeSpokeExternalDeviceConn:AviatrixEdgeSpokeExternalDeviceConn test connection_name~site_id
    

    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