software.amazon.awscdk.services.apigatewayv2

Interface CfnApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.464Z")
 @Stability(value=Stable)
public interface CfnApiProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGatewayV2::Api`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnApiProps.Builder	builder()
default String	getApiKeySelectionExpression() `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.
default String	getBasePath() `AWS::ApiGatewayV2::Api.BasePath`.
default Object	getBody() `AWS::ApiGatewayV2::Api.Body`.
default Object	getBodyS3Location() `AWS::ApiGatewayV2::Api.BodyS3Location`.
default Object	getCorsConfiguration() `AWS::ApiGatewayV2::Api.CorsConfiguration`.
default String	getCredentialsArn() `AWS::ApiGatewayV2::Api.CredentialsArn`.
default String	getDescription() `AWS::ApiGatewayV2::Api.Description`.
default Object	getDisableExecuteApiEndpoint() `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
default Object	getDisableSchemaValidation() `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
default Object	getFailOnWarnings() `AWS::ApiGatewayV2::Api.FailOnWarnings`.
default String	getName() `AWS::ApiGatewayV2::Api.Name`.
default String	getProtocolType() `AWS::ApiGatewayV2::Api.ProtocolType`.
default String	getRouteKey() `AWS::ApiGatewayV2::Api.RouteKey`.
default String	getRouteSelectionExpression() `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.
default Object	getTags() `AWS::ApiGatewayV2::Api.Tags`.
default String	getTarget() `AWS::ApiGatewayV2::Api.Target`.
default String	getVersion() `AWS::ApiGatewayV2::Api.Version`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiKeySelectionExpression

@Stability(value=Stable)
 @Nullable
default String getApiKeySelectionExpression()

`AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression

getBasePath

@Stability(value=Stable)
 @Nullable
default String getBasePath()

`AWS::ApiGatewayV2::Api.BasePath`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath

getBody

@Stability(value=Stable)
 @Nullable
default Object getBody()

`AWS::ApiGatewayV2::Api.Body`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body

getBodyS3Location

@Stability(value=Stable)
 @Nullable
default Object getBodyS3Location()

`AWS::ApiGatewayV2::Api.BodyS3Location`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location

getCorsConfiguration

@Stability(value=Stable)
 @Nullable
default Object getCorsConfiguration()

`AWS::ApiGatewayV2::Api.CorsConfiguration`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration

getCredentialsArn

@Stability(value=Stable)
 @Nullable
default String getCredentialsArn()

`AWS::ApiGatewayV2::Api.CredentialsArn`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::ApiGatewayV2::Api.Description`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description

getDisableExecuteApiEndpoint

@Stability(value=Stable)
 @Nullable
default Object getDisableExecuteApiEndpoint()

`AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint

getDisableSchemaValidation

@Stability(value=Stable)
 @Nullable
default Object getDisableSchemaValidation()

`AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation

getFailOnWarnings

@Stability(value=Stable)
 @Nullable
default Object getFailOnWarnings()

`AWS::ApiGatewayV2::Api.FailOnWarnings`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings

getName

@Stability(value=Stable)
 @Nullable
default String getName()

`AWS::ApiGatewayV2::Api.Name`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name

getProtocolType

@Stability(value=Stable)
 @Nullable
default String getProtocolType()

`AWS::ApiGatewayV2::Api.ProtocolType`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype

getRouteKey

@Stability(value=Stable)
 @Nullable
default String getRouteKey()

`AWS::ApiGatewayV2::Api.RouteKey`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey

getRouteSelectionExpression

@Stability(value=Stable)
 @Nullable
default String getRouteSelectionExpression()

`AWS::ApiGatewayV2::Api.RouteSelectionExpression`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression

getTags

@Stability(value=Stable)
 @Nullable
default Object getTags()

`AWS::ApiGatewayV2::Api.Tags`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags

getTarget

@Stability(value=Stable)
 @Nullable
default String getTarget()

`AWS::ApiGatewayV2::Api.Target`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target

getVersion

@Stability(value=Stable)
 @Nullable
default String getVersion()

`AWS::ApiGatewayV2::Api.Version`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version

builder

@Stability(value=Stable)
static CfnApiProps.Builder builder()

Returns:

a CfnApiProps.Builder of CfnApiProps