alicloud.vpc.BgpGroup
Explore with Pulumi AI
Provides a VPC Bgp Group resource.
For information about VPC Bgp Group and how to use it, see What is Bgp Group.
NOTE: Available since v1.152.0.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
import * as random from "@pulumi/random";
const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const example = alicloud.expressconnect.getPhysicalConnections({
nameRegex: "^preserved-NODELETING",
});
const vlanId = new random.index.Integer("vlan_id", {
max: 2999,
min: 1,
});
const exampleVirtualBorderRouter = new alicloud.expressconnect.VirtualBorderRouter("example", {
localGatewayIp: "10.0.0.1",
peerGatewayIp: "10.0.0.2",
peeringSubnetMask: "255.255.255.252",
physicalConnectionId: example.then(example => example.connections?.[0]?.id),
virtualBorderRouterName: name,
vlanId: vlanId.id,
minRxInterval: 1000,
minTxInterval: 1000,
detectMultiplier: 10,
});
const exampleBgpGroup = new alicloud.vpc.BgpGroup("example", {
authKey: "YourPassword+12345678",
bgpGroupName: name,
description: name,
peerAsn: 1111,
routerId: exampleVirtualBorderRouter.id,
isFakeAsn: true,
});
import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "tf-example"
example = alicloud.expressconnect.get_physical_connections(name_regex="^preserved-NODELETING")
vlan_id = random.index.Integer("vlan_id",
max=2999,
min=1)
example_virtual_border_router = alicloud.expressconnect.VirtualBorderRouter("example",
local_gateway_ip="10.0.0.1",
peer_gateway_ip="10.0.0.2",
peering_subnet_mask="255.255.255.252",
physical_connection_id=example.connections[0].id,
virtual_border_router_name=name,
vlan_id=vlan_id["id"],
min_rx_interval=1000,
min_tx_interval=1000,
detect_multiplier=10)
example_bgp_group = alicloud.vpc.BgpGroup("example",
auth_key="YourPassword+12345678",
bgp_group_name=name,
description=name,
peer_asn=1111,
router_id=example_virtual_border_router.id,
is_fake_asn=True)
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/expressconnect"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi-random/sdk/v4/go/random"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
example, err := expressconnect.GetPhysicalConnections(ctx, &expressconnect.GetPhysicalConnectionsArgs{
NameRegex: pulumi.StringRef("^preserved-NODELETING"),
}, nil)
if err != nil {
return err
}
vlanId, err := random.NewInteger(ctx, "vlan_id", &random.IntegerArgs{
Max: 2999,
Min: 1,
})
if err != nil {
return err
}
exampleVirtualBorderRouter, err := expressconnect.NewVirtualBorderRouter(ctx, "example", &expressconnect.VirtualBorderRouterArgs{
LocalGatewayIp: pulumi.String("10.0.0.1"),
PeerGatewayIp: pulumi.String("10.0.0.2"),
PeeringSubnetMask: pulumi.String("255.255.255.252"),
PhysicalConnectionId: pulumi.String(example.Connections[0].Id),
VirtualBorderRouterName: pulumi.String(name),
VlanId: vlanId.Id,
MinRxInterval: pulumi.Int(1000),
MinTxInterval: pulumi.Int(1000),
DetectMultiplier: pulumi.Int(10),
})
if err != nil {
return err
}
_, err = vpc.NewBgpGroup(ctx, "example", &vpc.BgpGroupArgs{
AuthKey: pulumi.String("YourPassword+12345678"),
BgpGroupName: pulumi.String(name),
Description: pulumi.String(name),
PeerAsn: pulumi.Int(1111),
RouterId: exampleVirtualBorderRouter.ID(),
IsFakeAsn: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
using Random = Pulumi.Random;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "tf-example";
var example = AliCloud.ExpressConnect.GetPhysicalConnections.Invoke(new()
{
NameRegex = "^preserved-NODELETING",
});
var vlanId = new Random.Index.Integer("vlan_id", new()
{
Max = 2999,
Min = 1,
});
var exampleVirtualBorderRouter = new AliCloud.ExpressConnect.VirtualBorderRouter("example", new()
{
LocalGatewayIp = "10.0.0.1",
PeerGatewayIp = "10.0.0.2",
PeeringSubnetMask = "255.255.255.252",
PhysicalConnectionId = example.Apply(getPhysicalConnectionsResult => getPhysicalConnectionsResult.Connections[0]?.Id),
VirtualBorderRouterName = name,
VlanId = vlanId.Id,
MinRxInterval = 1000,
MinTxInterval = 1000,
DetectMultiplier = 10,
});
var exampleBgpGroup = new AliCloud.Vpc.BgpGroup("example", new()
{
AuthKey = "YourPassword+12345678",
BgpGroupName = name,
Description = name,
PeerAsn = 1111,
RouterId = exampleVirtualBorderRouter.Id,
IsFakeAsn = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.expressconnect.ExpressconnectFunctions;
import com.pulumi.alicloud.expressconnect.inputs.GetPhysicalConnectionsArgs;
import com.pulumi.random.integer;
import com.pulumi.random.IntegerArgs;
import com.pulumi.alicloud.expressconnect.VirtualBorderRouter;
import com.pulumi.alicloud.expressconnect.VirtualBorderRouterArgs;
import com.pulumi.alicloud.vpc.BgpGroup;
import com.pulumi.alicloud.vpc.BgpGroupArgs;
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) {
final var config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var example = ExpressconnectFunctions.getPhysicalConnections(GetPhysicalConnectionsArgs.builder()
.nameRegex("^preserved-NODELETING")
.build());
var vlanId = new Integer("vlanId", IntegerArgs.builder()
.max(2999)
.min(1)
.build());
var exampleVirtualBorderRouter = new VirtualBorderRouter("exampleVirtualBorderRouter", VirtualBorderRouterArgs.builder()
.localGatewayIp("10.0.0.1")
.peerGatewayIp("10.0.0.2")
.peeringSubnetMask("255.255.255.252")
.physicalConnectionId(example.applyValue(getPhysicalConnectionsResult -> getPhysicalConnectionsResult.connections()[0].id()))
.virtualBorderRouterName(name)
.vlanId(vlanId.id())
.minRxInterval(1000)
.minTxInterval(1000)
.detectMultiplier(10)
.build());
var exampleBgpGroup = new BgpGroup("exampleBgpGroup", BgpGroupArgs.builder()
.authKey("YourPassword+12345678")
.bgpGroupName(name)
.description(name)
.peerAsn(1111)
.routerId(exampleVirtualBorderRouter.id())
.isFakeAsn(true)
.build());
}
}
configuration:
name:
type: string
default: tf-example
resources:
vlanId:
type: random:integer
name: vlan_id
properties:
max: 2999
min: 1
exampleVirtualBorderRouter:
type: alicloud:expressconnect:VirtualBorderRouter
name: example
properties:
localGatewayIp: 10.0.0.1
peerGatewayIp: 10.0.0.2
peeringSubnetMask: 255.255.255.252
physicalConnectionId: ${example.connections[0].id}
virtualBorderRouterName: ${name}
vlanId: ${vlanId.id}
minRxInterval: 1000
minTxInterval: 1000
detectMultiplier: 10
exampleBgpGroup:
type: alicloud:vpc:BgpGroup
name: example
properties:
authKey: YourPassword+12345678
bgpGroupName: ${name}
description: ${name}
peerAsn: 1111
routerId: ${exampleVirtualBorderRouter.id}
isFakeAsn: true
variables:
example:
fn::invoke:
Function: alicloud:expressconnect:getPhysicalConnections
Arguments:
nameRegex: ^preserved-NODELETING
Create BgpGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BgpGroup(name: string, args: BgpGroupArgs, opts?: CustomResourceOptions);
@overload
def BgpGroup(resource_name: str,
args: BgpGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BgpGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
peer_asn: Optional[int] = None,
router_id: Optional[str] = None,
auth_key: Optional[str] = None,
bgp_group_name: Optional[str] = None,
description: Optional[str] = None,
is_fake_asn: Optional[bool] = None,
local_asn: Optional[int] = None)
func NewBgpGroup(ctx *Context, name string, args BgpGroupArgs, opts ...ResourceOption) (*BgpGroup, error)
public BgpGroup(string name, BgpGroupArgs args, CustomResourceOptions? opts = null)
public BgpGroup(String name, BgpGroupArgs args)
public BgpGroup(String name, BgpGroupArgs args, CustomResourceOptions options)
type: alicloud:vpc:BgpGroup
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 BgpGroupArgs
- 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 BgpGroupArgs
- 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 BgpGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BgpGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BgpGroupArgs
- 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 bgpGroupResource = new AliCloud.Vpc.BgpGroup("bgpGroupResource", new()
{
PeerAsn = 0,
RouterId = "string",
AuthKey = "string",
BgpGroupName = "string",
Description = "string",
IsFakeAsn = false,
LocalAsn = 0,
});
example, err := vpc.NewBgpGroup(ctx, "bgpGroupResource", &vpc.BgpGroupArgs{
PeerAsn: pulumi.Int(0),
RouterId: pulumi.String("string"),
AuthKey: pulumi.String("string"),
BgpGroupName: pulumi.String("string"),
Description: pulumi.String("string"),
IsFakeAsn: pulumi.Bool(false),
LocalAsn: pulumi.Int(0),
})
var bgpGroupResource = new BgpGroup("bgpGroupResource", BgpGroupArgs.builder()
.peerAsn(0)
.routerId("string")
.authKey("string")
.bgpGroupName("string")
.description("string")
.isFakeAsn(false)
.localAsn(0)
.build());
bgp_group_resource = alicloud.vpc.BgpGroup("bgpGroupResource",
peer_asn=0,
router_id="string",
auth_key="string",
bgp_group_name="string",
description="string",
is_fake_asn=False,
local_asn=0)
const bgpGroupResource = new alicloud.vpc.BgpGroup("bgpGroupResource", {
peerAsn: 0,
routerId: "string",
authKey: "string",
bgpGroupName: "string",
description: "string",
isFakeAsn: false,
localAsn: 0,
});
type: alicloud:vpc:BgpGroup
properties:
authKey: string
bgpGroupName: string
description: string
isFakeAsn: false
localAsn: 0
peerAsn: 0
routerId: string
BgpGroup 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 BgpGroup resource accepts the following input properties:
- Peer
Asn int - The AS number of the BGP peer.
- Router
Id string - The ID of the VBR.
- Auth
Key string - The authentication key of the BGP group.
- Bgp
Group stringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - Description string
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - Is
Fake boolAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- Local
Asn int - The AS number on the Alibaba Cloud side.
- Peer
Asn int - The AS number of the BGP peer.
- Router
Id string - The ID of the VBR.
- Auth
Key string - The authentication key of the BGP group.
- Bgp
Group stringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - Description string
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - Is
Fake boolAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- Local
Asn int - The AS number on the Alibaba Cloud side.
- peer
Asn Integer - The AS number of the BGP peer.
- router
Id String - The ID of the VBR.
- auth
Key String - The authentication key of the BGP group.
- bgp
Group StringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - description String
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - is
Fake BooleanAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- local
Asn Integer - The AS number on the Alibaba Cloud side.
- peer
Asn number - The AS number of the BGP peer.
- router
Id string - The ID of the VBR.
- auth
Key string - The authentication key of the BGP group.
- bgp
Group stringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - description string
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - is
Fake booleanAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- local
Asn number - The AS number on the Alibaba Cloud side.
- peer_
asn int - The AS number of the BGP peer.
- router_
id str - The ID of the VBR.
- auth_
key str - The authentication key of the BGP group.
- bgp_
group_ strname - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - description str
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - is_
fake_ boolasn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- local_
asn int - The AS number on the Alibaba Cloud side.
- peer
Asn Number - The AS number of the BGP peer.
- router
Id String - The ID of the VBR.
- auth
Key String - The authentication key of the BGP group.
- bgp
Group StringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - description String
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - is
Fake BooleanAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- local
Asn Number - The AS number on the Alibaba Cloud side.
Outputs
All input properties are implicitly available as output properties. Additionally, the BgpGroup resource produces the following output properties:
Look up Existing BgpGroup Resource
Get an existing BgpGroup 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?: BgpGroupState, opts?: CustomResourceOptions): BgpGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth_key: Optional[str] = None,
bgp_group_name: Optional[str] = None,
description: Optional[str] = None,
is_fake_asn: Optional[bool] = None,
local_asn: Optional[int] = None,
peer_asn: Optional[int] = None,
router_id: Optional[str] = None,
status: Optional[str] = None) -> BgpGroup
func GetBgpGroup(ctx *Context, name string, id IDInput, state *BgpGroupState, opts ...ResourceOption) (*BgpGroup, error)
public static BgpGroup Get(string name, Input<string> id, BgpGroupState? state, CustomResourceOptions? opts = null)
public static BgpGroup get(String name, Output<String> id, BgpGroupState 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.
- Auth
Key string - The authentication key of the BGP group.
- Bgp
Group stringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - Description string
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - Is
Fake boolAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- Local
Asn int - The AS number on the Alibaba Cloud side.
- Peer
Asn int - The AS number of the BGP peer.
- Router
Id string - The ID of the VBR.
- Status string
- The status of the resource.
- Auth
Key string - The authentication key of the BGP group.
- Bgp
Group stringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - Description string
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - Is
Fake boolAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- Local
Asn int - The AS number on the Alibaba Cloud side.
- Peer
Asn int - The AS number of the BGP peer.
- Router
Id string - The ID of the VBR.
- Status string
- The status of the resource.
- auth
Key String - The authentication key of the BGP group.
- bgp
Group StringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - description String
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - is
Fake BooleanAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- local
Asn Integer - The AS number on the Alibaba Cloud side.
- peer
Asn Integer - The AS number of the BGP peer.
- router
Id String - The ID of the VBR.
- status String
- The status of the resource.
- auth
Key string - The authentication key of the BGP group.
- bgp
Group stringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - description string
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - is
Fake booleanAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- local
Asn number - The AS number on the Alibaba Cloud side.
- peer
Asn number - The AS number of the BGP peer.
- router
Id string - The ID of the VBR.
- status string
- The status of the resource.
- auth_
key str - The authentication key of the BGP group.
- bgp_
group_ strname - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - description str
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - is_
fake_ boolasn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- local_
asn int - The AS number on the Alibaba Cloud side.
- peer_
asn int - The AS number of the BGP peer.
- router_
id str - The ID of the VBR.
- status str
- The status of the resource.
- auth
Key String - The authentication key of the BGP group.
- bgp
Group StringName - The name of the BGP group. The name must be
2
to128
characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start withhttp://
orhttps://
. - description String
- The description of the BGP group. The description must be
2
to256
characters in length. It must start with a letter but cannot start withhttp://
orhttps://
. - is
Fake BooleanAsn - The is fake asn. A router that runs BGP typically belongs to only one AS. In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.
- local
Asn Number - The AS number on the Alibaba Cloud side.
- peer
Asn Number - The AS number of the BGP peer.
- router
Id String - The ID of the VBR.
- status String
- The status of the resource.
Import
VPC Bgp Group can be imported using the id, e.g.
$ pulumi import alicloud:vpc/bgpGroup:BgpGroup example <id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.