TransitGatewayPeering class

Manages a Network Manager transit gateway peering connection. Creates a peering connection between an AWS Cloud WAN core network and an AWS Transit Gateway.

Example Usage

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

const example = new aws.networkmanager.TransitGatewayPeering("example", {
    coreNetworkId: exampleAwsccNetworkmanagerCoreNetwork.id,
    transitGatewayArn: exampleAwsEc2TransitGateway.arn,
}, {
    dependsOn: [
        exampleAwsEc2TransitGatewayPolicyTable,
        exampleAwsNetworkmanagerCoreNetworkPolicyAttachment,
    ],
});
import pulumi
import pulumi_aws as aws

example = aws.networkmanager.TransitGatewayPeering("example",
    core_network_id=example_awscc_networkmanager_core_network["id"],
    transit_gateway_arn=example_aws_ec2_transit_gateway["arn"],
    opts = pulumi.ResourceOptions(depends_on=[
            example_aws_ec2_transit_gateway_policy_table,
            example_aws_networkmanager_core_network_policy_attachment,
        ]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.NetworkManager.TransitGatewayPeering("example", new()
    {
        CoreNetworkId = exampleAwsccNetworkmanagerCoreNetwork.Id,
        TransitGatewayArn = exampleAwsEc2TransitGateway.Arn,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAwsEc2TransitGatewayPolicyTable,
            exampleAwsNetworkmanagerCoreNetworkPolicyAttachment,
        },
    });

});
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.NewTransitGatewayPeering(ctx, "example", &networkmanager.TransitGatewayPeeringArgs{
			CoreNetworkId:     pulumi.Any(exampleAwsccNetworkmanagerCoreNetwork.Id),
			TransitGatewayArn: pulumi.Any(exampleAwsEc2TransitGateway.Arn),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAwsEc2TransitGatewayPolicyTable,
			exampleAwsNetworkmanagerCoreNetworkPolicyAttachment,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_networkmanager_transitgatewaypeering" "example" {
  depends_on          = [exampleAwsEc2TransitGatewayPolicyTable, exampleAwsNetworkmanagerCoreNetworkPolicyAttachment]
  core_network_id     = exampleAwsccNetworkmanagerCoreNetwork.id
  transit_gateway_arn = exampleAwsEc2TransitGateway.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.TransitGatewayPeering;
import com.pulumi.aws.networkmanager.TransitGatewayPeeringArgs;
import com.pulumi.resources.CustomResourceOptions;
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 TransitGatewayPeering("example", TransitGatewayPeeringArgs.builder()
            .coreNetworkId(exampleAwsccNetworkmanagerCoreNetwork.id())
            .transitGatewayArn(exampleAwsEc2TransitGateway.arn())
            .build(), CustomResourceOptions.builder()
                .dependsOn(
                    exampleAwsEc2TransitGatewayPolicyTable,
                    exampleAwsNetworkmanagerCoreNetworkPolicyAttachment)
                .build());

    }
}
resources:
  example:
    type: aws:networkmanager:TransitGatewayPeering
    properties:
      coreNetworkId: ${exampleAwsccNetworkmanagerCoreNetwork.id}
      transitGatewayArn: ${exampleAwsEc2TransitGateway.arn}
    options:
      dependsOn:
        - ${exampleAwsEc2TransitGatewayPolicyTable}
        - ${exampleAwsNetworkmanagerCoreNetworkPolicyAttachment}

Import

Using pulumi import, import aws.networkmanager.TransitGatewayPeering using the peering ID. For example:

$ pulumi import aws:networkmanager/transitGatewayPeering:TransitGatewayPeering example peering-444555aaabbb11223

Constructors

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

Properties

arn ↔ Output<String>
Peering ARN.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
coreNetworkArn ↔ Output<String>
ARN of the core network.
latefinal
coreNetworkId ↔ Output<String>
ID of a core network.
latefinal
edgeLocation ↔ Output<String>
Edge location for the peer.
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 account owner.
latefinal
peeringType ↔ Output<String>
Type of peering. This will be TRANSIT_GATEWAY.
latefinal
resourceArn ↔ Output<String>
Resource ARN of the peer.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Key-value tags for the peering. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
transitGatewayArn ↔ Output<String>
ARN of the transit gateway for the peering request.
latefinal
transitGatewayPeeringAttachmentId ↔ Output<String>
ID of the transit gateway peering attachment.
latefinal
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, {TransitGatewayPeeringState? state, CustomResourceOptions? options}) → TransitGatewayPeering
Gets an existing TransitGatewayPeering resource's state with the given name and id.