aws-cdk-lib.aws_refactorspaces.CfnApplication.ApiGatewayProxyInputProperty

interface ApiGatewayProxyInputProperty

LanguageType name
.NETAmazon.CDK.AWS.RefactorSpaces.CfnApplication.ApiGatewayProxyInputProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrefactorspaces#CfnApplication_ApiGatewayProxyInputProperty
Javasoftware.amazon.awscdk.services.refactorspaces.CfnApplication.ApiGatewayProxyInputProperty
Pythonaws_cdk.aws_refactorspaces.CfnApplication.ApiGatewayProxyInputProperty
TypeScript aws-cdk-lib » aws_refactorspaces » CfnApplication » ApiGatewayProxyInputProperty

A wrapper object holding the Amazon API Gateway endpoint input.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_refactorspaces as refactorspaces } from 'aws-cdk-lib';
const apiGatewayProxyInputProperty: refactorspaces.CfnApplication.ApiGatewayProxyInputProperty = {
  endpointType: 'endpointType',
  stageName: 'stageName',
};

Properties

NameTypeDescription
endpointType?stringThe type of endpoint to use for the API Gateway proxy.
stageName?stringThe name of the API Gateway stage.

endpointType?

Type: string (optional)

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 ) .


stageName?

Type: string (optional)

The name of the API Gateway stage.

The name defaults to prod .