Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Openstack Provider
  3. API Docs
  4. BgpvpnRouterAssociateV2
OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi
pulumi/pulumi-openstack

openstack.BgpvpnRouterAssociateV2

Explore with Pulumi AI

openstack logo
OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi
pulumi/pulumi-openstack

    Manages a V2 BGP VPN router association resource within OpenStack.

    Example Usage

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

const association1 = new openstack.BgpvpnRouterAssociateV2("association_1", {
    bgpvpnId: "d57d39e1-dc63-44fd-8cbd-a4e1488100c5",
    routerId: "423fa80f-e0d7-4d02-a9a5-8b8c05812bf6",
});

    import pulumi
import pulumi_openstack as openstack

association1 = openstack.BgpvpnRouterAssociateV2("association_1",
    bgpvpn_id="d57d39e1-dc63-44fd-8cbd-a4e1488100c5",
    router_id="423fa80f-e0d7-4d02-a9a5-8b8c05812bf6")

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v4/go/openstack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := openstack.NewBgpvpnRouterAssociateV2(ctx, "association_1", &openstack.BgpvpnRouterAssociateV2Args{
			BgpvpnId: pulumi.String("d57d39e1-dc63-44fd-8cbd-a4e1488100c5"),
			RouterId: pulumi.String("423fa80f-e0d7-4d02-a9a5-8b8c05812bf6"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var association1 = new OpenStack.BgpvpnRouterAssociateV2("association_1", new()
    {
        BgpvpnId = "d57d39e1-dc63-44fd-8cbd-a4e1488100c5",
        RouterId = "423fa80f-e0d7-4d02-a9a5-8b8c05812bf6",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.BgpvpnRouterAssociateV2;
import com.pulumi.openstack.BgpvpnRouterAssociateV2Args;
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 association1 = new BgpvpnRouterAssociateV2("association1", BgpvpnRouterAssociateV2Args.builder()
            .bgpvpnId("d57d39e1-dc63-44fd-8cbd-a4e1488100c5")
            .routerId("423fa80f-e0d7-4d02-a9a5-8b8c05812bf6")
            .build());

    }
}

    resources:
  association1:
    type: openstack:BgpvpnRouterAssociateV2
    name: association_1
    properties:
      bgpvpnId: d57d39e1-dc63-44fd-8cbd-a4e1488100c5
      routerId: 423fa80f-e0d7-4d02-a9a5-8b8c05812bf6

    Create BgpvpnRouterAssociateV2 Resource

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

    Constructor syntax

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

@overload
def BgpvpnRouterAssociateV2(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            bgpvpn_id: Optional[str] = None,
                            router_id: Optional[str] = None,
                            advertise_extra_routes: Optional[bool] = None,
                            project_id: Optional[str] = None,
                            region: Optional[str] = None)
    func NewBgpvpnRouterAssociateV2(ctx *Context, name string, args BgpvpnRouterAssociateV2Args, opts ...ResourceOption) (*BgpvpnRouterAssociateV2, error)
    public BgpvpnRouterAssociateV2(string name, BgpvpnRouterAssociateV2Args args, CustomResourceOptions? opts = null)
    public BgpvpnRouterAssociateV2(String name, BgpvpnRouterAssociateV2Args args)
public BgpvpnRouterAssociateV2(String name, BgpvpnRouterAssociateV2Args args, CustomResourceOptions options)

    type: openstack:BgpvpnRouterAssociateV2
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 BgpvpnRouterAssociateV2Args
    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 BgpvpnRouterAssociateV2Args
    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 BgpvpnRouterAssociateV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpvpnRouterAssociateV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpvpnRouterAssociateV2Args
    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 bgpvpnRouterAssociateV2Resource = new OpenStack.BgpvpnRouterAssociateV2("bgpvpnRouterAssociateV2Resource", new()
{
    BgpvpnId = "string",
    RouterId = "string",
    AdvertiseExtraRoutes = false,
    ProjectId = "string",
    Region = "string",
});

    example, err := openstack.NewBgpvpnRouterAssociateV2(ctx, "bgpvpnRouterAssociateV2Resource", &openstack.BgpvpnRouterAssociateV2Args{
	BgpvpnId:             pulumi.String("string"),
	RouterId:             pulumi.String("string"),
	AdvertiseExtraRoutes: pulumi.Bool(false),
	ProjectId:            pulumi.String("string"),
	Region:               pulumi.String("string"),
})

    var bgpvpnRouterAssociateV2Resource = new BgpvpnRouterAssociateV2("bgpvpnRouterAssociateV2Resource", BgpvpnRouterAssociateV2Args.builder()
    .bgpvpnId("string")
    .routerId("string")
    .advertiseExtraRoutes(false)
    .projectId("string")
    .region("string")
    .build());

    bgpvpn_router_associate_v2_resource = openstack.BgpvpnRouterAssociateV2("bgpvpnRouterAssociateV2Resource",
    bgpvpn_id="string",
    router_id="string",
    advertise_extra_routes=False,
    project_id="string",
    region="string")

    const bgpvpnRouterAssociateV2Resource = new openstack.BgpvpnRouterAssociateV2("bgpvpnRouterAssociateV2Resource", {
    bgpvpnId: "string",
    routerId: "string",
    advertiseExtraRoutes: false,
    projectId: "string",
    region: "string",
});

    type: openstack:BgpvpnRouterAssociateV2
properties:
    advertiseExtraRoutes: false
    bgpvpnId: string
    projectId: string
    region: string
    routerId: string

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

    BgpvpnId string
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    RouterId string
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    AdvertiseExtraRoutes bool
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    ProjectId string
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    BgpvpnId string
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    RouterId string
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    AdvertiseExtraRoutes bool
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    ProjectId string
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    bgpvpnId String
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    routerId String
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    advertiseExtraRoutes Boolean
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    projectId String
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    bgpvpnId string
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    routerId string
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    advertiseExtraRoutes boolean
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    projectId string
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    bgpvpn_id str
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    router_id str
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    bool
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    project_id str
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    bgpvpnId String
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    routerId String
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    advertiseExtraRoutes Boolean
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    projectId String
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.

    Outputs

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

    Get an existing BgpvpnRouterAssociateV2 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?: BgpvpnRouterAssociateV2State, opts?: CustomResourceOptions): BgpvpnRouterAssociateV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advertise_extra_routes: Optional[bool] = None,
        bgpvpn_id: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        router_id: Optional[str] = None) -> BgpvpnRouterAssociateV2
    func GetBgpvpnRouterAssociateV2(ctx *Context, name string, id IDInput, state *BgpvpnRouterAssociateV2State, opts ...ResourceOption) (*BgpvpnRouterAssociateV2, error)
    public static BgpvpnRouterAssociateV2 Get(string name, Input<string> id, BgpvpnRouterAssociateV2State? state, CustomResourceOptions? opts = null)
    public static BgpvpnRouterAssociateV2 get(String name, Output<String> id, BgpvpnRouterAssociateV2State 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:
    AdvertiseExtraRoutes bool
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    BgpvpnId string
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    ProjectId string
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    RouterId string
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    AdvertiseExtraRoutes bool
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    BgpvpnId string
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    ProjectId string
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    RouterId string
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    advertiseExtraRoutes Boolean
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    bgpvpnId String
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    projectId String
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    routerId String
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    advertiseExtraRoutes boolean
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    bgpvpnId string
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    projectId string
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    routerId string
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    advertise_extra_routes bool
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    bgpvpn_id str
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    project_id str
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    router_id str
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.
    advertiseExtraRoutes Boolean
    A boolean flag indicating whether extra routes should be advertised. Defaults to true.
    bgpvpnId String
    The ID of the BGP VPN to which the router will be associated. Changing this creates a new BGP VPN router association.
    projectId String
    The ID of the project that owns the BGP VPN router association. Only administrative and users with advsvc role can specify a project ID other than their own. Changing this creates a new BGP VPN router association.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a BGP VPN router association. If omitted, the region argument of the provider is used. Changing this creates a new BGP VPN router association.
    routerId String
    The ID of the router to be associated with the BGP VPN. Changing this creates a new BGP VPN router association.

    Import

    BGP VPN router associations can be imported using the BGP VPN ID and BGP VPN

    router association ID separated by a slash, e.g.:

    hcl

    $ pulumi import openstack:index/bgpvpnRouterAssociateV2:BgpvpnRouterAssociateV2 association_1 e26d509e-fc2d-4fb5-8562-619911a9a6bc/3cc9df2d-80db-4536-8ba6-295d1d0f723f

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi
    pulumi/pulumi-openstack