BgpPeer class

Provides a Direct Connect BGP peer resource.

Example Usage

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

const peer = new aws.directconnect.BgpPeer("peer", {
    virtualInterfaceId: foo.id,
    addressFamily: "ipv6",
    bgpAsn: 65351,
});
import pulumi
import pulumi_aws as aws

peer = aws.directconnect.BgpPeer("peer",
    virtual_interface_id=foo["id"],
    address_family="ipv6",
    bgp_asn=65351)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var peer = new Aws.DirectConnect.BgpPeer("peer", new()
    {
        VirtualInterfaceId = foo.Id,
        AddressFamily = "ipv6",
        BgpAsn = 65351,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/directconnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directconnect.NewBgpPeer(ctx, "peer", &directconnect.BgpPeerArgs{
			VirtualInterfaceId: pulumi.Any(foo.Id),
			AddressFamily:      pulumi.String("ipv6"),
			BgpAsn:             pulumi.Int(65351),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_directconnect_bgppeer" "peer" {
  virtual_interface_id = foo.id
  address_family       = "ipv6"
  bgp_asn              = 65351
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.BgpPeer;
import com.pulumi.aws.directconnect.BgpPeerArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 peer = new BgpPeer("peer", BgpPeerArgs.builder()
            .virtualInterfaceId(foo.id())
            .addressFamily("ipv6")
            .bgpAsn(65351)
            .build());

    }
}
resources:
  peer:
    type: aws:directconnect:BgpPeer
    properties:
      virtualInterfaceId: ${foo.id}
      addressFamily: ipv6
      bgpAsn: 65351

Constructors

BgpPeer(String name, {BgpPeerArgs? args, CustomResourceOptions? options})
Creates a new BgpPeer. name The Pulumi resource name. args Arguments used to configure this BgpPeer. The set of arguments for BgpPeer. options Resource options controlling this resource's behavior.
BgpPeer.reference(String urn)
Creates a typed reference to an existing BgpPeer resource.

Properties

addressFamily ↔ Output<String>
The address family for the BGP peer. ipv4 or ipv6.
latefinal
amazonAddress ↔ Output<String>
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.
latefinal
awsDevice ↔ Output<String>
The Direct Connect endpoint on which the BGP peer terminates.
latefinal
bgpAsn ↔ Output<int>
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
latefinal
bgpAuthKey ↔ Output<String>
The authentication key for BGP configuration.
latefinal
bgpPeerId ↔ Output<String>
The ID of the BGP peer.
latefinal
bgpStatus ↔ Output<String>
The Up/Down state of the BGP peer.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
customerAddress ↔ Output<String>
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
virtualInterfaceId ↔ Output<String>
The ID of the Direct Connect virtual interface on which to create the BGP peer.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {BgpPeerState? state, CustomResourceOptions? options}) → BgpPeer
Gets an existing BgpPeer resource's state with the given name and id.