aviatrix.AviatrixEdgeSpokeExternalDeviceConn
Explore with Pulumi AI
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AviatrixEdgeSpokeExternalDeviceConn(name: string, args: AviatrixEdgeSpokeExternalDeviceConnArgs, opts?: CustomResourceOptions);
@overload
def AviatrixEdgeSpokeExternalDeviceConn(resource_name: str,
args: AviatrixEdgeSpokeExternalDeviceConnArgs,
opts: Optional[ResourceOptions] = None)
@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,
gw_name: Optional[str] = None,
local_lan_ip: Optional[str] = None,
remote_lan_ip: Optional[str] = None,
site_id: Optional[str] = None,
connection_type: Optional[str] = None,
tunnel_protocol: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var aviatrixEdgeSpokeExternalDeviceConnResource = new Aviatrix.AviatrixEdgeSpokeExternalDeviceConn("aviatrixEdgeSpokeExternalDeviceConnResource", new()
{
BgpLocalAsNum = "string",
BgpRemoteAsNum = "string",
ConnectionName = "string",
GwName = "string",
LocalLanIp = "string",
RemoteLanIp = "string",
SiteId = "string",
ConnectionType = "string",
TunnelProtocol = "string",
});
example, err := aviatrix.NewAviatrixEdgeSpokeExternalDeviceConn(ctx, "aviatrixEdgeSpokeExternalDeviceConnResource", &aviatrix.AviatrixEdgeSpokeExternalDeviceConnArgs{
BgpLocalAsNum: pulumi.String("string"),
BgpRemoteAsNum: pulumi.String("string"),
ConnectionName: pulumi.String("string"),
GwName: pulumi.String("string"),
LocalLanIp: pulumi.String("string"),
RemoteLanIp: pulumi.String("string"),
SiteId: pulumi.String("string"),
ConnectionType: pulumi.String("string"),
TunnelProtocol: pulumi.String("string"),
})
var aviatrixEdgeSpokeExternalDeviceConnResource = new AviatrixEdgeSpokeExternalDeviceConn("aviatrixEdgeSpokeExternalDeviceConnResource", AviatrixEdgeSpokeExternalDeviceConnArgs.builder()
.bgpLocalAsNum("string")
.bgpRemoteAsNum("string")
.connectionName("string")
.gwName("string")
.localLanIp("string")
.remoteLanIp("string")
.siteId("string")
.connectionType("string")
.tunnelProtocol("string")
.build());
aviatrix_edge_spoke_external_device_conn_resource = aviatrix.AviatrixEdgeSpokeExternalDeviceConn("aviatrixEdgeSpokeExternalDeviceConnResource",
bgp_local_as_num="string",
bgp_remote_as_num="string",
connection_name="string",
gw_name="string",
local_lan_ip="string",
remote_lan_ip="string",
site_id="string",
connection_type="string",
tunnel_protocol="string")
const aviatrixEdgeSpokeExternalDeviceConnResource = new aviatrix.AviatrixEdgeSpokeExternalDeviceConn("aviatrixEdgeSpokeExternalDeviceConnResource", {
bgpLocalAsNum: "string",
bgpRemoteAsNum: "string",
connectionName: "string",
gwName: "string",
localLanIp: "string",
remoteLanIp: "string",
siteId: "string",
connectionType: "string",
tunnelProtocol: "string",
});
type: aviatrix:AviatrixEdgeSpokeExternalDeviceConn
properties:
bgpLocalAsNum: string
bgpRemoteAsNum: string
connectionName: string
connectionType: string
gwName: string
localLanIp: string
remoteLanIp: string
siteId: string
tunnelProtocol: string
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:
- Bgp
Local stringAs Num - BGP local AS number.
- Bgp
Remote stringAs Num - BGP remote AS number.
- Connection
Name string - Connection name.
- Gw
Name string - Edge as a Spoke name.
- Local
Lan stringIp - Local LAN IP.
- Remote
Lan stringIp - Remote LAN IP.
- Site
Id string - Edge as a Spoke site iD.
- Connection
Type string - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- Tunnel
Protocol string - Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
- Bgp
Local stringAs Num - BGP local AS number.
- Bgp
Remote stringAs Num - BGP remote AS number.
- Connection
Name string - Connection name.
- Gw
Name string - Edge as a Spoke name.
- Local
Lan stringIp - Local LAN IP.
- Remote
Lan stringIp - Remote LAN IP.
- Site
Id string - Edge as a Spoke site iD.
- Connection
Type string - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- Tunnel
Protocol string - Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
- bgp
Local StringAs Num - BGP local AS number.
- bgp
Remote StringAs Num - BGP remote AS number.
- connection
Name String - Connection name.
- gw
Name String - Edge as a Spoke name.
- local
Lan StringIp - Local LAN IP.
- remote
Lan StringIp - Remote LAN IP.
- site
Id String - Edge as a Spoke site iD.
- connection
Type String - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- tunnel
Protocol String - Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
- bgp
Local stringAs Num - BGP local AS number.
- bgp
Remote stringAs Num - BGP remote AS number.
- connection
Name string - Connection name.
- gw
Name string - Edge as a Spoke name.
- local
Lan stringIp - Local LAN IP.
- remote
Lan stringIp - Remote LAN IP.
- site
Id string - Edge as a Spoke site iD.
- connection
Type string - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- tunnel
Protocol string - Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
- bgp_
local_ stras_ num - BGP local AS number.
- bgp_
remote_ stras_ num - BGP remote AS number.
- connection_
name str - Connection name.
- gw_
name str - Edge as a Spoke name.
- local_
lan_ strip - Local LAN IP.
- remote_
lan_ strip - 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.
- bgp
Local StringAs Num - BGP local AS number.
- bgp
Remote StringAs Num - BGP remote AS number.
- connection
Name String - Connection name.
- gw
Name String - Edge as a Spoke name.
- local
Lan StringIp - Local LAN IP.
- remote
Lan StringIp - Remote LAN IP.
- site
Id String - Edge as a Spoke site iD.
- connection
Type String - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- tunnel
Protocol 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.
- Bgp
Local stringAs Num - BGP local AS number.
- Bgp
Remote stringAs Num - BGP remote AS number.
- Connection
Name string - Connection name.
- Connection
Type string - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- Gw
Name string - Edge as a Spoke name.
- Local
Lan stringIp - Local LAN IP.
- Remote
Lan stringIp - Remote LAN IP.
- Site
Id string - Edge as a Spoke site iD.
- Tunnel
Protocol string - Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
- Bgp
Local stringAs Num - BGP local AS number.
- Bgp
Remote stringAs Num - BGP remote AS number.
- Connection
Name string - Connection name.
- Connection
Type string - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- Gw
Name string - Edge as a Spoke name.
- Local
Lan stringIp - Local LAN IP.
- Remote
Lan stringIp - Remote LAN IP.
- Site
Id string - Edge as a Spoke site iD.
- Tunnel
Protocol string - Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
- bgp
Local StringAs Num - BGP local AS number.
- bgp
Remote StringAs Num - BGP remote AS number.
- connection
Name String - Connection name.
- connection
Type String - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- gw
Name String - Edge as a Spoke name.
- local
Lan StringIp - Local LAN IP.
- remote
Lan StringIp - Remote LAN IP.
- site
Id String - Edge as a Spoke site iD.
- tunnel
Protocol String - Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
- bgp
Local stringAs Num - BGP local AS number.
- bgp
Remote stringAs Num - BGP remote AS number.
- connection
Name string - Connection name.
- connection
Type string - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- gw
Name string - Edge as a Spoke name.
- local
Lan stringIp - Local LAN IP.
- remote
Lan stringIp - Remote LAN IP.
- site
Id string - Edge as a Spoke site iD.
- tunnel
Protocol string - Tunnel protocol. Valid value: 'LAN'. Default value: 'LAN'. Case insensitive.
- bgp_
local_ stras_ num - BGP local AS number.
- bgp_
remote_ stras_ num - 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_ strip - Local LAN IP.
- remote_
lan_ strip - 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.
- bgp
Local StringAs Num - BGP local AS number.
- bgp
Remote StringAs Num - BGP remote AS number.
- connection
Name String - Connection name.
- connection
Type String - Connection type. Valid value: 'bgp'. Default value: 'bgp'.
- gw
Name String - Edge as a Spoke name.
- local
Lan StringIp - Local LAN IP.
- remote
Lan StringIp - Remote LAN IP.
- site
Id String - Edge as a Spoke site iD.
- tunnel
Protocol 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
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.