software.amazon.awscdk.services.sam

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(value=Stable)
public static final class CfnHttpApi.Builder
extends Object
implements software.amazon.jsii.Builder<CfnHttpApi>

A fluent builder for CfnHttpApi.

Method Summary

Modifier and Type	Method and Description
CfnHttpApi.Builder	accessLogSetting(CfnHttpApi.AccessLogSettingProperty accessLogSetting) `AWS::Serverless::HttpApi.AccessLogSetting`.
CfnHttpApi.Builder	accessLogSetting(IResolvable accessLogSetting) `AWS::Serverless::HttpApi.AccessLogSetting`.
CfnHttpApi.Builder	auth(CfnHttpApi.HttpApiAuthProperty auth) `AWS::Serverless::HttpApi.Auth`.
CfnHttpApi.Builder	auth(IResolvable auth) `AWS::Serverless::HttpApi.Auth`.
CfnHttpApi	build()
CfnHttpApi.Builder	corsConfiguration(Boolean corsConfiguration) `AWS::Serverless::HttpApi.CorsConfiguration`.
CfnHttpApi.Builder	corsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty corsConfiguration) `AWS::Serverless::HttpApi.CorsConfiguration`.
CfnHttpApi.Builder	corsConfiguration(IResolvable corsConfiguration) `AWS::Serverless::HttpApi.CorsConfiguration`.
static CfnHttpApi.Builder	create(software.constructs.Construct scope, String id)
CfnHttpApi.Builder	defaultRouteSettings(CfnHttpApi.RouteSettingsProperty defaultRouteSettings) `AWS::Serverless::HttpApi.DefaultRouteSettings`.
CfnHttpApi.Builder	defaultRouteSettings(IResolvable defaultRouteSettings) `AWS::Serverless::HttpApi.DefaultRouteSettings`.
CfnHttpApi.Builder	definitionBody(Object definitionBody) `AWS::Serverless::HttpApi.DefinitionBody`.
CfnHttpApi.Builder	definitionUri(CfnHttpApi.S3LocationProperty definitionUri) `AWS::Serverless::HttpApi.DefinitionUri`.
CfnHttpApi.Builder	definitionUri(IResolvable definitionUri) `AWS::Serverless::HttpApi.DefinitionUri`.
CfnHttpApi.Builder	definitionUri(String definitionUri) `AWS::Serverless::HttpApi.DefinitionUri`.
CfnHttpApi.Builder	description(String description) `AWS::Serverless::HttpApi.Description`.
CfnHttpApi.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
CfnHttpApi.Builder	disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint) `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
CfnHttpApi.Builder	domain(CfnHttpApi.HttpApiDomainConfigurationProperty domain) `AWS::Serverless::HttpApi.Domain`.
CfnHttpApi.Builder	domain(IResolvable domain) `AWS::Serverless::HttpApi.Domain`.
CfnHttpApi.Builder	failOnWarnings(Boolean failOnWarnings) `AWS::Serverless::HttpApi.FailOnWarnings`.
CfnHttpApi.Builder	failOnWarnings(IResolvable failOnWarnings) `AWS::Serverless::HttpApi.FailOnWarnings`.
CfnHttpApi.Builder	routeSettings(CfnHttpApi.RouteSettingsProperty routeSettings) `AWS::Serverless::HttpApi.RouteSettings`.
CfnHttpApi.Builder	routeSettings(IResolvable routeSettings) `AWS::Serverless::HttpApi.RouteSettings`.
CfnHttpApi.Builder	stageName(String stageName) `AWS::Serverless::HttpApi.StageName`.
CfnHttpApi.Builder	stageVariables(IResolvable stageVariables) `AWS::Serverless::HttpApi.StageVariables`.
CfnHttpApi.Builder	stageVariables(Map<String,String> stageVariables) `AWS::Serverless::HttpApi.StageVariables`.
CfnHttpApi.Builder	tags(Map<String,String> tags) `AWS::Serverless::HttpApi.Tags`.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnHttpApi.Builder create(software.constructs.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.AccessLogSettingProperty.Builder.

accessLogSetting

@Stability(value=Stable)
public CfnHttpApi.Builder accessLogSetting(CfnHttpApi.AccessLogSettingProperty accessLogSetting)

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

Parameters:

accessLogSetting - `AWS::Serverless::HttpApi.AccessLogSetting`. This parameter is required.

Returns:

this

accessLogSetting

@Stability(value=Stable)
public CfnHttpApi.Builder accessLogSetting(IResolvable accessLogSetting)

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

Parameters:

accessLogSetting - `AWS::Serverless::HttpApi.AccessLogSetting`. This parameter is required.

Returns:

this

auth

@Stability(value=Stable)
public CfnHttpApi.Builder auth(CfnHttpApi.HttpApiAuthProperty auth)

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

Parameters:

auth - `AWS::Serverless::HttpApi.Auth`. This parameter is required.

Returns:

this

auth

@Stability(value=Stable)
public CfnHttpApi.Builder auth(IResolvable auth)

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

Parameters:

auth - `AWS::Serverless::HttpApi.Auth`. This parameter is required.

Returns:

this

corsConfiguration

@Stability(value=Stable)
public CfnHttpApi.Builder corsConfiguration(Boolean corsConfiguration)

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

Parameters:

corsConfiguration - `AWS::Serverless::HttpApi.CorsConfiguration`. This parameter is required.

Returns:

this

corsConfiguration

@Stability(value=Stable)
public CfnHttpApi.Builder corsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty corsConfiguration)

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

Parameters:

corsConfiguration - `AWS::Serverless::HttpApi.CorsConfiguration`. This parameter is required.

Returns:

this

corsConfiguration

@Stability(value=Stable)
public CfnHttpApi.Builder corsConfiguration(IResolvable corsConfiguration)

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

Parameters:

corsConfiguration - `AWS::Serverless::HttpApi.CorsConfiguration`. This parameter is required.

Returns:

this

defaultRouteSettings

@Stability(value=Stable)
public CfnHttpApi.Builder defaultRouteSettings(CfnHttpApi.RouteSettingsProperty defaultRouteSettings)

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

Parameters:

defaultRouteSettings - `AWS::Serverless::HttpApi.DefaultRouteSettings`. This parameter is required.

Returns:

this

defaultRouteSettings

@Stability(value=Stable)
public CfnHttpApi.Builder defaultRouteSettings(IResolvable defaultRouteSettings)

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

Parameters:

defaultRouteSettings - `AWS::Serverless::HttpApi.DefaultRouteSettings`. This parameter is required.

Returns:

this

definitionBody

@Stability(value=Stable)
public CfnHttpApi.Builder definitionBody(Object definitionBody)

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

Parameters:

definitionBody - `AWS::Serverless::HttpApi.DefinitionBody`. This parameter is required.

Returns:

this

definitionUri

@Stability(value=Stable)
public CfnHttpApi.Builder definitionUri(String definitionUri)

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

Parameters:

definitionUri - `AWS::Serverless::HttpApi.DefinitionUri`. This parameter is required.

Returns:

this

definitionUri

@Stability(value=Stable)
public CfnHttpApi.Builder definitionUri(CfnHttpApi.S3LocationProperty definitionUri)

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

Parameters:

definitionUri - `AWS::Serverless::HttpApi.DefinitionUri`. This parameter is required.

Returns:

this

definitionUri

@Stability(value=Stable)
public CfnHttpApi.Builder definitionUri(IResolvable definitionUri)

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

Parameters:

definitionUri - `AWS::Serverless::HttpApi.DefinitionUri`. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnHttpApi.Builder description(String description)

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

Parameters:

description - `AWS::Serverless::HttpApi.Description`. This parameter is required.

Returns:

this

disableExecuteApiEndpoint

@Stability(value=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(value=Stable)
public CfnHttpApi.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)

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

Parameters:

disableExecuteApiEndpoint - `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`. This parameter is required.

Returns:

this

domain

@Stability(value=Stable)
public CfnHttpApi.Builder domain(CfnHttpApi.HttpApiDomainConfigurationProperty domain)

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

Parameters:

domain - `AWS::Serverless::HttpApi.Domain`. This parameter is required.

Returns:

this

domain

@Stability(value=Stable)
public CfnHttpApi.Builder domain(IResolvable domain)

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

Parameters:

domain - `AWS::Serverless::HttpApi.Domain`. This parameter is required.

Returns:

this

failOnWarnings

@Stability(value=Stable)
public CfnHttpApi.Builder failOnWarnings(Boolean failOnWarnings)

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

Parameters:

failOnWarnings - `AWS::Serverless::HttpApi.FailOnWarnings`. This parameter is required.

Returns:

this

failOnWarnings

@Stability(value=Stable)
public CfnHttpApi.Builder failOnWarnings(IResolvable failOnWarnings)

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

Parameters:

failOnWarnings - `AWS::Serverless::HttpApi.FailOnWarnings`. This parameter is required.

Returns:

this

routeSettings

@Stability(value=Stable)
public CfnHttpApi.Builder routeSettings(CfnHttpApi.RouteSettingsProperty routeSettings)

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

Parameters:

routeSettings - `AWS::Serverless::HttpApi.RouteSettings`. This parameter is required.

Returns:

this

routeSettings

@Stability(value=Stable)
public CfnHttpApi.Builder routeSettings(IResolvable routeSettings)

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

Parameters:

routeSettings - `AWS::Serverless::HttpApi.RouteSettings`. This parameter is required.

Returns:

this

stageName

@Stability(value=Stable)
public CfnHttpApi.Builder stageName(String stageName)

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

Parameters:

stageName - `AWS::Serverless::HttpApi.StageName`. This parameter is required.

Returns:

this

stageVariables

@Stability(value=Stable)
public CfnHttpApi.Builder stageVariables(IResolvable stageVariables)

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

Parameters:

stageVariables - `AWS::Serverless::HttpApi.StageVariables`. This parameter is required.

Returns:

this

stageVariables

@Stability(value=Stable)
public CfnHttpApi.Builder stageVariables(Map<String,String> stageVariables)

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

Parameters:

stageVariables - `AWS::Serverless::HttpApi.StageVariables`. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnHttpApi.Builder tags(Map<String,String> tags)

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

Parameters:

tags - `AWS::Serverless::HttpApi.Tags`. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnHttpApi build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnHttpApi>