Package software.amazon.awscdk.services.sam

Interface CfnHttpApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnHttpApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:46.828Z")
@Stability(Stable)
public interface CfnHttpApiProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnHttpApi.

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.sam.*;
 Object authorizers;
 Object definitionBody;
 CfnHttpApiProps cfnHttpApiProps = CfnHttpApiProps.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()
                 .certificateArn("certificateArn")
                 .domainName("domainName")
                 // the properties below are optional
                 .basePath("basePath")
                 .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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnHttpApiProps.Builder	builder()
default Object	getAccessLogSetting()	Returns union: either IResolvable or CfnHttpApi.AccessLogSettingProperty
default Object	getAuth()	Returns union: either IResolvable or CfnHttpApi.HttpApiAuthProperty
default Object	getCorsConfiguration()	Returns union: either Boolean or IResolvable or CfnHttpApi.CorsConfigurationObjectProperty
default Object	getDefaultRouteSettings()	Returns union: either IResolvable or CfnHttpApi.RouteSettingsProperty
default Object	getDefinitionBody()
default Object	getDefinitionUri()	Returns union: either String or IResolvable or CfnHttpApi.S3LocationProperty
default String	getDescription()
default Object	getDisableExecuteApiEndpoint()	Returns union: either Boolean or IResolvable
default Object	getDomain()	Returns union: either IResolvable or CfnHttpApi.HttpApiDomainConfigurationProperty
default Object	getFailOnWarnings()	Returns union: either Boolean or IResolvable
default Object	getRouteSettings()	Returns union: either IResolvable or CfnHttpApi.RouteSettingsProperty
default String	getStageName()
default Object	getStageVariables()	Returns union: either Mapinvalid input: '<'String, String> or IResolvable
default Map<String,String>	getTags()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessLogSetting

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

Returns union: either IResolvable or CfnHttpApi.AccessLogSettingProperty

See Also:

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

getAuth

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

Returns union: either IResolvable or CfnHttpApi.HttpApiAuthProperty

See Also:

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

getCorsConfiguration

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

Returns union: either Boolean or IResolvable or CfnHttpApi.CorsConfigurationObjectProperty

See Also:

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

getDefaultRouteSettings

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

Returns union: either IResolvable or CfnHttpApi.RouteSettingsProperty

See Also:

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

getDefinitionBody

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

See Also:

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

getDefinitionUri

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

Returns union: either String or IResolvable or CfnHttpApi.S3LocationProperty

See Also:

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

getDescription

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

See Also:

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

getDisableExecuteApiEndpoint

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

Returns union: either Boolean or IResolvable

See Also:

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

getDomain

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

Returns union: either IResolvable or CfnHttpApi.HttpApiDomainConfigurationProperty

See Also:

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

getFailOnWarnings

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

Returns union: either Boolean or IResolvable

See Also:

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

getRouteSettings

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

Returns union: either IResolvable or CfnHttpApi.RouteSettingsProperty

See Also:

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

getStageName

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

See Also:

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

getStageVariables

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

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getTags

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

See Also:

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

builder

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

Returns:

a CfnHttpApiProps.Builder of CfnHttpApiProps