Interface IGwlbConfig

NetworkConfig / CentralNetworkServicesConfig / GwlbConfig

Gateway Load Balancer configuration.

Description

Use to define Gateway Load Balancer configurations for the accelerator. Gateway Load Balancers enable you to deploy, scale, and manage virtual appliances, such as firewalls, intrusion detection and prevention systems, and deep packet inspection systems. It combines a transparent network gateway (that is, a single entry and exit point for all traffic) and distributes traffic while scaling your virtual appliances with the demand.

Example

gatewayLoadBalancers:
  - name: Accelerator-GWLB
    subnets:
      - Network-Inspection-Firewall-A
      - Network-Inspection-Firewall-B
    vpc: Network-Inspection
    deletionProtection: true
    endpoints:
      - name: Endpoint-A
        account: Network
        subnet: Network-Inspection-A
        vpc: Network-Inspection
      - name: Endpoint-B
        account: Network
        subnet: Network-Inspection-B
        vpc: Network-Inspection
interface IGwlbConfig {
    account?: string;
    crossZoneLoadBalancing?: boolean;
    deletionProtection?: boolean;
    endpoints: IGwlbEndpointConfig[];
    name: string;
    subnets: string[];
    tags?: ITag[];
    targetGroup?: string;
    vpc: string;
}

Properties

account? crossZoneLoadBalancing? deletionProtection? endpoints name subnets tags? targetGroup? vpc

Properties

Optional Readonlyaccount

account?: string

(OPTIONAL) Set an override for the account the Gateway Load Balancer is deployed to.

Remarks

This is the account property of the VPC referenced in the vpc property.

This value defaults to the value set for the central network services delegated admin account. Only set this value if you would like your Gateway Load Balancer deployed to an account other than the configured delegated admin account.

Optional ReadonlycrossZoneLoadBalancing

crossZoneLoadBalancing?: boolean

(OPTIONAL) Whether to enable cross-zone load balancing.

Optional ReadonlydeletionProtection

deletionProtection?: boolean

(OPTIONAL) Whether to enable deletion protection.

Readonlyendpoints

endpoints: IGwlbEndpointConfig[]

An array of Gateway Load Balancer endpoint configurations.

See

GwlbEndpointConfig

Readonlyname

name: string

The friendly name of the Gateway Load Balancer.

Remarks

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

Readonlysubnets

subnets: string[]

An array of friendly names of subnets to deploy the Gateway Load Balancer to.

Remarks

This is the logical name property of the subnets as defined in network-config.yaml. The subnets referenced must exist in the VPC referenced in the vpc property.

See

SubnetConfig

Optional Readonlytags

tags?: ITag[]

(OPTIONAL) An array of CloudFormation tag objects.

Optional ReadonlytargetGroup

targetGroup?: string

(OPTIONAL) The friendly name of a target group to forward traffic to

Remarks

This target group must be defined in Ec2FirewallConfig in the customizations-config.yaml configuration file

Readonlyvpc

vpc: string

The friendly name of the VPC to deploy the Gateway Load Balancer to.

Remarks

This is the logical name property of the VPC as defined in network-config.yaml. VPC templates are not a supported target for Gateway Load Balancers.

See

VpcConfig

Settings

Member Visibility

On This Page

Properties