TransitGateway class

Manages an EC2 Transit Gateway.

Example Usage

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

const example = new aws.ec2transitgateway.TransitGateway("example", {description: "example"});
import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.TransitGateway("example", description="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ec2TransitGateway.TransitGateway("example", new()
    {
        Description = "example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2transitgateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2transitgateway.NewTransitGateway(ctx, "example", &ec2transitgateway.TransitGatewayArgs{
			Description: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2transitgateway_transitgateway" "example" {
  description = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.TransitGateway;
import com.pulumi.aws.ec2transitgateway.TransitGatewayArgs;
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 TransitGateway("example", TransitGatewayArgs.builder()
            .description("example")
            .build());

    }
}
resources:
  example:
    type: aws:ec2transitgateway:TransitGateway
    properties:
      description: example

Import

Using pulumi import, import aws.ec2transitgateway.TransitGateway using the EC2 Transit Gateway identifier. For example:

$ pulumi import aws:ec2transitgateway/transitGateway:TransitGateway example tgw-12345678

Constructors

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

Properties

amazonSideAsn ↔ Output<int?>
Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.
latefinal
arn ↔ Output<String>
EC2 Transit Gateway ARN
latefinal
associationDefaultRouteTableId ↔ Output<String>
Identifier of the default association route table
latefinal
autoAcceptSharedAttachments ↔ Output<String?>
Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultRouteTableAssociation ↔ Output<String?>
Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
latefinal
defaultRouteTablePropagation ↔ Output<String?>
Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
latefinal
description ↔ Output<String?>
Description of the EC2 Transit Gateway.
latefinal
dnsSupport ↔ Output<String?>
Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
latefinal
encryptionSupport ↔ Output<String>
Whether encryption support for VPC Encryption Control is enabled. Valid values: disable, enable. Default value: disable. Once set, switching to disable requires explicitly specifying disable rather than removing the argument.
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
multicastSupport ↔ Output<String?>
Whether Multicast support is enabled. Required to use ec2TransitGatewayMulticastDomain. Valid values: disable, enable. Default value: disable.
latefinal
ownerId ↔ Output<String>
Identifier of the AWS account that owns the EC2 Transit Gateway
latefinal
propagationDefaultRouteTableId ↔ Output<String>
Identifier of the default propagation route table
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupReferencingSupport ↔ Output<String?>
Whether Security Group Referencing Support is enabled. Valid values: disable, enable. Default value: disable.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value tags for the EC2 Transit Gateway. 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>>
A 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
transitGatewayCidrBlocks ↔ Output<List<String>?>
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
latefinal
urn ↔ Output<String>
latefinalinherited
vpnEcmpSupport ↔ Output<String?>
Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.
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, {TransitGatewayState? state, CustomResourceOptions? options}) → TransitGateway
Gets an existing TransitGateway resource's state with the given name and id.