Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Class CfnApiPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.CfnApiPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:23.224Z")
@Stability(Stable)
public class CfnApiPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::ApiGatewayV2::Api resource creates an API.

WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway in the API Gateway Developer Guide . For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.*;
 import software.amazon.awscdk.*;
 Object body;
 IMergeStrategy mergeStrategy;
 CfnApiPropsMixin cfnApiPropsMixin = CfnApiPropsMixin.Builder.create(CfnApiMixinProps.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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnApiPropsMixin.BodyS3LocationProperty	The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition.
static final class	CfnApiPropsMixin.Builder	A fluent builder for CfnApiPropsMixin.
static interface	CfnApiPropsMixin.CorsProperty	The Cors property specifies a CORS configuration for an API.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnApiPropsMixin(CfnApiMixinProps props)	Create a mixin to apply properties to AWS::ApiGatewayV2::Api.
	CfnApiPropsMixin(CfnApiMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGatewayV2::Api.
protected	CfnApiPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApiPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnApiMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnApiPropsMixin

protected CfnApiPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnApiPropsMixin

protected CfnApiPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApiPropsMixin

@Stability(Stable)
public CfnApiPropsMixin(@NotNull
 CfnApiMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGatewayV2::Api.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnApiPropsMixin

@Stability(Stable)
public CfnApiPropsMixin(@NotNull
 CfnApiMixinProps props)

Create a mixin to apply properties to AWS::ApiGatewayV2::Api.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnApiMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()