TransitGatewayRegistration class
Manages a Network Manager transit gateway registration. Registers a transit gateway to a global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.networkmanager.GlobalNetwork("example", {description: "example"});
const exampleTransitGateway = new aws.ec2transitgateway.TransitGateway("example", {});
const exampleTransitGatewayRegistration = new aws.networkmanager.TransitGatewayRegistration("example", {
globalNetworkId: example.id,
transitGatewayArn: exampleTransitGateway.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.networkmanager.GlobalNetwork("example", description="example")
example_transit_gateway = aws.ec2transitgateway.TransitGateway("example")
example_transit_gateway_registration = aws.networkmanager.TransitGatewayRegistration("example",
global_network_id=example.id,
transit_gateway_arn=example_transit_gateway.arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.NetworkManager.GlobalNetwork("example", new()
{
Description = "example",
});
var exampleTransitGateway = new Aws.Ec2TransitGateway.TransitGateway("example");
var exampleTransitGatewayRegistration = new Aws.NetworkManager.TransitGatewayRegistration("example", new()
{
GlobalNetworkId = example.Id,
TransitGatewayArn = exampleTransitGateway.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2transitgateway"
"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 {
example, err := networkmanager.NewGlobalNetwork(ctx, "example", &networkmanager.GlobalNetworkArgs{
Description: pulumi.String("example"),
})
if err != nil {
return err
}
exampleTransitGateway, err := ec2transitgateway.NewTransitGateway(ctx, "example", nil)
if err != nil {
return err
}
_, err = networkmanager.NewTransitGatewayRegistration(ctx, "example", &networkmanager.TransitGatewayRegistrationArgs{
GlobalNetworkId: example.ID().ToIDOutput().ToStringOutput(),
TransitGatewayArn: exampleTransitGateway.Arn,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_networkmanager_globalnetwork" "example" {
description = "example"
}
resource "aws_ec2transitgateway_transitgateway" "example" {
}
resource "aws_networkmanager_transitgatewayregistration" "example" {
global_network_id = aws_networkmanager_globalnetwork.example.id
transit_gateway_arn = aws_ec2transitgateway_transitgateway.example.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.GlobalNetwork;
import com.pulumi.aws.networkmanager.GlobalNetworkArgs;
import com.pulumi.aws.ec2transitgateway.TransitGateway;
import com.pulumi.aws.networkmanager.TransitGatewayRegistration;
import com.pulumi.aws.networkmanager.TransitGatewayRegistrationArgs;
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 GlobalNetwork("example", GlobalNetworkArgs.builder()
.description("example")
.build());
var exampleTransitGateway = new TransitGateway("exampleTransitGateway");
var exampleTransitGatewayRegistration = new TransitGatewayRegistration("exampleTransitGatewayRegistration", TransitGatewayRegistrationArgs.builder()
.globalNetworkId(example.id())
.transitGatewayArn(exampleTransitGateway.arn())
.build());
}
}
resources:
example:
type: aws:networkmanager:GlobalNetwork
properties:
description: example
exampleTransitGateway:
type: aws:ec2transitgateway:TransitGateway
name: example
exampleTransitGatewayRegistration:
type: aws:networkmanager:TransitGatewayRegistration
name: example
properties:
globalNetworkId: ${example.id}
transitGatewayArn: ${exampleTransitGateway.arn}
Import
Using pulumi import, import aws.networkmanager.TransitGatewayRegistration using the global network ID and transit gateway ARN. For example:
$ pulumi import aws:networkmanager/transitGatewayRegistration:TransitGatewayRegistration example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc
Constructors
- TransitGatewayRegistration(String name, {TransitGatewayRegistrationArgs? args, CustomResourceOptions? options})
-
Creates a new TransitGatewayRegistration.
nameThe Pulumi resource name.argsArguments used to configure this TransitGatewayRegistration. The set of arguments for TransitGatewayRegistration.optionsResource options controlling this resource's behavior. - TransitGatewayRegistration.reference(String urn)
- Creates a typed reference to an existing TransitGatewayRegistration resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
globalNetworkId
↔ Output<
String> -
ID of the Global Network to register to.
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
-
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
-
transitGatewayArn
↔ Output<
String> -
ARN of the Transit Gateway to register.
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, {TransitGatewayRegistrationState? state, CustomResourceOptions? options}) → TransitGatewayRegistration -
Gets an existing TransitGatewayRegistration resource's state with the given
nameandid.