Class CfnHttpApi.Builder
java.lang.Object
software.amazon.awscdk.services.sam.CfnHttpApi.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnHttpApi>
- Enclosing class:
CfnHttpApi
@Stability(Stable)
public static final class CfnHttpApi.Builder
extends Object
implements software.amazon.jsii.Builder<CfnHttpApi>
A fluent builder for
CfnHttpApi.-
Method Summary
Modifier and TypeMethodDescriptionaccessLogSetting(software.amazon.awscdk.core.IResolvable accessLogSetting) `AWS::Serverless::HttpApi.AccessLogSetting`.accessLogSetting(CfnHttpApi.AccessLogSettingProperty accessLogSetting) `AWS::Serverless::HttpApi.AccessLogSetting`.auth(software.amazon.awscdk.core.IResolvable auth) `AWS::Serverless::HttpApi.Auth`.`AWS::Serverless::HttpApi.Auth`.build()corsConfiguration(Boolean corsConfiguration) `AWS::Serverless::HttpApi.CorsConfiguration`.corsConfiguration(software.amazon.awscdk.core.IResolvable corsConfiguration) `AWS::Serverless::HttpApi.CorsConfiguration`.corsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty corsConfiguration) `AWS::Serverless::HttpApi.CorsConfiguration`.static CfnHttpApi.BuilderdefaultRouteSettings(software.amazon.awscdk.core.IResolvable defaultRouteSettings) `AWS::Serverless::HttpApi.DefaultRouteSettings`.defaultRouteSettings(CfnHttpApi.RouteSettingsProperty defaultRouteSettings) `AWS::Serverless::HttpApi.DefaultRouteSettings`.definitionBody(Object definitionBody) `AWS::Serverless::HttpApi.DefinitionBody`.definitionUri(String definitionUri) `AWS::Serverless::HttpApi.DefinitionUri`.definitionUri(software.amazon.awscdk.core.IResolvable definitionUri) `AWS::Serverless::HttpApi.DefinitionUri`.definitionUri(CfnHttpApi.S3LocationProperty definitionUri) `AWS::Serverless::HttpApi.DefinitionUri`.description(String description) `AWS::Serverless::HttpApi.Description`.disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.disableExecuteApiEndpoint(software.amazon.awscdk.core.IResolvable disableExecuteApiEndpoint) `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.domain(software.amazon.awscdk.core.IResolvable domain) `AWS::Serverless::HttpApi.Domain`.`AWS::Serverless::HttpApi.Domain`.failOnWarnings(Boolean failOnWarnings) `AWS::Serverless::HttpApi.FailOnWarnings`.failOnWarnings(software.amazon.awscdk.core.IResolvable failOnWarnings) `AWS::Serverless::HttpApi.FailOnWarnings`.routeSettings(software.amazon.awscdk.core.IResolvable routeSettings) `AWS::Serverless::HttpApi.RouteSettings`.routeSettings(CfnHttpApi.RouteSettingsProperty routeSettings) `AWS::Serverless::HttpApi.RouteSettings`.`AWS::Serverless::HttpApi.StageName`.stageVariables(Map<String, String> stageVariables) `AWS::Serverless::HttpApi.StageVariables`.stageVariables(software.amazon.awscdk.core.IResolvable stageVariables) `AWS::Serverless::HttpApi.StageVariables`.`AWS::Serverless::HttpApi.Tags`.
-
Method Details
-
create
@Stability(Stable) public static CfnHttpApi.Builder create(software.amazon.awscdk.core.Construct scope, String id) - Parameters:
scope- - scope in which this resource is defined. This parameter is required.id- - scoped id of the resource. This parameter is required.- Returns:
- a new instance of
CfnHttpApi.Builder.
-
accessLogSetting
@Stability(Stable) public CfnHttpApi.Builder accessLogSetting(software.amazon.awscdk.core.IResolvable accessLogSetting) `AWS::Serverless::HttpApi.AccessLogSetting`.- Parameters:
accessLogSetting- `AWS::Serverless::HttpApi.AccessLogSetting`. This parameter is required.- Returns:
this
-
accessLogSetting
@Stability(Stable) public CfnHttpApi.Builder accessLogSetting(CfnHttpApi.AccessLogSettingProperty accessLogSetting) `AWS::Serverless::HttpApi.AccessLogSetting`.- Parameters:
accessLogSetting- `AWS::Serverless::HttpApi.AccessLogSetting`. This parameter is required.- Returns:
this
-
auth
`AWS::Serverless::HttpApi.Auth`.- Parameters:
auth- `AWS::Serverless::HttpApi.Auth`. This parameter is required.- Returns:
this
-
auth
`AWS::Serverless::HttpApi.Auth`.- Parameters:
auth- `AWS::Serverless::HttpApi.Auth`. This parameter is required.- Returns:
this
-
corsConfiguration
`AWS::Serverless::HttpApi.CorsConfiguration`.- Parameters:
corsConfiguration- `AWS::Serverless::HttpApi.CorsConfiguration`. This parameter is required.- Returns:
this
-
corsConfiguration
@Stability(Stable) public CfnHttpApi.Builder corsConfiguration(software.amazon.awscdk.core.IResolvable corsConfiguration) `AWS::Serverless::HttpApi.CorsConfiguration`.- Parameters:
corsConfiguration- `AWS::Serverless::HttpApi.CorsConfiguration`. This parameter is required.- Returns:
this
-
corsConfiguration
@Stability(Stable) public CfnHttpApi.Builder corsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty corsConfiguration) `AWS::Serverless::HttpApi.CorsConfiguration`.- Parameters:
corsConfiguration- `AWS::Serverless::HttpApi.CorsConfiguration`. This parameter is required.- Returns:
this
-
defaultRouteSettings
@Stability(Stable) public CfnHttpApi.Builder defaultRouteSettings(software.amazon.awscdk.core.IResolvable defaultRouteSettings) `AWS::Serverless::HttpApi.DefaultRouteSettings`.- Parameters:
defaultRouteSettings- `AWS::Serverless::HttpApi.DefaultRouteSettings`. This parameter is required.- Returns:
this
-
defaultRouteSettings
@Stability(Stable) public CfnHttpApi.Builder defaultRouteSettings(CfnHttpApi.RouteSettingsProperty defaultRouteSettings) `AWS::Serverless::HttpApi.DefaultRouteSettings`.- Parameters:
defaultRouteSettings- `AWS::Serverless::HttpApi.DefaultRouteSettings`. This parameter is required.- Returns:
this
-
definitionBody
`AWS::Serverless::HttpApi.DefinitionBody`.- Parameters:
definitionBody- `AWS::Serverless::HttpApi.DefinitionBody`. This parameter is required.- Returns:
this
-
definitionUri
`AWS::Serverless::HttpApi.DefinitionUri`.- Parameters:
definitionUri- `AWS::Serverless::HttpApi.DefinitionUri`. This parameter is required.- Returns:
this
-
definitionUri
@Stability(Stable) public CfnHttpApi.Builder definitionUri(software.amazon.awscdk.core.IResolvable definitionUri) `AWS::Serverless::HttpApi.DefinitionUri`.- Parameters:
definitionUri- `AWS::Serverless::HttpApi.DefinitionUri`. This parameter is required.- Returns:
this
-
definitionUri
@Stability(Stable) public CfnHttpApi.Builder definitionUri(CfnHttpApi.S3LocationProperty definitionUri) `AWS::Serverless::HttpApi.DefinitionUri`.- Parameters:
definitionUri- `AWS::Serverless::HttpApi.DefinitionUri`. This parameter is required.- Returns:
this
-
description
`AWS::Serverless::HttpApi.Description`.- Parameters:
description- `AWS::Serverless::HttpApi.Description`. This parameter is required.- Returns:
this
-
disableExecuteApiEndpoint
@Stability(Stable) public CfnHttpApi.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.- Parameters:
disableExecuteApiEndpoint- `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`. This parameter is required.- Returns:
this
-
disableExecuteApiEndpoint
@Stability(Stable) public CfnHttpApi.Builder disableExecuteApiEndpoint(software.amazon.awscdk.core.IResolvable disableExecuteApiEndpoint) `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.- Parameters:
disableExecuteApiEndpoint- `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`. This parameter is required.- Returns:
this
-
domain
`AWS::Serverless::HttpApi.Domain`.- Parameters:
domain- `AWS::Serverless::HttpApi.Domain`. This parameter is required.- Returns:
this
-
domain
@Stability(Stable) public CfnHttpApi.Builder domain(CfnHttpApi.HttpApiDomainConfigurationProperty domain) `AWS::Serverless::HttpApi.Domain`.- Parameters:
domain- `AWS::Serverless::HttpApi.Domain`. This parameter is required.- Returns:
this
-
failOnWarnings
`AWS::Serverless::HttpApi.FailOnWarnings`.- Parameters:
failOnWarnings- `AWS::Serverless::HttpApi.FailOnWarnings`. This parameter is required.- Returns:
this
-
failOnWarnings
@Stability(Stable) public CfnHttpApi.Builder failOnWarnings(software.amazon.awscdk.core.IResolvable failOnWarnings) `AWS::Serverless::HttpApi.FailOnWarnings`.- Parameters:
failOnWarnings- `AWS::Serverless::HttpApi.FailOnWarnings`. This parameter is required.- Returns:
this
-
routeSettings
@Stability(Stable) public CfnHttpApi.Builder routeSettings(software.amazon.awscdk.core.IResolvable routeSettings) `AWS::Serverless::HttpApi.RouteSettings`.- Parameters:
routeSettings- `AWS::Serverless::HttpApi.RouteSettings`. This parameter is required.- Returns:
this
-
routeSettings
@Stability(Stable) public CfnHttpApi.Builder routeSettings(CfnHttpApi.RouteSettingsProperty routeSettings) `AWS::Serverless::HttpApi.RouteSettings`.- Parameters:
routeSettings- `AWS::Serverless::HttpApi.RouteSettings`. This parameter is required.- Returns:
this
-
stageName
`AWS::Serverless::HttpApi.StageName`.- Parameters:
stageName- `AWS::Serverless::HttpApi.StageName`. This parameter is required.- Returns:
this
-
stageVariables
@Stability(Stable) public CfnHttpApi.Builder stageVariables(software.amazon.awscdk.core.IResolvable stageVariables) `AWS::Serverless::HttpApi.StageVariables`.- Parameters:
stageVariables- `AWS::Serverless::HttpApi.StageVariables`. This parameter is required.- Returns:
this
-
stageVariables
`AWS::Serverless::HttpApi.StageVariables`.- Parameters:
stageVariables- `AWS::Serverless::HttpApi.StageVariables`. This parameter is required.- Returns:
this
-
tags
`AWS::Serverless::HttpApi.Tags`.- Parameters:
tags- `AWS::Serverless::HttpApi.Tags`. This parameter is required.- Returns:
this
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnHttpApi>
-