Show / Hide Table of Contents

Interface CfnApplicationPropsMixin.IApiGatewayProxyInputProperty

A wrapper object holding the Amazon API Gateway endpoint input.

Namespace: Amazon.CDK.Mixins.Preview.AWS.RefactorSpaces.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public interface CfnApplicationPropsMixin.IApiGatewayProxyInputProperty
Syntax (vb)
Public Interface CfnApplicationPropsMixin.IApiGatewayProxyInputProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.RefactorSpaces.Mixins;

             var apiGatewayProxyInputProperty = new ApiGatewayProxyInputProperty {
                 EndpointType = "endpointType",
                 StageName = "stageName"
             };

Synopsis

Properties

EndpointType

The type of endpoint to use for the API Gateway proxy.

StageName

The name of the API Gateway stage.

Properties

EndpointType

The type of endpoint to use for the API Gateway proxy.

string? EndpointType { get; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-endpointtype

StageName

The name of the API Gateway stage.

string? StageName { get; }
Property Value

string

Remarks

The name defaults to prod .

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

Back to top Generated by DocFX