Package software.amazon.awscdk.services.refactorspaces

Interface CfnApplication.ApiGatewayProxyInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplication.ApiGatewayProxyInputProperty.Jsii$Proxy

Enclosing class:

CfnApplication

@Stability(Stable)
public static interface CfnApplication.ApiGatewayProxyInputProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.refactorspaces.*;
 ApiGatewayProxyInputProperty apiGatewayProxyInputProperty = ApiGatewayProxyInputProperty.builder()
         .endpointType("endpointType")
         .stageName("stageName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplication.ApiGatewayProxyInputProperty.Builder	A builder for CfnApplication.ApiGatewayProxyInputProperty
static final class	CfnApplication.ApiGatewayProxyInputProperty.Jsii$Proxy	An implementation for CfnApplication.ApiGatewayProxyInputProperty

Method Summary

Modifier and Type	Method	Description
static CfnApplication.ApiGatewayProxyInputProperty.Builder	builder()
default String	getEndpointType()	The type of endpoint to use for the API Gateway proxy.
default String	getStageName()	The name of the API Gateway stage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointType

@Stability(Stable)
@Nullable
default String getEndpointType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-endpointtype

getStageName

@Stability(Stable)
@Nullable
default String getStageName()

The name of the API Gateway stage.

The name defaults to prod .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-stagename

builder

@Stability(Stable)
static CfnApplication.ApiGatewayProxyInputProperty.Builder builder()

Returns:

a CfnApplication.ApiGatewayProxyInputProperty.Builder of CfnApplication.ApiGatewayProxyInputProperty