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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.777Z")
 @Stability(value=Stable)
public interface CfnApiProps
extends software.amazon.jsii.JsiiSerializable

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

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.apigatewayv2.*;
 Object body;
 Object tags;
 CfnApiProps cfnApiProps = CfnApiProps.builder()
         .apiKeySelectionExpression("apiKeySelectionExpression")
         .basePath("basePath")
         .body(body)
         .bodyS3Location(BodyS3LocationProperty.builder()
                 .bucket("bucket")
                 .etag("etag")
                 .key("key")
                 .version("version")
                 .build())
         .corsConfiguration(CorsProperty.builder()
                 .allowCredentials(false)
                 .allowHeaders(List.of("allowHeaders"))
                 .allowMethods(List.of("allowMethods"))
                 .allowOrigins(List.of("allowOrigins"))
                 .exposeHeaders(List.of("exposeHeaders"))
                 .maxAge(123)
                 .build())
         .credentialsArn("credentialsArn")
         .description("description")
         .disableExecuteApiEndpoint(false)
         .disableSchemaValidation(false)
         .failOnWarnings(false)
         .name("name")
         .protocolType("protocolType")
         .routeKey("routeKey")
         .routeSelectionExpression("routeSelectionExpression")
         .tags(tags)
         .target("target")
         .version("version")
         .build();
 

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

getBasePath

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

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

getBody

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

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

getBodyS3Location

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

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

getCorsConfiguration

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

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

getCredentialsArn

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

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

getDescription

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

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

getDisableExecuteApiEndpoint

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

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

getDisableSchemaValidation

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

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

getFailOnWarnings

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

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

getName

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

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

getProtocolType

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

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

getRouteKey

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

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

getRouteSelectionExpression

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

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

getTags

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

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

getTarget

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

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

getVersion

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

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

builder

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

Returns:

a CfnApiProps.Builder of CfnApiProps