ApiGatewayProxyInput

A wrapper object holding the Amazon API Gateway endpoint input.

Contents

EndpointType

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (AWS PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (AWS PrivateLink).

Type: String

Valid Values: REGIONAL | PRIVATE

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3