DxGatewayAttachment class
Manages a Network Manager Direct Connect Gateway Attachment.
Use this resource to create and manage a Direct Connect Gateway attachment to a Cloud WAN core network.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.networkmanager.DxGatewayAttachment("test", {
coreNetworkId: testAwsNetworkmanagerCoreNetworkPolicyAttachment.coreNetworkId,
directConnectGatewayArn: `arn:aws:directconnect::${current.accountId}:dx-gateway/${testAwsDxGateway.id}`,
edgeLocations: [currentAwsRegion.region],
});
import pulumi
import pulumi_aws as aws
test = aws.networkmanager.DxGatewayAttachment("test",
core_network_id=test_aws_networkmanager_core_network_policy_attachment["coreNetworkId"],
direct_connect_gateway_arn=f"arn:aws:directconnect::{current['accountId']}:dx-gateway/{test_aws_dx_gateway['id']}",
edge_locations=[current_aws_region["region"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.NetworkManager.DxGatewayAttachment("test", new()
{
CoreNetworkId = testAwsNetworkmanagerCoreNetworkPolicyAttachment.CoreNetworkId,
DirectConnectGatewayArn = $"arn:aws:directconnect::{current.AccountId}:dx-gateway/{testAwsDxGateway.Id}",
EdgeLocations = new[]
{
currentAwsRegion.Region,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/networkmanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := networkmanager.NewDxGatewayAttachment(ctx, "test", &networkmanager.DxGatewayAttachmentArgs{
CoreNetworkId: pulumi.Any(testAwsNetworkmanagerCoreNetworkPolicyAttachment.CoreNetworkId),
DirectConnectGatewayArn: pulumi.Sprintf("arn:aws:directconnect::%v:dx-gateway/%v", current.AccountId, testAwsDxGateway.Id),
EdgeLocations: pulumi.StringArray{
currentAwsRegion.Region,
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_networkmanager_dxgatewayattachment" "test" {
core_network_id = testAwsNetworkmanagerCoreNetworkPolicyAttachment.coreNetworkId
direct_connect_gateway_arn ="arn:aws:directconnect::${current.accountId}:dx-gateway/${testAwsDxGateway.id}"
edge_locations = [currentAwsRegion.region]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.DxGatewayAttachment;
import com.pulumi.aws.networkmanager.DxGatewayAttachmentArgs;
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 test = new DxGatewayAttachment("test", DxGatewayAttachmentArgs.builder()
.coreNetworkId(testAwsNetworkmanagerCoreNetworkPolicyAttachment.coreNetworkId())
.directConnectGatewayArn(String.format("arn:aws:directconnect::%s:dx-gateway/%s", current.accountId(),testAwsDxGateway.id()))
.edgeLocations(currentAwsRegion.region())
.build());
}
}
resources:
test:
type: aws:networkmanager:DxGatewayAttachment
properties:
coreNetworkId: ${testAwsNetworkmanagerCoreNetworkPolicyAttachment.coreNetworkId}
directConnectGatewayArn: arn:aws:directconnect::${current.accountId}:dx-gateway/${testAwsDxGateway.id}
edgeLocations:
- ${currentAwsRegion.region}
Import
Using pulumi import, import Network Manager DX Gateway Attachment using the id. For example:
$ pulumi import aws:networkmanager/dxGatewayAttachment:DxGatewayAttachment example attachment-1a2b3c4d5e6f7g
Constructors
- DxGatewayAttachment(String name, {DxGatewayAttachmentArgs? args, CustomResourceOptions? options})
-
Creates a new DxGatewayAttachment.
nameThe Pulumi resource name.argsArguments used to configure this DxGatewayAttachment. The set of arguments for DxGatewayAttachment.optionsResource options controlling this resource's behavior. - DxGatewayAttachment.reference(String urn)
- Creates a typed reference to an existing DxGatewayAttachment resource.
Properties
-
arn
↔ Output<
String> -
ARN of the attachment.
latefinal
-
attachmentPolicyRuleNumber
↔ Output<
int> -
Policy rule number associated with the attachment.
latefinal
-
attachmentType
↔ Output<
String> -
Type of attachment.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
coreNetworkArn
↔ Output<
String> -
ARN of the core network for the attachment.
latefinal
-
coreNetworkId
↔ Output<
String> -
ID of the Cloud WAN core network to which the Direct Connect gateway attachment should be attached.
latefinal
-
directConnectGatewayArn
↔ Output<
String> -
ARN of the Direct Connect gateway attachment.
latefinal
-
edgeLocations
↔ Output<
List< String> > -
One or more core network edge locations to associate with the Direct Connect gateway attachment.
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
-
ownerAccountId
↔ Output<
String> -
ID of the attachment account owner.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
routingPolicyLabel
↔ Output<
String?> -
The routing policy label to apply to the Direct Connect Gateway attachment for traffic routing decisions. Maximum length of 256 characters. Changing this value will force recreation of the resource.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
segmentName
↔ Output<
String> -
Name of the segment attachment.
latefinal
-
state
↔ Output<
String> -
State of the attachment.
latefinal
-
Key-value tags for the attachment. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
DxGatewayAttachmentTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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, {DxGatewayAttachmentState? state, CustomResourceOptions? options}) → DxGatewayAttachment -
Gets an existing DxGatewayAttachment resource's state with the given
nameandid.