Interface ITransitGatewayPeeringRequesterConfig

NetworkConfig / TransitGatewayPeeringConfig / TransitGatewayPeeringRequesterConfig

Description

Transit Gateway (TGW) peering requester configuration. Use this configuration to define the requester side of the peering attachment.

Example

transitGatewayName: SharedServices-Main
account: SharedServices
region: us-west-2
routeTableAssociations: SharedServices-Main-Core
tags:
  - key: Name
    value: Network-Main-And-SharedServices-Main-Peering
interface ITransitGatewayPeeringRequesterConfig {
    account: string;
    region:
        | "af-south-1"
        | "ap-east-1"
        | "ap-northeast-1"
        | "ap-northeast-2"
        | "ap-northeast-3"
        | "ap-south-1"
        | "ap-south-2"
        | "ap-southeast-1"
        | "ap-southeast-2"
        | "ap-southeast-3"
        | "ap-southeast-4"
        | "ap-southeast-5"
        | "ca-central-1"
        | "ca-west-1"
        | "cn-north-1"
        | "cn-northwest-1"
        | "eu-central-1"
        | "eu-central-2"
        | "eu-north-1"
        | "eu-south-1"
        | "eu-south-2"
        | "eu-west-1"
        | "eu-west-2"
        | "eu-west-3"
        | "eu-isoe-west-1"
        | "il-central-1"
        | "me-central-1"
        | "me-south-1"
        | "sa-east-1"
        | "us-east-1"
        | "us-east-2"
        | "us-gov-west-1"
        | "us-gov-east-1"
        | "us-iso-east-1"
        | "us-isob-east-1"
        | "us-iso-west-1"
        | "us-isof-south-1"
        | "us-isof-east-1"
        | "us-west-1"
        | "us-west-2";
    routeTableAssociations: string;
    tags?: ITag[];
    transitGatewayName: string;
}

Properties

account region routeTableAssociations tags? transitGatewayName

Properties

Readonlyaccount

account: string

The friendly name of the account of the requester transit gateway

Remarks

This is the logical account property of the requester transit gateway as defined in network-config.yaml.

See

TransitGatewayConfig

Readonlyregion

region:
    | "af-south-1"
    | "ap-east-1"
    | "ap-northeast-1"
    | "ap-northeast-2"
    | "ap-northeast-3"
    | "ap-south-1"
    | "ap-south-2"
    | "ap-southeast-1"
    | "ap-southeast-2"
    | "ap-southeast-3"
    | "ap-southeast-4"
    | "ap-southeast-5"
    | "ca-central-1"
    | "ca-west-1"
    | "cn-north-1"
    | "cn-northwest-1"
    | "eu-central-1"
    | "eu-central-2"
    | "eu-north-1"
    | "eu-south-1"
    | "eu-south-2"
    | "eu-west-1"
    | "eu-west-2"
    | "eu-west-3"
    | "eu-isoe-west-1"
    | "il-central-1"
    | "me-central-1"
    | "me-south-1"
    | "sa-east-1"
    | "us-east-1"
    | "us-east-2"
    | "us-gov-west-1"
    | "us-gov-east-1"
    | "us-iso-east-1"
    | "us-isob-east-1"
    | "us-iso-west-1"
    | "us-isof-south-1"
    | "us-isof-east-1"
    | "us-west-1"
    | "us-west-2"

The name of the region the accepter transit gateway resides in

See

TransitGatewayConfig

ReadonlyrouteTableAssociations

routeTableAssociations: string

The friendly name of TGW route table to associate with this peering attachment.

Remarks

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

See

TransitGatewayRouteTableConfig

Optional Readonlytags

tags?: ITag[]

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

ReadonlytransitGatewayName

transitGatewayName: string

The friendly name of the requester transit gateway

Remarks

This is the logical name property of the requester transit gateway as defined in network-config.yaml.

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

See

TransitGatewayConfig

Settings

Member Visibility

On This Page

Properties