Connection class
Provides a Connection of Direct Connect.
Example Usage
Create a connection
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const hoge = new aws.directconnect.Connection("hoge", {
name: "tf-dx-connection",
bandwidth: "1Gbps",
location: "EqDC2",
});
import pulumi
import pulumi_aws as aws
hoge = aws.directconnect.Connection("hoge",
name="tf-dx-connection",
bandwidth="1Gbps",
location="EqDC2")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var hoge = new Aws.DirectConnect.Connection("hoge", new()
{
Name = "tf-dx-connection",
Bandwidth = "1Gbps",
Location = "EqDC2",
});
});
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.NewConnection(ctx, "hoge", &directconnect.ConnectionArgs{
Name: pulumi.String("tf-dx-connection"),
Bandwidth: pulumi.String("1Gbps"),
Location: pulumi.String("EqDC2"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_directconnect_connection" "hoge" {
name = "tf-dx-connection"
bandwidth = "1Gbps"
location = "EqDC2"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.Connection;
import com.pulumi.aws.directconnect.ConnectionArgs;
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 hoge = new Connection("hoge", ConnectionArgs.builder()
.name("tf-dx-connection")
.bandwidth("1Gbps")
.location("EqDC2")
.build());
}
}
resources:
hoge:
type: aws:directconnect:Connection
properties:
name: tf-dx-connection
bandwidth: 1Gbps
location: EqDC2
Request a MACsec-capable connection
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.directconnect.Connection("example", {
name: "tf-dx-connection",
bandwidth: "10Gbps",
location: "EqDA2",
requestMacsec: true,
});
import pulumi
import pulumi_aws as aws
example = aws.directconnect.Connection("example",
name="tf-dx-connection",
bandwidth="10Gbps",
location="EqDA2",
request_macsec=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.DirectConnect.Connection("example", new()
{
Name = "tf-dx-connection",
Bandwidth = "10Gbps",
Location = "EqDA2",
RequestMacsec = true,
});
});
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.NewConnection(ctx, "example", &directconnect.ConnectionArgs{
Name: pulumi.String("tf-dx-connection"),
Bandwidth: pulumi.String("10Gbps"),
Location: pulumi.String("EqDA2"),
RequestMacsec: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_directconnect_connection" "example" {
name = "tf-dx-connection"
bandwidth = "10Gbps"
location = "EqDA2"
request_macsec = true
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.Connection;
import com.pulumi.aws.directconnect.ConnectionArgs;
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 example = new Connection("example", ConnectionArgs.builder()
.name("tf-dx-connection")
.bandwidth("10Gbps")
.location("EqDA2")
.requestMacsec(true)
.build());
}
}
resources:
example:
type: aws:directconnect:Connection
properties:
name: tf-dx-connection
bandwidth: 10Gbps
location: EqDA2
requestMacsec: true
Configure encryption mode for MACsec-capable connections
> NOTE: You can only specify the encryptionMode argument once the connection is in an Available state.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.directconnect.Connection("example", {
name: "tf-dx-connection",
bandwidth: "10Gbps",
location: "EqDC2",
requestMacsec: true,
encryptionMode: "must_encrypt",
});
import pulumi
import pulumi_aws as aws
example = aws.directconnect.Connection("example",
name="tf-dx-connection",
bandwidth="10Gbps",
location="EqDC2",
request_macsec=True,
encryption_mode="must_encrypt")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.DirectConnect.Connection("example", new()
{
Name = "tf-dx-connection",
Bandwidth = "10Gbps",
Location = "EqDC2",
RequestMacsec = true,
EncryptionMode = "must_encrypt",
});
});
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.NewConnection(ctx, "example", &directconnect.ConnectionArgs{
Name: pulumi.String("tf-dx-connection"),
Bandwidth: pulumi.String("10Gbps"),
Location: pulumi.String("EqDC2"),
RequestMacsec: pulumi.Bool(true),
EncryptionMode: pulumi.String("must_encrypt"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_directconnect_connection" "example" {
name = "tf-dx-connection"
bandwidth = "10Gbps"
location = "EqDC2"
request_macsec = true
encryption_mode = "must_encrypt"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.Connection;
import com.pulumi.aws.directconnect.ConnectionArgs;
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 example = new Connection("example", ConnectionArgs.builder()
.name("tf-dx-connection")
.bandwidth("10Gbps")
.location("EqDC2")
.requestMacsec(true)
.encryptionMode("must_encrypt")
.build());
}
}
resources:
example:
type: aws:directconnect:Connection
properties:
name: tf-dx-connection
bandwidth: 10Gbps
location: EqDC2
requestMacsec: true
encryptionMode: must_encrypt
Import
Using pulumi import, import Direct Connect connections using the connection id. For example:
$ pulumi import aws:directconnect/connection:Connection test_connection dxcon-ffre0ec3
Constructors
- Connection(String name, {ConnectionArgs? args, CustomResourceOptions? options})
-
Creates a new Connection.
nameThe Pulumi resource name.argsArguments used to configure this Connection. The set of arguments for Connection.optionsResource options controlling this resource's behavior. - Connection.reference(String urn)
- Creates a typed reference to an existing Connection resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the connection.
latefinal
-
awsDevice
↔ Output<
String> -
The Direct Connect endpoint on which the physical connection terminates.
latefinal
-
bandwidth
↔ Output<
String> -
The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps, 100Gbps, and 400Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Case sensitive. Refer to the AWS Direct Connection supported bandwidths for Dedicated Connections and Hosted Connections.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
encryptionMode
↔ Output<
String> -
The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are
noEncrypt,shouldEncrypt, andmustEncrypt.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
hasLogicalRedundancy
↔ Output<
String> -
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
latefinal
-
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
-
jumboFrameCapable
↔ Output<
bool> -
Boolean value representing if jumbo frames have been enabled for this connection.
latefinal
-
location
↔ Output<
String> -
The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use
locationCode.latefinal -
macsecCapable
↔ Output<
bool> -
Boolean value indicating whether the connection supports MAC Security (MACsec).
latefinal
-
name
↔ Output<
String> -
The name of the connection.
latefinal
-
ownerAccountId
↔ Output<
String> -
The ID of the AWS account that owns the connection.
latefinal
-
partnerName
↔ Output<
String> -
The name of the AWS Direct Connect service provider associated with the connection.
latefinal
-
portEncryptionStatus
↔ Output<
String> -
The MAC Security (MACsec) port link status of the connection.
latefinal
-
providerName
↔ Output<
String> -
The name of the service provider associated with the connection.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
requestMacsec
↔ Output<
bool?> -
Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value:
false.latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
skipDestroy
↔ Output<
bool?> -
Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.
latefinal
-
state
↔ Output<
String> -
State of the connection. See CreateConnection for list of possible state values.
latefinal
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vlanId
↔ Output<
int> -
The VLAN ID.
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, {ConnectionState? state, CustomResourceOptions? options}) → Connection -
Gets an existing Connection resource's state with the given
nameandid.