AWS::RefactorSpaces::Application ApiGatewayProxyInput - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::RefactorSpaces::Application ApiGatewayProxyInput

A wrapper object holding the Amazon API Gateway endpoint input.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "EndpointType" : String,
  "StageName" : String
}

YAML

  EndpointType: String
  StageName: String

Properties

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 (Amazon PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon PrivateLink).

Required: No

Type: String

Allowed values: REGIONAL | PRIVATE

Update requires: Replacement

StageName

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

Required: No

Type: String

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

Minimum: 1

Maximum: 128

Update requires: Replacement