vkcs.DcBgpNeighbor
Explore with Pulumi AI
Manages a direct connect BGP neighbor resource.
Note: This resource requires Sprut SDN to be enabled in your project.
New since v0.5.0.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as vkcs from "@pulumi/vkcs";
const dcBgpNeighbor = new vkcs.DcBgpNeighbor("dcBgpNeighbor", {
addPaths: "on",
description: "tf-example-description",
dcBgpId: vkcs_dc_bgp_instance.dc_bgp_instance.id,
remoteAsn: 1,
remoteIp: "192.168.1.3",
});
import pulumi
import pulumi_vkcs as vkcs
dc_bgp_neighbor = vkcs.DcBgpNeighbor("dcBgpNeighbor",
add_paths="on",
description="tf-example-description",
dc_bgp_id=vkcs_dc_bgp_instance["dc_bgp_instance"]["id"],
remote_asn=1,
remote_ip="192.168.1.3")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vkcs.NewDcBgpNeighbor(ctx, "dcBgpNeighbor", &vkcs.DcBgpNeighborArgs{
AddPaths: pulumi.String("on"),
Description: pulumi.String("tf-example-description"),
DcBgpId: pulumi.Any(vkcs_dc_bgp_instance.Dc_bgp_instance.Id),
RemoteAsn: pulumi.Float64(1),
RemoteIp: pulumi.String("192.168.1.3"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;
return await Deployment.RunAsync(() =>
{
var dcBgpNeighbor = new Vkcs.DcBgpNeighbor("dcBgpNeighbor", new()
{
AddPaths = "on",
Description = "tf-example-description",
DcBgpId = vkcs_dc_bgp_instance.Dc_bgp_instance.Id,
RemoteAsn = 1,
RemoteIp = "192.168.1.3",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.DcBgpNeighbor;
import com.pulumi.vkcs.DcBgpNeighborArgs;
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 dcBgpNeighbor = new DcBgpNeighbor("dcBgpNeighbor", DcBgpNeighborArgs.builder()
.addPaths("on")
.description("tf-example-description")
.dcBgpId(vkcs_dc_bgp_instance.dc_bgp_instance().id())
.remoteAsn(1)
.remoteIp("192.168.1.3")
.build());
}
}
resources:
dcBgpNeighbor:
type: vkcs:DcBgpNeighbor
properties:
addPaths: on
description: tf-example-description
dcBgpId: ${vkcs_dc_bgp_instance.dc_bgp_instance.id}
remoteAsn: 1
remoteIp: 192.168.1.3
Create DcBgpNeighbor Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DcBgpNeighbor(name: string, args: DcBgpNeighborArgs, opts?: CustomResourceOptions);
@overload
def DcBgpNeighbor(resource_name: str,
args: DcBgpNeighborArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DcBgpNeighbor(resource_name: str,
opts: Optional[ResourceOptions] = None,
dc_bgp_id: Optional[str] = None,
remote_asn: Optional[float] = None,
remote_ip: Optional[str] = None,
add_paths: Optional[str] = None,
bfd_enabled: Optional[bool] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
filter_in: Optional[str] = None,
filter_out: Optional[str] = None,
force_ibgp_next_hop_self: Optional[bool] = None,
name: Optional[str] = None,
region: Optional[str] = None)
func NewDcBgpNeighbor(ctx *Context, name string, args DcBgpNeighborArgs, opts ...ResourceOption) (*DcBgpNeighbor, error)
public DcBgpNeighbor(string name, DcBgpNeighborArgs args, CustomResourceOptions? opts = null)
public DcBgpNeighbor(String name, DcBgpNeighborArgs args)
public DcBgpNeighbor(String name, DcBgpNeighborArgs args, CustomResourceOptions options)
type: vkcs:DcBgpNeighbor
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 DcBgpNeighborArgs
- 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 DcBgpNeighborArgs
- 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 DcBgpNeighborArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DcBgpNeighborArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DcBgpNeighborArgs
- 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 dcBgpNeighborResource = new Vkcs.DcBgpNeighbor("dcBgpNeighborResource", new()
{
DcBgpId = "string",
RemoteAsn = 0,
RemoteIp = "string",
AddPaths = "string",
BfdEnabled = false,
Description = "string",
Enabled = false,
FilterIn = "string",
FilterOut = "string",
ForceIbgpNextHopSelf = false,
Name = "string",
Region = "string",
});
example, err := vkcs.NewDcBgpNeighbor(ctx, "dcBgpNeighborResource", &vkcs.DcBgpNeighborArgs{
DcBgpId: pulumi.String("string"),
RemoteAsn: pulumi.Float64(0),
RemoteIp: pulumi.String("string"),
AddPaths: pulumi.String("string"),
BfdEnabled: pulumi.Bool(false),
Description: pulumi.String("string"),
Enabled: pulumi.Bool(false),
FilterIn: pulumi.String("string"),
FilterOut: pulumi.String("string"),
ForceIbgpNextHopSelf: pulumi.Bool(false),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
})
var dcBgpNeighborResource = new DcBgpNeighbor("dcBgpNeighborResource", DcBgpNeighborArgs.builder()
.dcBgpId("string")
.remoteAsn(0)
.remoteIp("string")
.addPaths("string")
.bfdEnabled(false)
.description("string")
.enabled(false)
.filterIn("string")
.filterOut("string")
.forceIbgpNextHopSelf(false)
.name("string")
.region("string")
.build());
dc_bgp_neighbor_resource = vkcs.DcBgpNeighbor("dcBgpNeighborResource",
dc_bgp_id="string",
remote_asn=0,
remote_ip="string",
add_paths="string",
bfd_enabled=False,
description="string",
enabled=False,
filter_in="string",
filter_out="string",
force_ibgp_next_hop_self=False,
name="string",
region="string")
const dcBgpNeighborResource = new vkcs.DcBgpNeighbor("dcBgpNeighborResource", {
dcBgpId: "string",
remoteAsn: 0,
remoteIp: "string",
addPaths: "string",
bfdEnabled: false,
description: "string",
enabled: false,
filterIn: "string",
filterOut: "string",
forceIbgpNextHopSelf: false,
name: "string",
region: "string",
});
type: vkcs:DcBgpNeighbor
properties:
addPaths: string
bfdEnabled: false
dcBgpId: string
description: string
enabled: false
filterIn: string
filterOut: string
forceIbgpNextHopSelf: false
name: string
region: string
remoteAsn: 0
remoteIp: string
DcBgpNeighbor 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 DcBgpNeighbor resource accepts the following input properties:
- Dc
Bgp stringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- Remote
Asn double - required number → BGP Neighbor ASN. Changing this creates a new resource
- Remote
Ip string - required string → BGP Neighbor IP address. Changing this creates a new resource
- Add
Paths string - optional string → Activate BGP Add-Paths feature on peer. Default is off
- Bfd
Enabled bool - optional boolean → Control BGP session activity with BFD protocol. Default is false
- Description string
- optional string → Description of the BGP neighbor
- Enabled bool
- optional boolean → Enable or disable item. Default is true
- Filter
In string - optional string → Input filter that pass incoming BGP prefixes (allow any)
- Filter
Out string - optional string → Output filter that pass incoming BGP prefixes (allow any)
- Force
Ibgp boolNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- Name string
- optional string → Name of the BGP neighbor
- Region string
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
.
- Dc
Bgp stringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- Remote
Asn float64 - required number → BGP Neighbor ASN. Changing this creates a new resource
- Remote
Ip string - required string → BGP Neighbor IP address. Changing this creates a new resource
- Add
Paths string - optional string → Activate BGP Add-Paths feature on peer. Default is off
- Bfd
Enabled bool - optional boolean → Control BGP session activity with BFD protocol. Default is false
- Description string
- optional string → Description of the BGP neighbor
- Enabled bool
- optional boolean → Enable or disable item. Default is true
- Filter
In string - optional string → Input filter that pass incoming BGP prefixes (allow any)
- Filter
Out string - optional string → Output filter that pass incoming BGP prefixes (allow any)
- Force
Ibgp boolNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- Name string
- optional string → Name of the BGP neighbor
- Region string
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
.
- dc
Bgp StringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- remote
Asn Double - required number → BGP Neighbor ASN. Changing this creates a new resource
- remote
Ip String - required string → BGP Neighbor IP address. Changing this creates a new resource
- add
Paths String - optional string → Activate BGP Add-Paths feature on peer. Default is off
- bfd
Enabled Boolean - optional boolean → Control BGP session activity with BFD protocol. Default is false
- description String
- optional string → Description of the BGP neighbor
- enabled Boolean
- optional boolean → Enable or disable item. Default is true
- filter
In String - optional string → Input filter that pass incoming BGP prefixes (allow any)
- filter
Out String - optional string → Output filter that pass incoming BGP prefixes (allow any)
- force
Ibgp BooleanNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- name String
- optional string → Name of the BGP neighbor
- region String
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
.
- dc
Bgp stringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- remote
Asn number - required number → BGP Neighbor ASN. Changing this creates a new resource
- remote
Ip string - required string → BGP Neighbor IP address. Changing this creates a new resource
- add
Paths string - optional string → Activate BGP Add-Paths feature on peer. Default is off
- bfd
Enabled boolean - optional boolean → Control BGP session activity with BFD protocol. Default is false
- description string
- optional string → Description of the BGP neighbor
- enabled boolean
- optional boolean → Enable or disable item. Default is true
- filter
In string - optional string → Input filter that pass incoming BGP prefixes (allow any)
- filter
Out string - optional string → Output filter that pass incoming BGP prefixes (allow any)
- force
Ibgp booleanNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- name string
- optional string → Name of the BGP neighbor
- region string
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
.
- dc_
bgp_ strid - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- remote_
asn float - required number → BGP Neighbor ASN. Changing this creates a new resource
- remote_
ip str - required string → BGP Neighbor IP address. Changing this creates a new resource
- add_
paths str - optional string → Activate BGP Add-Paths feature on peer. Default is off
- bfd_
enabled bool - optional boolean → Control BGP session activity with BFD protocol. Default is false
- description str
- optional string → Description of the BGP neighbor
- enabled bool
- optional boolean → Enable or disable item. Default is true
- filter_
in str - optional string → Input filter that pass incoming BGP prefixes (allow any)
- filter_
out str - optional string → Output filter that pass incoming BGP prefixes (allow any)
- force_
ibgp_ boolnext_ hop_ self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- name str
- optional string → Name of the BGP neighbor
- region str
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
.
- dc
Bgp StringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- remote
Asn Number - required number → BGP Neighbor ASN. Changing this creates a new resource
- remote
Ip String - required string → BGP Neighbor IP address. Changing this creates a new resource
- add
Paths String - optional string → Activate BGP Add-Paths feature on peer. Default is off
- bfd
Enabled Boolean - optional boolean → Control BGP session activity with BFD protocol. Default is false
- description String
- optional string → Description of the BGP neighbor
- enabled Boolean
- optional boolean → Enable or disable item. Default is true
- filter
In String - optional string → Input filter that pass incoming BGP prefixes (allow any)
- filter
Out String - optional string → Output filter that pass incoming BGP prefixes (allow any)
- force
Ibgp BooleanNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- name String
- optional string → Name of the BGP neighbor
- region String
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
.
Outputs
All input properties are implicitly available as output properties. Additionally, the DcBgpNeighbor resource produces the following output properties:
- created_
at str - string → Creation timestamp
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - string → Update timestamp
Look up Existing DcBgpNeighbor Resource
Get an existing DcBgpNeighbor 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?: DcBgpNeighborState, opts?: CustomResourceOptions): DcBgpNeighbor
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
add_paths: Optional[str] = None,
bfd_enabled: Optional[bool] = None,
created_at: Optional[str] = None,
dc_bgp_id: Optional[str] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
filter_in: Optional[str] = None,
filter_out: Optional[str] = None,
force_ibgp_next_hop_self: Optional[bool] = None,
name: Optional[str] = None,
region: Optional[str] = None,
remote_asn: Optional[float] = None,
remote_ip: Optional[str] = None,
updated_at: Optional[str] = None) -> DcBgpNeighbor
func GetDcBgpNeighbor(ctx *Context, name string, id IDInput, state *DcBgpNeighborState, opts ...ResourceOption) (*DcBgpNeighbor, error)
public static DcBgpNeighbor Get(string name, Input<string> id, DcBgpNeighborState? state, CustomResourceOptions? opts = null)
public static DcBgpNeighbor get(String name, Output<String> id, DcBgpNeighborState state, CustomResourceOptions options)
resources: _: type: vkcs:DcBgpNeighbor get: id: ${id}
- 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.
- Add
Paths string - optional string → Activate BGP Add-Paths feature on peer. Default is off
- Bfd
Enabled bool - optional boolean → Control BGP session activity with BFD protocol. Default is false
- Created
At string - string → Creation timestamp
- Dc
Bgp stringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- Description string
- optional string → Description of the BGP neighbor
- Enabled bool
- optional boolean → Enable or disable item. Default is true
- Filter
In string - optional string → Input filter that pass incoming BGP prefixes (allow any)
- Filter
Out string - optional string → Output filter that pass incoming BGP prefixes (allow any)
- Force
Ibgp boolNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- Name string
- optional string → Name of the BGP neighbor
- Region string
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
. - Remote
Asn double - required number → BGP Neighbor ASN. Changing this creates a new resource
- Remote
Ip string - required string → BGP Neighbor IP address. Changing this creates a new resource
- Updated
At string - string → Update timestamp
- Add
Paths string - optional string → Activate BGP Add-Paths feature on peer. Default is off
- Bfd
Enabled bool - optional boolean → Control BGP session activity with BFD protocol. Default is false
- Created
At string - string → Creation timestamp
- Dc
Bgp stringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- Description string
- optional string → Description of the BGP neighbor
- Enabled bool
- optional boolean → Enable or disable item. Default is true
- Filter
In string - optional string → Input filter that pass incoming BGP prefixes (allow any)
- Filter
Out string - optional string → Output filter that pass incoming BGP prefixes (allow any)
- Force
Ibgp boolNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- Name string
- optional string → Name of the BGP neighbor
- Region string
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
. - Remote
Asn float64 - required number → BGP Neighbor ASN. Changing this creates a new resource
- Remote
Ip string - required string → BGP Neighbor IP address. Changing this creates a new resource
- Updated
At string - string → Update timestamp
- add
Paths String - optional string → Activate BGP Add-Paths feature on peer. Default is off
- bfd
Enabled Boolean - optional boolean → Control BGP session activity with BFD protocol. Default is false
- created
At String - string → Creation timestamp
- dc
Bgp StringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- description String
- optional string → Description of the BGP neighbor
- enabled Boolean
- optional boolean → Enable or disable item. Default is true
- filter
In String - optional string → Input filter that pass incoming BGP prefixes (allow any)
- filter
Out String - optional string → Output filter that pass incoming BGP prefixes (allow any)
- force
Ibgp BooleanNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- name String
- optional string → Name of the BGP neighbor
- region String
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
. - remote
Asn Double - required number → BGP Neighbor ASN. Changing this creates a new resource
- remote
Ip String - required string → BGP Neighbor IP address. Changing this creates a new resource
- updated
At String - string → Update timestamp
- add
Paths string - optional string → Activate BGP Add-Paths feature on peer. Default is off
- bfd
Enabled boolean - optional boolean → Control BGP session activity with BFD protocol. Default is false
- created
At string - string → Creation timestamp
- dc
Bgp stringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- description string
- optional string → Description of the BGP neighbor
- enabled boolean
- optional boolean → Enable or disable item. Default is true
- filter
In string - optional string → Input filter that pass incoming BGP prefixes (allow any)
- filter
Out string - optional string → Output filter that pass incoming BGP prefixes (allow any)
- force
Ibgp booleanNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- name string
- optional string → Name of the BGP neighbor
- region string
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
. - remote
Asn number - required number → BGP Neighbor ASN. Changing this creates a new resource
- remote
Ip string - required string → BGP Neighbor IP address. Changing this creates a new resource
- updated
At string - string → Update timestamp
- add_
paths str - optional string → Activate BGP Add-Paths feature on peer. Default is off
- bfd_
enabled bool - optional boolean → Control BGP session activity with BFD protocol. Default is false
- created_
at str - string → Creation timestamp
- dc_
bgp_ strid - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- description str
- optional string → Description of the BGP neighbor
- enabled bool
- optional boolean → Enable or disable item. Default is true
- filter_
in str - optional string → Input filter that pass incoming BGP prefixes (allow any)
- filter_
out str - optional string → Output filter that pass incoming BGP prefixes (allow any)
- force_
ibgp_ boolnext_ hop_ self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- name str
- optional string → Name of the BGP neighbor
- region str
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
. - remote_
asn float - required number → BGP Neighbor ASN. Changing this creates a new resource
- remote_
ip str - required string → BGP Neighbor IP address. Changing this creates a new resource
- updated_
at str - string → Update timestamp
- add
Paths String - optional string → Activate BGP Add-Paths feature on peer. Default is off
- bfd
Enabled Boolean - optional boolean → Control BGP session activity with BFD protocol. Default is false
- created
At String - string → Creation timestamp
- dc
Bgp StringId - required string → Direct Connect BGP ID to attach. Changing this creates a new resource
- description String
- optional string → Description of the BGP neighbor
- enabled Boolean
- optional boolean → Enable or disable item. Default is true
- filter
In String - optional string → Input filter that pass incoming BGP prefixes (allow any)
- filter
Out String - optional string → Output filter that pass incoming BGP prefixes (allow any)
- force
Ibgp BooleanNext Hop Self - optional boolean → Force set IP address of next-hop on BGP prefix to self even in iBGP. Default is false
- name String
- optional string → Name of the BGP neighbor
- region String
- optional string → The
region
to fetch availability zones from, defaults to the provider'sregion
. - remote
Asn Number - required number → BGP Neighbor ASN. Changing this creates a new resource
- remote
Ip String - required string → BGP Neighbor IP address. Changing this creates a new resource
- updated
At String - string → Update timestamp
Import
Direct connect BGP neighbor can be imported using the id
, e.g.
$ pulumi import vkcs:index/dcBgpNeighbor:DcBgpNeighbor mydcbgpneighbor 73096185-f200-4790-8095-962617b755f8
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- vkcs vk-cs/terraform-provider-vkcs
- License
- Notes
- This Pulumi package is based on the
vkcs
Terraform Provider.