AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.9.1 published on Tuesday, Jun 21, 2022 by Pulumi

LinkAggregationGroup

Provides a Direct Connect LAG. Connections can be added to the LAG via the aws.directconnect.Connection and aws.directconnect.ConnectionAssociation resources.

NOTE: When creating a LAG, if no existing connection is specified, Direct Connect will create a connection and this provider will remove this unmanaged connection during resource creation.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var hoge = new Aws.DirectConnect.LinkAggregationGroup("hoge", new Aws.DirectConnect.LinkAggregationGroupArgs
        {
            ConnectionsBandwidth = "1Gbps",
            ForceDestroy = true,
            Location = "EqDC2",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directconnect.NewLinkAggregationGroup(ctx, "hoge", &directconnect.LinkAggregationGroupArgs{
			ConnectionsBandwidth: pulumi.String("1Gbps"),
			ForceDestroy:         pulumi.Bool(true),
			Location:             pulumi.String("EqDC2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var hoge = new LinkAggregationGroup("hoge", LinkAggregationGroupArgs.builder()        
            .connectionsBandwidth("1Gbps")
            .forceDestroy(true)
            .location("EqDC2")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

hoge = aws.directconnect.LinkAggregationGroup("hoge",
    connections_bandwidth="1Gbps",
    force_destroy=True,
    location="EqDC2")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const hoge = new aws.directconnect.LinkAggregationGroup("hoge", {
    connectionsBandwidth: "1Gbps",
    forceDestroy: true,
    location: "EqDC2",
});
resources:
  hoge:
    type: aws:directconnect:LinkAggregationGroup
    properties:
      connectionsBandwidth: 1Gbps
      forceDestroy: true
      location: EqDC2

Create a LinkAggregationGroup Resource

new LinkAggregationGroup(name: string, args: LinkAggregationGroupArgs, opts?: CustomResourceOptions);
@overload
def LinkAggregationGroup(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         connection_id: Optional[str] = None,
                         connections_bandwidth: Optional[str] = None,
                         force_destroy: Optional[bool] = None,
                         location: Optional[str] = None,
                         name: Optional[str] = None,
                         provider_name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
@overload
def LinkAggregationGroup(resource_name: str,
                         args: LinkAggregationGroupArgs,
                         opts: Optional[ResourceOptions] = None)
func NewLinkAggregationGroup(ctx *Context, name string, args LinkAggregationGroupArgs, opts ...ResourceOption) (*LinkAggregationGroup, error)
public LinkAggregationGroup(string name, LinkAggregationGroupArgs args, CustomResourceOptions? opts = null)
public LinkAggregationGroup(String name, LinkAggregationGroupArgs args)
public LinkAggregationGroup(String name, LinkAggregationGroupArgs args, CustomResourceOptions options)
type: aws:directconnect:LinkAggregationGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args LinkAggregationGroupArgs
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 LinkAggregationGroupArgs
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 LinkAggregationGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args LinkAggregationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args LinkAggregationGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ConnectionsBandwidth string

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

Location string

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

ConnectionId string

The ID of an existing dedicated connection to migrate to the LAG.

ForceDestroy bool

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

Name string

The name of the LAG.

ProviderName string

The name of the service provider associated with the LAG.

Tags Dictionary<string, string>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

ConnectionsBandwidth string

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

Location string

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

ConnectionId string

The ID of an existing dedicated connection to migrate to the LAG.

ForceDestroy bool

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

Name string

The name of the LAG.

ProviderName string

The name of the service provider associated with the LAG.

Tags map[string]string

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

connectionsBandwidth String

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

location String

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

connectionId String

The ID of an existing dedicated connection to migrate to the LAG.

forceDestroy Boolean

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

name String

The name of the LAG.

providerName String

The name of the service provider associated with the LAG.

tags Map<String,String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

connectionsBandwidth string

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

location string

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

connectionId string

The ID of an existing dedicated connection to migrate to the LAG.

forceDestroy boolean

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

name string

The name of the LAG.

providerName string

The name of the service provider associated with the LAG.

tags {[key: string]: string}

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

connections_bandwidth str

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

location str

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

connection_id str

The ID of an existing dedicated connection to migrate to the LAG.

force_destroy bool

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

name str

The name of the LAG.

provider_name str

The name of the service provider associated with the LAG.

tags Mapping[str, str]

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

connectionsBandwidth String

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

location String

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

connectionId String

The ID of an existing dedicated connection to migrate to the LAG.

forceDestroy Boolean

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

name String

The name of the LAG.

providerName String

The name of the service provider associated with the LAG.

tags Map<String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the LinkAggregationGroup resource produces the following output properties:

Arn string

The ARN of the LAG.

HasLogicalRedundancy string

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

Id string

The provider-assigned unique ID for this managed resource.

JumboFrameCapable bool
OwnerAccountId string

The ID of the AWS account that owns the LAG.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

The ARN of the LAG.

HasLogicalRedundancy string

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

Id string

The provider-assigned unique ID for this managed resource.

JumboFrameCapable bool
OwnerAccountId string

The ID of the AWS account that owns the LAG.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The ARN of the LAG.

hasLogicalRedundancy String

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

id String

The provider-assigned unique ID for this managed resource.

jumboFrameCapable Boolean
ownerAccountId String

The ID of the AWS account that owns the LAG.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

The ARN of the LAG.

hasLogicalRedundancy string

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

id string

The provider-assigned unique ID for this managed resource.

jumboFrameCapable boolean
ownerAccountId string

The ID of the AWS account that owns the LAG.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

The ARN of the LAG.

has_logical_redundancy str

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

id str

The provider-assigned unique ID for this managed resource.

jumbo_frame_capable bool
owner_account_id str

The ID of the AWS account that owns the LAG.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The ARN of the LAG.

hasLogicalRedundancy String

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

id String

The provider-assigned unique ID for this managed resource.

jumboFrameCapable Boolean
ownerAccountId String

The ID of the AWS account that owns the LAG.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up an Existing LinkAggregationGroup Resource

Get an existing LinkAggregationGroup 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?: LinkAggregationGroupState, opts?: CustomResourceOptions): LinkAggregationGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        connection_id: Optional[str] = None,
        connections_bandwidth: Optional[str] = None,
        force_destroy: Optional[bool] = None,
        has_logical_redundancy: Optional[str] = None,
        jumbo_frame_capable: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        owner_account_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> LinkAggregationGroup
func GetLinkAggregationGroup(ctx *Context, name string, id IDInput, state *LinkAggregationGroupState, opts ...ResourceOption) (*LinkAggregationGroup, error)
public static LinkAggregationGroup Get(string name, Input<string> id, LinkAggregationGroupState? state, CustomResourceOptions? opts = null)
public static LinkAggregationGroup get(String name, Output<String> id, LinkAggregationGroupState 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:
Arn string

The ARN of the LAG.

ConnectionId string

The ID of an existing dedicated connection to migrate to the LAG.

ConnectionsBandwidth string

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

ForceDestroy bool

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

HasLogicalRedundancy string

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

JumboFrameCapable bool
Location string

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

Name string

The name of the LAG.

OwnerAccountId string

The ID of the AWS account that owns the LAG.

ProviderName string

The name of the service provider associated with the LAG.

Tags Dictionary<string, string>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

The ARN of the LAG.

ConnectionId string

The ID of an existing dedicated connection to migrate to the LAG.

ConnectionsBandwidth string

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

ForceDestroy bool

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

HasLogicalRedundancy string

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

JumboFrameCapable bool
Location string

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

Name string

The name of the LAG.

OwnerAccountId string

The ID of the AWS account that owns the LAG.

ProviderName string

The name of the service provider associated with the LAG.

Tags map[string]string

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The ARN of the LAG.

connectionId String

The ID of an existing dedicated connection to migrate to the LAG.

connectionsBandwidth String

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

forceDestroy Boolean

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

hasLogicalRedundancy String

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

jumboFrameCapable Boolean
location String

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

name String

The name of the LAG.

ownerAccountId String

The ID of the AWS account that owns the LAG.

providerName String

The name of the service provider associated with the LAG.

tags Map<String,String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

The ARN of the LAG.

connectionId string

The ID of an existing dedicated connection to migrate to the LAG.

connectionsBandwidth string

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

forceDestroy boolean

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

hasLogicalRedundancy string

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

jumboFrameCapable boolean
location string

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

name string

The name of the LAG.

ownerAccountId string

The ID of the AWS account that owns the LAG.

providerName string

The name of the service provider associated with the LAG.

tags {[key: string]: string}

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

The ARN of the LAG.

connection_id str

The ID of an existing dedicated connection to migrate to the LAG.

connections_bandwidth str

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

force_destroy bool

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

has_logical_redundancy str

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

jumbo_frame_capable bool
location str

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

name str

The name of the LAG.

owner_account_id str

The ID of the AWS account that owns the LAG.

provider_name str

The name of the service provider associated with the LAG.

tags Mapping[str, str]

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The ARN of the LAG.

connectionId String

The ID of an existing dedicated connection to migrate to the LAG.

connectionsBandwidth String

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

forceDestroy Boolean

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

hasLogicalRedundancy String

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

jumboFrameCapable Boolean
location String

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

name String

The name of the LAG.

ownerAccountId String

The ID of the AWS account that owns the LAG.

providerName String

The name of the service provider associated with the LAG.

tags Map<String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Import

Direct Connect LAGs can be imported using the lag id, e.g.,

 $ pulumi import aws:directconnect/linkAggregationGroup:LinkAggregationGroup test_lag dxlag-fgnsp5rq

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.