Interface ITransitGatewayPeeringAccepterConfig

NetworkConfig / TransitGatewayPeeringConfig / TransitGatewayPeeringAccepterConfig

Description

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

Example

transitGatewayName: Network-Main
account: Network
region: us-east-1
routeTableAssociations: Network-Main-Core
autoAccept: true
applyTags: false
interface ITransitGatewayPeeringAccepterConfig {
    account: string;
    applyTags?: boolean;
    autoAccept?: boolean;
    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"
        | "mx-central-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;
    transitGatewayName: string;
}

Properties

account applyTags? autoAccept? region routeTableAssociations transitGatewayName

Properties

Readonlyaccount

account: string

The friendly name of the account of the accepter transit gateway

Remarks

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

See

TransitGatewayConfig

Optional ReadonlyapplyTags

applyTags?: boolean

(OPTIONAL) Peering request apply tags flag. Note: When this flag is set to true, the requester attachment tags are replicated to the accepter attachment.

Optional ReadonlyautoAccept

autoAccept?: boolean

(OPTIONAL) Peering request auto accept flag. Note: When this flag is set to true, the peering request will be automatically accepted by the accelerator.

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"
    | "mx-central-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 accepter TGW as defined in network-config.yaml.

See

TransitGatewayRouteTableConfig

ReadonlytransitGatewayName

transitGatewayName: string

The friendly name of the accepter transit gateway

Remarks

This is the logical name property of the accepter 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