Interface IOutpostsConfig

NetworkConfig / VpcConfig / OutpostsConfig

AWS Outposts configuration.

Description

Use this configuration to reference Outposts that exist in your environment. AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.

Example

- name: accelerator-outpost
  arn: <outpost-resource-arn>
  availabilityZone: a
  localGateway:
    name: accelerator-lgw
    id: lgw-abcxyz
    routeTables: []
interface IOutpostsConfig {
    arn: string;
    availabilityZone: string | number;
    localGateway?: ILocalGatewayConfig;
    name: string;
}

Properties

arn availabilityZone localGateway? name

Properties

Readonlyarn

arn: string

The ARN for the Outpost

Remarks

This is an existing resource ARN for the outpost. The outpost must exist in the account and region the accelerator-provisioned subnet is deployed to.

To find the resource ARN for the outpost, please reference To view the Outpost details: https://docs.aws.amazon.com/outposts/latest/userguide/work-with-outposts.html#manage-outpost

ReadonlyavailabilityZone

availabilityZone: string | number

The availability zone where the Outpost resides

Remarks

Include only the letter of the AZ name (i.e. 'a' for 'us-east-1a') to target a subnet created in a specific AZ. Use an integer (i.e. 1) for subnets using a physical mapping ID to an AZ. Please reference the documentation Availability Zone IDs for your AWS resources for more information.

Optional ReadonlylocalGateway

localGateway?: ILocalGatewayConfig

The Local Gateway configuration for the Outpost

Readonlyname

name: string

A friendly name for the Outpost

Remarks

This is a logical name property that can be used to reference the outpost in subnet configurations.

See

SubnetConfig

Settings

Member Visibility

On This Page

Properties