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:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.991Z")
 @Stability(value=Stable)
public class CfnHttpApi
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Serverless::HttpApi`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnHttpApi.AccessLogSettingProperty Example:
static 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnHttpApi(software.constructs.Construct scope, String id) Create a new `AWS::Serverless::HttpApi`.
	CfnHttpApi(software.constructs.Construct scope, String id, CfnHttpApiProps props) Create a new `AWS::Serverless::HttpApi`.
protected	CfnHttpApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnHttpApi(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAccessLogSetting() `AWS::Serverless::HttpApi.AccessLogSetting`.
Object	getAuth() `AWS::Serverless::HttpApi.Auth`.
protected Map<String,Object>	getCfnProperties()
Object	getCorsConfiguration() `AWS::Serverless::HttpApi.CorsConfiguration`.
Object	getDefaultRouteSettings() `AWS::Serverless::HttpApi.DefaultRouteSettings`.
Object	getDefinitionBody() `AWS::Serverless::HttpApi.DefinitionBody`.
Object	getDefinitionUri() `AWS::Serverless::HttpApi.DefinitionUri`.
String	getDescription() `AWS::Serverless::HttpApi.Description`.
Object	getDisableExecuteApiEndpoint() `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
Object	getDomain() `AWS::Serverless::HttpApi.Domain`.
Object	getFailOnWarnings() `AWS::Serverless::HttpApi.FailOnWarnings`.
Object	getRouteSettings() `AWS::Serverless::HttpApi.RouteSettings`.
String	getStageName() `AWS::Serverless::HttpApi.StageName`.
Object	getStageVariables() `AWS::Serverless::HttpApi.StageVariables`.
TagManager	getTags() `AWS::Serverless::HttpApi.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessLogSetting(CfnHttpApi.AccessLogSettingProperty value) `AWS::Serverless::HttpApi.AccessLogSetting`.
void	setAccessLogSetting(IResolvable value) `AWS::Serverless::HttpApi.AccessLogSetting`.
void	setAuth(CfnHttpApi.HttpApiAuthProperty value) `AWS::Serverless::HttpApi.Auth`.
void	setAuth(IResolvable value) `AWS::Serverless::HttpApi.Auth`.
void	setCorsConfiguration(Boolean value) `AWS::Serverless::HttpApi.CorsConfiguration`.
void	setCorsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty value) `AWS::Serverless::HttpApi.CorsConfiguration`.
void	setCorsConfiguration(IResolvable value) `AWS::Serverless::HttpApi.CorsConfiguration`.
void	setDefaultRouteSettings(CfnHttpApi.RouteSettingsProperty value) `AWS::Serverless::HttpApi.DefaultRouteSettings`.
void	setDefaultRouteSettings(IResolvable value) `AWS::Serverless::HttpApi.DefaultRouteSettings`.
void	setDefinitionBody(Object value) `AWS::Serverless::HttpApi.DefinitionBody`.
void	setDefinitionUri(CfnHttpApi.S3LocationProperty value) `AWS::Serverless::HttpApi.DefinitionUri`.
void	setDefinitionUri(IResolvable value) `AWS::Serverless::HttpApi.DefinitionUri`.
void	setDefinitionUri(String value) `AWS::Serverless::HttpApi.DefinitionUri`.
void	setDescription(String value) `AWS::Serverless::HttpApi.Description`.
void	setDisableExecuteApiEndpoint(Boolean value) `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
void	setDisableExecuteApiEndpoint(IResolvable value) `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
void	setDomain(CfnHttpApi.HttpApiDomainConfigurationProperty value) `AWS::Serverless::HttpApi.Domain`.
void	setDomain(IResolvable value) `AWS::Serverless::HttpApi.Domain`.
void	setFailOnWarnings(Boolean value) `AWS::Serverless::HttpApi.FailOnWarnings`.
void	setFailOnWarnings(IResolvable value) `AWS::Serverless::HttpApi.FailOnWarnings`.
void	setRouteSettings(CfnHttpApi.RouteSettingsProperty value) `AWS::Serverless::HttpApi.RouteSettings`.
void	setRouteSettings(IResolvable value) `AWS::Serverless::HttpApi.RouteSettings`.
void	setStageName(String value) `AWS::Serverless::HttpApi.StageName`.
void	setStageVariables(IResolvable value) `AWS::Serverless::HttpApi.StageVariables`.
void	setStageVariables(Map<String,String> value) `AWS::Serverless::HttpApi.StageVariables`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

@Stability(value=Stable)
public static final String REQUIRED_TRANSFORM

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

Constructor Detail

CfnHttpApi

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

CfnHttpApi

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

CfnHttpApi

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

Create a new `AWS::Serverless::HttpApi`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnHttpApi

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

Create a new `AWS::Serverless::HttpApi`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::Serverless::HttpApi.Tags`.

