ApiGatewayProxyConfig

A wrapper object holding the Amazon API Gateway proxy configuration.

ApiGatewayId

The resource ID of the API Gateway for the proxy.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[a-z0-9]{10}$

Required: No

EndpointType

The type of API Gateway endpoint created.

Type: String

Valid Values: REGIONAL | PRIVATE

Required: No

NlbArn

The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws:elasticloadbalancing:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$

Required: No

NlbName

The name of the Network Load Balancer that is configured by the API Gateway proxy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^(?!internal-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+.*[^-]$

Required: No

ProxyUrl

The endpoint URL of the API Gateway proxy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]$

Required: No

StageName

The name of the API Gateway stage. The name defaults to prod.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[-a-zA-Z0-9_]*$

Required: No

VpcLinkId

The VpcLink ID of the API Gateway proxy.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[a-z0-9]{10}$

Required: No

Contents