Interface ITransitGatewayAttachmentConfig

NetworkConfig / VpcConfig | VpcTemplatesConfig / TransitGatewayAttachmentConfig

Transit Gateway VPC attachment configuration.

Description

Use this configuration to define a Transit Gateway attachment to your VPC. Transit Gateway attachments allow you to interconnect your virtual private clouds (VPCs) and on-premises networks. Defining a VPC attachment deploys an elastic network interface within VPC subnets, which is then used by the transit gateway to route traffic to and from the chosen subnets.

Example

- name: Network-Inspection
  transitGateway:
    name: Network-Main
    account: Network
  subnets: []
  routeTableAssociations: []
  routeTablePropagations: []
  options:
    applianceModeSupport: enable
  tags: []
interface ITransitGatewayAttachmentConfig {
    name: string;
    options?: ITransitGatewayAttachmentOptionsConfig;
    routeTableAssociations?: string[];
    routeTablePropagations?: string[];
    subnets: string[];
    tags?: ITag[];
    transitGateway: ITransitGatewayAttachmentTargetConfig;
}

Properties

name options? routeTableAssociations? routeTablePropagations? subnets tags? transitGateway

Properties

Readonlyname

name: string

A friendly name for the Transit Gateway attachment.

Remarks

CAUTION: Changing this value after initial deployment will cause the attachment to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Optional Readonlyoptions

options?: ITransitGatewayAttachmentOptionsConfig

(OPTIONAL) A Transit Gateway attachment options configuration.

See

TransitGatewayAttachmentOptionsConfig

Optional ReadonlyrouteTableAssociations

routeTableAssociations?: string[]

The friendly name of a Transit Gateway route table to associate the attachment to.

Remarks

CAUTION: Changing this value after initial deployment causes a new association to be created. Attachments can only have a single association at a time. To avoid core pipeline failures, use multiple core pipeline runs to 1) delete the existing association and then 2) add the new association.

This is the logical name property of the route table as defined in network-config.yaml.

See

TransitGatewayRouteTableConfig

Optional ReadonlyrouteTablePropagations

routeTablePropagations?: string[]

An array of friendly names of Transit Gateway route tables to propagate the attachment.

Readonlysubnets

subnets: string[]

An array of the friendly names of VPC subnets for the attachment to be deployed.

Remarks

CAUTION: Changing this value after initial deployment causes a new attachment to be created. VPCs can only have a single attachment at a time. To avoid core pipeline failures, use multiple core pipeline runs to 1) delete the existing VPC attachment and any downstream dependencies and then 2) create a new attachment with your updated subnets.

This is the logical name property of the subnet as defined in network-config.yaml.

See

SubnetConfig

Optional Readonlytags

tags?: ITag[]

(OPTIONAL) An array of tag objects for the Transit Gateway attachment.

ReadonlytransitGateway

transitGateway: ITransitGatewayAttachmentTargetConfig

A Transit Gateway attachment target configuration object.

See

TransitGatewayAttachmentTargetConfig

Settings

Member Visibility

On This Page

Properties