getDefinitionBody

@Stability(value=Stable)
 @NotNull
public Object getDefinitionBody()

`AWS::Serverless::HttpApi.DefinitionBody`.

setDefinitionBody

@Stability(value=Stable)
public void setDefinitionBody(@NotNull
                                                       Object value)

`AWS::Serverless::HttpApi.DefinitionBody`.

getAccessLogSetting

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

`AWS::Serverless::HttpApi.AccessLogSetting`.

setAccessLogSetting

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

`AWS::Serverless::HttpApi.AccessLogSetting`.

setAccessLogSetting

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

`AWS::Serverless::HttpApi.AccessLogSetting`.

getAuth

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

`AWS::Serverless::HttpApi.Auth`.

setAuth

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

`AWS::Serverless::HttpApi.Auth`.

setAuth

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

`AWS::Serverless::HttpApi.Auth`.

getCorsConfiguration

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

`AWS::Serverless::HttpApi.CorsConfiguration`.

setCorsConfiguration

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

`AWS::Serverless::HttpApi.CorsConfiguration`.

setCorsConfiguration

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

`AWS::Serverless::HttpApi.CorsConfiguration`.

setCorsConfiguration

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

`AWS::Serverless::HttpApi.CorsConfiguration`.

getDefaultRouteSettings

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

`AWS::Serverless::HttpApi.DefaultRouteSettings`.

setDefaultRouteSettings

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

`AWS::Serverless::HttpApi.DefaultRouteSettings`.

setDefaultRouteSettings

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

`AWS::Serverless::HttpApi.DefaultRouteSettings`.

getDefinitionUri

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

`AWS::Serverless::HttpApi.DefinitionUri`.

setDefinitionUri

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

`AWS::Serverless::HttpApi.DefinitionUri`.

setDefinitionUri

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

`AWS::Serverless::HttpApi.DefinitionUri`.

setDefinitionUri

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

`AWS::Serverless::HttpApi.DefinitionUri`.

getDescription

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

`AWS::Serverless::HttpApi.Description`.

setDescription

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

`AWS::Serverless::HttpApi.Description`.

getDisableExecuteApiEndpoint

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

`AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.

setDisableExecuteApiEndpoint

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

`AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.

setDisableExecuteApiEndpoint

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

`AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.

getDomain

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

`AWS::Serverless::HttpApi.Domain`.

setDomain

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

`AWS::Serverless::HttpApi.Domain`.

setDomain

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

`AWS::Serverless::HttpApi.Domain`.

getFailOnWarnings

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

`AWS::Serverless::HttpApi.FailOnWarnings`.

setFailOnWarnings

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

`AWS::Serverless::HttpApi.FailOnWarnings`.

setFailOnWarnings

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

`AWS::Serverless::HttpApi.FailOnWarnings`.

getRouteSettings

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

`AWS::Serverless::HttpApi.RouteSettings`.

setRouteSettings

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

`AWS::Serverless::HttpApi.RouteSettings`.

setRouteSettings

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

`AWS::Serverless::HttpApi.RouteSettings`.

getStageName

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

`AWS::Serverless::HttpApi.StageName`.

setStageName

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

`AWS::Serverless::HttpApi.StageName`.

getStageVariables

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

`AWS::Serverless::HttpApi.StageVariables`.

setStageVariables

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

`AWS::Serverless::HttpApi.StageVariables`.

setStageVariables

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

`AWS::Serverless::HttpApi.StageVariables`.