Package software.amazon.awscdk.services.sam

Class CfnHttpApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sam.CfnHttpApi

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITaggable, IHttpApiRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:50.084Z")
@Stability(Stable)
public class CfnHttpApi
extends CfnResource
implements IInspectable, IHttpApiRef, ITaggable

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.services.sam.*;
 Object authorizers;
 Object definitionBody;
 CfnHttpApi cfnHttpApi = CfnHttpApi.Builder.create(this, "MyCfnHttpApi")
         .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	Class	Description
static interface	CfnHttpApi.AccessLogSettingProperty	Example:
static final class	CfnHttpApi.Builder	A fluent builder for CfnHttpApi.
static interface	CfnHttpApi.CorsConfigurationObjectProperty	Example:
static interface	CfnHttpApi.HttpApiAuthProperty	Example:
static interface	CfnHttpApi.HttpApiDomainConfigurationProperty	Example:
static interface	CfnHttpApi.MutualTlsAuthenticationProperty	Example:
static interface	CfnHttpApi.Route53ConfigurationProperty	Example:
static interface	CfnHttpApi.RouteSettingsProperty	Example:
static interface	CfnHttpApi.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sam.IHttpApiRef

IHttpApiRef.Jsii$Default, IHttpApiRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
static final String	REQUIRED_TRANSFORM	The Transform a template must use in order to use this resource.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnHttpApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnHttpApi(software.amazon.jsii.JsiiObjectRef objRef)
	CfnHttpApi(software.constructs.Construct scope, String id)
	CfnHttpApi(software.constructs.Construct scope, String id, CfnHttpApiProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAccessLogSetting()	Returns union: either IResolvable or CfnHttpApi.AccessLogSettingProperty
Object	getAuth()	Returns union: either IResolvable or CfnHttpApi.HttpApiAuthProperty
protected Map<String,Object>	getCfnProperties()
Object	getCorsConfiguration()	Returns union: either Boolean or IResolvable or CfnHttpApi.CorsConfigurationObjectProperty
Object	getDefaultRouteSettings()	Returns union: either IResolvable or CfnHttpApi.RouteSettingsProperty
Object	getDefinitionBody()
Object	getDefinitionUri()	Returns union: either String or IResolvable or CfnHttpApi.S3LocationProperty
String	getDescription()
Object	getDisableExecuteApiEndpoint()	Returns union: either Boolean or IResolvable
Object	getDomain()	Returns union: either IResolvable or CfnHttpApi.HttpApiDomainConfigurationProperty
Object	getFailOnWarnings()	Returns union: either Boolean or IResolvable
HttpApiReference	getHttpApiRef()	A reference to a HttpApi resource.
Object	getRouteSettings()	Returns union: either IResolvable or CfnHttpApi.RouteSettingsProperty
String	getStageName()
Object	getStageVariables()	Returns union: either Mapinvalid input: '<'String, String> or IResolvable
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Map<String,String>	getTagsRaw()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessLogSetting(IResolvable value)
void	setAccessLogSetting(CfnHttpApi.AccessLogSettingProperty value)
void	setAuth(IResolvable value)
void	setAuth(CfnHttpApi.HttpApiAuthProperty value)
void	setCorsConfiguration(Boolean value)
void	setCorsConfiguration(IResolvable value)
void	setCorsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty value)
void	setDefaultRouteSettings(IResolvable value)
void	setDefaultRouteSettings(CfnHttpApi.RouteSettingsProperty value)
void	setDefinitionBody(Object value)
void	setDefinitionUri(String value)
void	setDefinitionUri(IResolvable value)
void	setDefinitionUri(CfnHttpApi.S3LocationProperty value)
void	setDescription(String value)
void	setDisableExecuteApiEndpoint(Boolean value)
void	setDisableExecuteApiEndpoint(IResolvable value)
void	setDomain(IResolvable value)
void	setDomain(CfnHttpApi.HttpApiDomainConfigurationProperty value)
void	setFailOnWarnings(Boolean value)
void	setFailOnWarnings(IResolvable value)
void	setRouteSettings(IResolvable value)
void	setRouteSettings(CfnHttpApi.RouteSettingsProperty value)
void	setStageName(String value)
void	setStageVariables(Map<String,String> value)
void	setStageVariables(IResolvable value)
void	setTagsRaw(Map<String,String> value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

@Stability(Stable)
public static final String REQUIRED_TRANSFORM

The Transform a template must use in order to use this resource.

Constructor Details

CfnHttpApi

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

CfnHttpApi

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

CfnHttpApi

@Stability(Stable)
public CfnHttpApi(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnHttpApiProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnHttpApi

@Stability(Stable)
public CfnHttpApi(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getHttpApiRef

@Stability(Stable)
@NotNull
public HttpApiReference getHttpApiRef()

A reference to a HttpApi resource.

Specified by:

getHttpApiRef in interface IHttpApiRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAccessLogSetting

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

Returns union: either IResolvable or CfnHttpApi.AccessLogSettingProperty

setAccessLogSetting

@Stability(Stable)
public void setAccessLogSetting(@Nullable
 IResolvable value)

setAccessLogSetting

@Stability(Stable)
public void setAccessLogSetting(@Nullable
 CfnHttpApi.AccessLogSettingProperty value)

getAuth

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

Returns union: either IResolvable or CfnHttpApi.HttpApiAuthProperty

setAuth

@Stability(Stable)
public void setAuth(@Nullable
 IResolvable value)

setAuth

@Stability(Stable)
public void setAuth(@Nullable
 CfnHttpApi.HttpApiAuthProperty value)

getCorsConfiguration

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

Returns union: either Boolean or IResolvable or CfnHttpApi.CorsConfigurationObjectProperty

setCorsConfiguration

@Stability(Stable)
public void setCorsConfiguration(@Nullable
 Boolean value)

setCorsConfiguration

@Stability(Stable)
public void setCorsConfiguration(@Nullable
 IResolvable value)

setCorsConfiguration

@Stability(Stable)
public void setCorsConfiguration(@Nullable
 CfnHttpApi.CorsConfigurationObjectProperty value)

getDefaultRouteSettings

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

Returns union: either IResolvable or CfnHttpApi.RouteSettingsProperty

setDefaultRouteSettings

@Stability(Stable)
public void setDefaultRouteSettings(@Nullable
 IResolvable value)

setDefaultRouteSettings

@Stability(Stable)
public void setDefaultRouteSettings(@Nullable
 CfnHttpApi.RouteSettingsProperty value)

getDefinitionBody

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

setDefinitionBody

@Stability(Stable)
public void setDefinitionBody(@Nullable
 Object value)

getDefinitionUri

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

Returns union: either String or IResolvable or CfnHttpApi.S3LocationProperty

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 String value)

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 IResolvable value)

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 CfnHttpApi.S3LocationProperty value)

