Package 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.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.301Z")
@Stability(Stable)
public interface CfnApiProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApi.

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;
 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)
         .ipAddressType("ipAddressType")
         .name("name")
         .protocolType("protocolType")
         .routeKey("routeKey")
         .routeSelectionExpression("routeSelectionExpression")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .target("target")
         .version("version")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApiProps.Builder	builder()
default String	getApiKeySelectionExpression()	An API key selection expression.
default String	getBasePath()	Specifies how to interpret the base path of the API during import.
default Object	getBody()	The OpenAPI definition.
default Object	getBodyS3Location()	The S3 location of an OpenAPI definition.
default Object	getCorsConfiguration()	A CORS configuration.
default String	getCredentialsArn()	This property is part of quick create.
default String	getDescription()	The description of the API.
default Object	getDisableExecuteApiEndpoint()	Specifies whether clients can invoke your API by using the default execute-api endpoint.
default Object	getDisableSchemaValidation()	Avoid validating models when creating a deployment.
default Object	getFailOnWarnings()	Specifies whether to rollback the API creation when a warning is encountered.
default String	getIpAddressType()	The IP address types that can invoke the API.
default String	getName()	The name of the API.
default String	getProtocolType()	The API protocol.
default String	getRouteKey()	This property is part of quick create.
default String	getRouteSelectionExpression()	The route selection expression for the API.
default Map<String,String>	getTags()	The collection of tags.
default Object	getTarget()	This property is part of quick create.
default String	getVersion()	A version identifier for the API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKeySelectionExpression

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

An API key selection expression.

Supported only for WebSocket APIs. See API Key Selection Expressions .

See Also:

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

getBasePath

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

Specifies how to interpret the base path of the API during import.

Valid values are ignore , prepend , and split . The default value is ignore . To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.

See Also:

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

getBody

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

The OpenAPI definition.

Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.

See Also:

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

getBodyS3Location

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

The S3 location of an OpenAPI definition.

Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.

Returns union: either IResolvable or CfnApi.BodyS3LocationProperty

See Also:

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

getCorsConfiguration

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

A CORS configuration.

Supported only for HTTP APIs. See Configuring CORS for more information.

Returns union: either IResolvable or CfnApi.CorsProperty

See Also:

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

getCredentialsArn

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

This property is part of quick create.

It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, specify null . Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

See Also:

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

getDescription

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

The description of the API.

See Also:

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

getDisableExecuteApiEndpoint

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

Specifies whether clients can invoke your API by using the default execute-api endpoint.

By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Returns union: either Boolean or IResolvable

See Also:

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

getDisableSchemaValidation

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

Avoid validating models when creating a deployment.

Supported only for WebSocket APIs.

Returns union: either Boolean or IResolvable

See Also:

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

getFailOnWarnings

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

Specifies whether to rollback the API creation when a warning is encountered.

By default, API creation continues if a warning is encountered.

Returns union: either Boolean or IResolvable

See Also:

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

getIpAddressType

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

The IP address types that can invoke the API.

Use ipv4 to allow only IPv4 addresses to invoke your API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your API.

Don’t use IP address type for an HTTP API based on an OpenAPI specification. Instead, specify the IP address type in the OpenAPI specification.

See Also:

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

getName

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

The name of the API.

Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

See Also:

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

getProtocolType

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

The API protocol.

Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

See Also:

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

getRouteKey

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

This property is part of quick create.

If you don't specify a routeKey , a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

See Also:

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

getRouteSelectionExpression

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

The route selection expression for the API.

For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path} . If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The collection of tags.

Each tag element is associated with a given resource.

See Also:

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

getTarget

@Stability(Stable)
@Nullable
default Object getTarget()

This property is part of quick create.

Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

Returns union: either String or IFunctionRef

See Also:

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

getVersion

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

A version identifier for the API.

See Also:

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

builder

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

Returns:

a CfnApiProps.Builder of CfnApiProps