Package 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(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	Description
CfnHttpApi.Builder	accessLogSetting(IResolvable accessLogSetting)
CfnHttpApi.Builder	accessLogSetting(CfnHttpApi.AccessLogSettingProperty accessLogSetting)
CfnHttpApi.Builder	auth(IResolvable auth)
CfnHttpApi.Builder	auth(CfnHttpApi.HttpApiAuthProperty auth)
CfnHttpApi	build()
CfnHttpApi.Builder	corsConfiguration(Boolean corsConfiguration)
CfnHttpApi.Builder	corsConfiguration(IResolvable corsConfiguration)
CfnHttpApi.Builder	corsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty corsConfiguration)
static CfnHttpApi.Builder	create(software.constructs.Construct scope, String id)
CfnHttpApi.Builder	defaultRouteSettings(IResolvable defaultRouteSettings)
CfnHttpApi.Builder	defaultRouteSettings(CfnHttpApi.RouteSettingsProperty defaultRouteSettings)
CfnHttpApi.Builder	definitionBody(Object definitionBody)
CfnHttpApi.Builder	definitionUri(String definitionUri)
CfnHttpApi.Builder	definitionUri(IResolvable definitionUri)
CfnHttpApi.Builder	definitionUri(CfnHttpApi.S3LocationProperty definitionUri)
CfnHttpApi.Builder	description(String description)
CfnHttpApi.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
CfnHttpApi.Builder	disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
CfnHttpApi.Builder	domain(IResolvable domain)
CfnHttpApi.Builder	domain(CfnHttpApi.HttpApiDomainConfigurationProperty domain)
CfnHttpApi.Builder	failOnWarnings(Boolean failOnWarnings)
CfnHttpApi.Builder	failOnWarnings(IResolvable failOnWarnings)
CfnHttpApi.Builder	routeSettings(IResolvable routeSettings)
CfnHttpApi.Builder	routeSettings(CfnHttpApi.RouteSettingsProperty routeSettings)
CfnHttpApi.Builder	stageName(String stageName)
CfnHttpApi.Builder	stageVariables(Map<String,String> stageVariables)
CfnHttpApi.Builder	stageVariables(IResolvable stageVariables)
CfnHttpApi.Builder	tags(Map<String,String> tags)

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnHttpApi.Builder.

accessLogSetting

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

Parameters:

accessLogSetting - This parameter is required.

Returns:

this

See Also:

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

accessLogSetting

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

Parameters:

accessLogSetting - This parameter is required.

Returns:

this

See Also:

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

auth

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

Parameters:

auth - This parameter is required.

Returns:

this

See Also:

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

auth

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

Parameters:

auth - This parameter is required.

Returns:

this

See Also:

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

corsConfiguration

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

Parameters:

corsConfiguration - This parameter is required.

Returns:

this

See Also:

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

corsConfiguration

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

Parameters:

corsConfiguration - This parameter is required.

Returns:

this

See Also:

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

corsConfiguration

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

Parameters:

corsConfiguration - This parameter is required.

Returns:

this

See Also:

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

defaultRouteSettings

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

Parameters:

defaultRouteSettings - This parameter is required.

Returns:

this

See Also:

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

defaultRouteSettings

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

Parameters:

defaultRouteSettings - This parameter is required.

Returns:

this

See Also:

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

definitionBody

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

Parameters:

definitionBody - This parameter is required.

Returns:

this

See Also:

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

definitionUri

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

Parameters:

definitionUri - This parameter is required.

Returns:

this

See Also:

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

definitionUri

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

Parameters:

definitionUri - This parameter is required.

Returns:

this

See Also:

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

definitionUri

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

Parameters:

definitionUri - This parameter is required.

Returns:

this

See Also:

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

description

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

Parameters:

description - This parameter is required.

Returns:

this

See Also:

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

disableExecuteApiEndpoint

@Stability(Stable)
public CfnHttpApi.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)

Parameters:

disableExecuteApiEndpoint - This parameter is required.

Returns:

this

See Also:

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

disableExecuteApiEndpoint

@Stability(Stable)
public CfnHttpApi.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)

Parameters:

disableExecuteApiEndpoint - This parameter is required.

Returns:

this

See Also:

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

domain

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

Parameters:

domain - This parameter is required.

Returns:

this

See Also:

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

domain

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

Parameters:

domain - This parameter is required.

Returns:

this

See Also:

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

failOnWarnings

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

Parameters:

failOnWarnings - This parameter is required.

Returns:

this

See Also:

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

failOnWarnings

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

Parameters:

failOnWarnings - This parameter is required.

Returns:

this

See Also:

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

routeSettings

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

Parameters:

routeSettings - This parameter is required.

Returns:

this

See Also:

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

routeSettings

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

Parameters:

routeSettings - This parameter is required.

Returns:

this

See Also:

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

stageName

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

Parameters:

stageName - This parameter is required.

Returns:

this

See Also:

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

stageVariables

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

Parameters:

stageVariables - This parameter is required.

Returns:

this

See Also:

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

stageVariables

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

Parameters:

stageVariables - This parameter is required.

Returns:

this

See Also:

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

tags

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

Parameters:

tags - This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnHttpApi build()

Specified by:

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

Returns:

a newly built instance of CfnHttpApi.