Package software.amazon.awscdk.cfnpropertymixins.services.sam

Class CfnHttpApiPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sam.CfnHttpApiPropsMixin

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.249Z")
@Stability(Stable)
public class CfnHttpApiPropsMixin
extends Mixin
implements software.constructs.IMixin

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi.

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.sam.*;
 import software.amazon.awscdk.*;
 Object authorizers;
 Object definitionBody;
 IMergeStrategy mergeStrategy;
 CfnHttpApiPropsMixin cfnHttpApiPropsMixin = CfnHttpApiPropsMixin.Builder.create(CfnHttpApiMixinProps.builder()
         .accessLogSetting(AccessLogSettingProperty.builder()
                 .destinationArn("destinationArn")
                 .format("format")
                 .build())
         .auth(HttpApiAuthProperty.builder()
                 .authorizers(authorizers)
                 .defaultAuthorizer("defaultAuthorizer")
                 .build())
         .corsConfiguration(false)
         .defaultRouteSettings(RouteSettingsProperty.builder()
                 .dataTraceEnabled(false)
                 .detailedMetricsEnabled(false)
                 .loggingLevel("loggingLevel")
                 .throttlingBurstLimit(123)
                 .throttlingRateLimit(123)
                 .build())
         .definitionBody(definitionBody)
         .definitionUri("definitionUri")
         .description("description")
         .disableExecuteApiEndpoint(false)
         .domain(HttpApiDomainConfigurationProperty.builder()
                 .basePath("basePath")
                 .certificateArn("certificateArn")
                 .domainName("domainName")
                 .endpointConfiguration("endpointConfiguration")
                 .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                         .truststoreUri("truststoreUri")
                         .truststoreVersion(false)
                         .build())
                 .route53(Route53ConfigurationProperty.builder()
                         .distributedDomainName("distributedDomainName")
                         .evaluateTargetHealth(false)
                         .hostedZoneId("hostedZoneId")
                         .hostedZoneName("hostedZoneName")
                         .ipV6(false)
                         .build())
                 .securityPolicy("securityPolicy")
                 .build())
         .failOnWarnings(false)
         .routeSettings(RouteSettingsProperty.builder()
                 .dataTraceEnabled(false)
                 .detailedMetricsEnabled(false)
                 .loggingLevel("loggingLevel")
                 .throttlingBurstLimit(123)
                 .throttlingRateLimit(123)
                 .build())
         .stageName("stageName")
         .stageVariables(Map.of(
                 "stageVariablesKey", "stageVariables"))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnHttpApiPropsMixin.AccessLogSettingProperty	Example:
static final class	CfnHttpApiPropsMixin.Builder	A fluent builder for CfnHttpApiPropsMixin.
static interface	CfnHttpApiPropsMixin.CorsConfigurationObjectProperty	Example:
static interface	CfnHttpApiPropsMixin.HttpApiAuthProperty	Example:
static interface	CfnHttpApiPropsMixin.HttpApiDomainConfigurationProperty	Example:
static interface	CfnHttpApiPropsMixin.MutualTlsAuthenticationProperty	Example:
static interface	CfnHttpApiPropsMixin.Route53ConfigurationProperty	Example:
static interface	CfnHttpApiPropsMixin.RouteSettingsProperty	Example:
static interface	CfnHttpApiPropsMixin.S3LocationProperty	Example:

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
	CfnHttpApiPropsMixin(CfnHttpApiMixinProps props)	Create a mixin to apply properties to AWS::Serverless::HttpApi.
	CfnHttpApiPropsMixin(CfnHttpApiMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Serverless::HttpApi.
protected	CfnHttpApiPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnHttpApiPropsMixin(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 CfnHttpApiMixinProps	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

CfnHttpApiPropsMixin

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

CfnHttpApiPropsMixin

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

CfnHttpApiPropsMixin

@Stability(Stable)
public CfnHttpApiPropsMixin(@NotNull
 CfnHttpApiMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Serverless::HttpApi.

Parameters:

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

options - Mixin options.

CfnHttpApiPropsMixin

@Stability(Stable)
public CfnHttpApiPropsMixin(@NotNull
 CfnHttpApiMixinProps props)

Create a mixin to apply properties to AWS::Serverless::HttpApi.

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 CfnHttpApiMixinProps getProps()

getStrategy

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