@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
143 lines • 7.23 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.RouteTablePropagation = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Manages an EC2 Transit Gateway Route Table propagation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.ec2transitgateway.RouteTablePropagation("example", {
* transitGatewayAttachmentId: exampleAwsEc2TransitGatewayVpcAttachment.id,
* transitGatewayRouteTableId: exampleAwsEc2TransitGatewayRouteTable.id,
* });
* ```
*
* ### Direct Connect Gateway Propagation
*
* When propagating routes from a Direct Connect Gateway attachment, reference the `transitGatewayAttachmentId` attribute directly from the `aws.directconnect.GatewayAssociation` resource (available in v6.5.0+):
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.directconnect.Gateway("example", {
* name: "example",
* amazonSideAsn: "64512",
* });
* const exampleTransitGateway = new aws.ec2transitgateway.TransitGateway("example", {description: "example"});
* const exampleGatewayAssociation = new aws.directconnect.GatewayAssociation("example", {
* dxGatewayId: example.id,
* associatedGatewayId: exampleTransitGateway.id,
* allowedPrefixes: ["10.0.0.0/16"],
* });
* const exampleRouteTable = new aws.ec2transitgateway.RouteTable("example", {transitGatewayId: exampleTransitGateway.id});
* // Correct: Reference the attachment ID directly from the association resource
* const exampleRouteTablePropagation = new aws.ec2transitgateway.RouteTablePropagation("example", {
* transitGatewayAttachmentId: exampleGatewayAssociation.transitGatewayAttachmentId,
* transitGatewayRouteTableId: exampleRouteTable.id,
* });
* ```
*
* > **NOTE:** Avoid using the `aws.ec2transitgateway.getDirectConnectGatewayAttachment` data source to retrieve the attachment ID, as this can cause unnecessary resource recreation when unrelated attributes of the Direct Connect Gateway association change (such as `allowedPrefixes`). Always reference the `transitGatewayAttachmentId` attribute directly from the `aws.directconnect.GatewayAssociation` resource when available.
*
* ### VPC Attachment Propagation
*
* For VPC attachments, always reference the attachment resource's `id` attribute directly. Avoid using data sources or lifecycle rules that might cause the attachment ID to become unknown during planning:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.ec2.Vpc("example", {cidrBlock: "10.0.0.0/16"});
* const exampleSubnet = new aws.ec2.Subnet("example", {
* vpcId: example.id,
* cidrBlock: "10.0.1.0/24",
* });
* const exampleTransitGateway = new aws.ec2transitgateway.TransitGateway("example", {description: "example"});
* const exampleVpcAttachment = new aws.ec2transitgateway.VpcAttachment("example", {
* subnetIds: [exampleSubnet.id],
* transitGatewayId: exampleTransitGateway.id,
* vpcId: example.id,
* });
* const exampleRouteTable = new aws.ec2transitgateway.RouteTable("example", {transitGatewayId: exampleTransitGateway.id});
* // Correct: Reference the VPC attachment ID directly
* const exampleRouteTablePropagation = new aws.ec2transitgateway.RouteTablePropagation("example", {
* transitGatewayAttachmentId: exampleVpcAttachment.id,
* transitGatewayRouteTableId: exampleRouteTable.id,
* });
* ```
*
* > **NOTE:** When the `transitGatewayAttachmentId` changes (for example, when a VPC attachment is replaced), this resource will be recreated. This is the correct behavior to maintain consistency between the attachment and its route table propagation.
*
* ## Import
*
* Using `pulumi import`, import `aws_ec2_transit_gateway_route_table_propagation` using the EC2 Transit Gateway Route Table identifier, an underscore, and the EC2 Transit Gateway Attachment identifier. For example:
*
* ```sh
* $ pulumi import aws:ec2transitgateway/routeTablePropagation:RouteTablePropagation example tgw-rtb-12345678_tgw-attach-87654321
* ```
*/
class RouteTablePropagation extends pulumi.CustomResource {
/**
* Get an existing RouteTablePropagation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new RouteTablePropagation(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of RouteTablePropagation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === RouteTablePropagation.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["region"] = state?.region;
resourceInputs["resourceId"] = state?.resourceId;
resourceInputs["resourceType"] = state?.resourceType;
resourceInputs["transitGatewayAttachmentId"] = state?.transitGatewayAttachmentId;
resourceInputs["transitGatewayRouteTableId"] = state?.transitGatewayRouteTableId;
}
else {
const args = argsOrState;
if (args?.transitGatewayAttachmentId === undefined && !opts.urn) {
throw new Error("Missing required property 'transitGatewayAttachmentId'");
}
if (args?.transitGatewayRouteTableId === undefined && !opts.urn) {
throw new Error("Missing required property 'transitGatewayRouteTableId'");
}
resourceInputs["region"] = args?.region;
resourceInputs["transitGatewayAttachmentId"] = args?.transitGatewayAttachmentId;
resourceInputs["transitGatewayRouteTableId"] = args?.transitGatewayRouteTableId;
resourceInputs["resourceId"] = undefined /*out*/;
resourceInputs["resourceType"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(RouteTablePropagation.__pulumiType, name, resourceInputs, opts);
}
}
exports.RouteTablePropagation = RouteTablePropagation;
/** @internal */
RouteTablePropagation.__pulumiType = 'aws:ec2transitgateway/routeTablePropagation:RouteTablePropagation';
//# sourceMappingURL=routeTablePropagation.js.map