getDescription

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

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

getDisableExecuteApiEndpoint

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

Returns union: either Boolean or IResolvable

setDisableExecuteApiEndpoint

@Stability(Stable)
public void setDisableExecuteApiEndpoint(@Nullable
 Boolean value)

setDisableExecuteApiEndpoint

@Stability(Stable)
public void setDisableExecuteApiEndpoint(@Nullable
 IResolvable value)

getDomain

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

Returns union: either IResolvable or CfnHttpApi.HttpApiDomainConfigurationProperty

setDomain

@Stability(Stable)
public void setDomain(@Nullable
 IResolvable value)

setDomain

@Stability(Stable)
public void setDomain(@Nullable
 CfnHttpApi.HttpApiDomainConfigurationProperty value)

getFailOnWarnings

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

Returns union: either Boolean or IResolvable

setFailOnWarnings

@Stability(Stable)
public void setFailOnWarnings(@Nullable
 Boolean value)

setFailOnWarnings

@Stability(Stable)
public void setFailOnWarnings(@Nullable
 IResolvable value)

getRouteSettings

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

Returns union: either IResolvable or CfnHttpApi.RouteSettingsProperty

setRouteSettings

@Stability(Stable)
public void setRouteSettings(@Nullable
 IResolvable value)

setRouteSettings

@Stability(Stable)
public void setRouteSettings(@Nullable
 CfnHttpApi.RouteSettingsProperty value)

getStageName

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

setStageName

@Stability(Stable)
public void setStageName(@Nullable
 String value)

getStageVariables

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

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

setStageVariables

@Stability(Stable)
public void setStageVariables(@Nullable
 Map<String,String> value)

setStageVariables

@Stability(Stable)
public void setStageVariables(@Nullable
 IResolvable value)

getTagsRaw

@Stability(Stable)
@Nullable
public Map<String,String> getTagsRaw()

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Map<String,String> value)