Package software.amazon.awscdk.services.sam

Class CfnApi.Builder

java.lang.Object

software.amazon.awscdk.services.sam.CfnApi.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApi>

Enclosing class:

CfnApi

@Stability(Stable)
public static final class CfnApi.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApi>

A fluent builder for CfnApi.

Method Summary

Modifier and Type	Method	Description
CfnApi.Builder	accessLogSetting(IResolvable accessLogSetting)
CfnApi.Builder	accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting)
CfnApi.Builder	alwaysDeploy(Boolean alwaysDeploy)
CfnApi.Builder	alwaysDeploy(IResolvable alwaysDeploy)
CfnApi.Builder	auth(IResolvable auth)
CfnApi.Builder	auth(CfnApi.AuthProperty auth)
CfnApi.Builder	binaryMediaTypes(List<String> binaryMediaTypes)
CfnApi	build()
CfnApi.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled)
CfnApi.Builder	cacheClusterEnabled(IResolvable cacheClusterEnabled)
CfnApi.Builder	cacheClusterSize(String cacheClusterSize)
CfnApi.Builder	canarySetting(IResolvable canarySetting)
CfnApi.Builder	canarySetting(CfnApi.CanarySettingProperty canarySetting)
CfnApi.Builder	cors(String cors)
CfnApi.Builder	cors(IResolvable cors)
CfnApi.Builder	cors(CfnApi.CorsConfigurationProperty cors)
static CfnApi.Builder	create(software.constructs.Construct scope, String id)
CfnApi.Builder	definitionBody(Object definitionBody)
CfnApi.Builder	definitionUri(String definitionUri)
CfnApi.Builder	definitionUri(IResolvable definitionUri)
CfnApi.Builder	definitionUri(CfnApi.S3LocationProperty definitionUri)
CfnApi.Builder	description(String description)
CfnApi.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
CfnApi.Builder	disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
CfnApi.Builder	domain(IResolvable domain)
CfnApi.Builder	domain(CfnApi.DomainConfigurationProperty domain)
CfnApi.Builder	endpointConfiguration(String endpointConfiguration)
CfnApi.Builder	endpointConfiguration(IResolvable endpointConfiguration)
CfnApi.Builder	endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration)
CfnApi.Builder	gatewayResponses(Object gatewayResponses)
CfnApi.Builder	methodSettings(List<? extends Object> methodSettings)
CfnApi.Builder	methodSettings(IResolvable methodSettings)
CfnApi.Builder	minimumCompressionSize(Number minimumCompressionSize)
CfnApi.Builder	models(Object models)
CfnApi.Builder	name(String name)
CfnApi.Builder	openApiVersion(String openApiVersion)
CfnApi.Builder	stageName(String stageName)
CfnApi.Builder	tags(Map<String,String> tags)
CfnApi.Builder	tracingEnabled(Boolean tracingEnabled)
CfnApi.Builder	tracingEnabled(IResolvable tracingEnabled)
CfnApi.Builder	variables(Map<String,String> variables)
CfnApi.Builder	variables(IResolvable variables)

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 CfnApi.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 CfnApi.Builder.

stageName

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-stagename

accessLogSetting

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-accesslogsetting

accessLogSetting

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

Parameters:

accessLogSetting - This parameter is required.

Returns:

this

See Also:

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

alwaysDeploy

@Stability(Stable)
public CfnApi.Builder alwaysDeploy(Boolean alwaysDeploy)

Parameters:

alwaysDeploy - This parameter is required.

Returns:

this

See Also:

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

alwaysDeploy

@Stability(Stable)
public CfnApi.Builder alwaysDeploy(IResolvable alwaysDeploy)

Parameters:

alwaysDeploy - This parameter is required.

Returns:

this

See Also:

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

auth

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-auth

auth

@Stability(Stable)
public CfnApi.Builder auth(CfnApi.AuthProperty auth)

Parameters:

auth - This parameter is required.

Returns:

this

See Also:

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

binaryMediaTypes

@Stability(Stable)
public CfnApi.Builder binaryMediaTypes(List<String> binaryMediaTypes)

Parameters:

binaryMediaTypes - This parameter is required.

Returns:

this

See Also:

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

cacheClusterEnabled

@Stability(Stable)
public CfnApi.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

Parameters:

cacheClusterEnabled - This parameter is required.

Returns:

this

See Also:

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

cacheClusterEnabled

@Stability(Stable)
public CfnApi.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled)

Parameters:

cacheClusterEnabled - This parameter is required.

Returns:

this

See Also:

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

cacheClusterSize

@Stability(Stable)
public CfnApi.Builder cacheClusterSize(String cacheClusterSize)

Parameters:

cacheClusterSize - This parameter is required.

Returns:

this

See Also:

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

canarySetting

@Stability(Stable)
public CfnApi.Builder canarySetting(IResolvable canarySetting)

Parameters:

canarySetting - This parameter is required.

Returns:

this

See Also:

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

canarySetting

@Stability(Stable)
public CfnApi.Builder canarySetting(CfnApi.CanarySettingProperty canarySetting)

Parameters:

canarySetting - This parameter is required.

Returns:

this

See Also:

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

cors

@Stability(Stable)
public CfnApi.Builder cors(String cors)

Parameters:

cors - This parameter is required.

Returns:

this

See Also:

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

cors

@Stability(Stable)
public CfnApi.Builder cors(IResolvable cors)

Parameters:

cors - This parameter is required.

Returns:

this

See Also:

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

cors

@Stability(Stable)
public CfnApi.Builder cors(CfnApi.CorsConfigurationProperty cors)

Parameters:

cors - This parameter is required.

Returns:

this

See Also:

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

definitionBody

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-definitionbody

definitionUri

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-definitionuri

definitionUri

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-definitionuri

definitionUri

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

Parameters:

definitionUri - This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-description

disableExecuteApiEndpoint

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-disableexecuteapiendpoint

disableExecuteApiEndpoint

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-disableexecuteapiendpoint

domain

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-domain

domain

@Stability(Stable)
public CfnApi.Builder domain(CfnApi.DomainConfigurationProperty domain)

Parameters:

domain - This parameter is required.

Returns:

this

See Also:

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

endpointConfiguration

@Stability(Stable)
public CfnApi.Builder endpointConfiguration(String endpointConfiguration)

Parameters:

endpointConfiguration - This parameter is required.

Returns:

this

See Also:

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

endpointConfiguration

@Stability(Stable)
public CfnApi.Builder endpointConfiguration(IResolvable endpointConfiguration)

Parameters:

endpointConfiguration - This parameter is required.

Returns:

this

See Also:

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

endpointConfiguration

@Stability(Stable)
public CfnApi.Builder endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration)

Parameters:

endpointConfiguration - This parameter is required.

Returns:

this

See Also:

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

gatewayResponses

@Stability(Stable)
public CfnApi.Builder gatewayResponses(Object gatewayResponses)

Parameters:

gatewayResponses - This parameter is required.

Returns:

this

See Also:

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

methodSettings

@Stability(Stable)
public CfnApi.Builder methodSettings(List<? extends Object> methodSettings)

Parameters:

methodSettings - This parameter is required.

Returns:

this

See Also:

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

methodSettings

@Stability(Stable)
public CfnApi.Builder methodSettings(IResolvable methodSettings)

Parameters:

methodSettings - This parameter is required.

Returns:

this

See Also:

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

minimumCompressionSize

@Stability(Stable)
public CfnApi.Builder minimumCompressionSize(Number minimumCompressionSize)

Parameters:

minimumCompressionSize - This parameter is required.

Returns:

this

See Also:

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

models

@Stability(Stable)
public CfnApi.Builder models(Object models)

Parameters:

models - This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnApi.Builder name(String name)

Parameters:

name - This parameter is required.

Returns:

this

See Also:

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

openApiVersion

@Stability(Stable)
public CfnApi.Builder openApiVersion(String openApiVersion)

Parameters:

openApiVersion - This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnApi.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-api.html#cfn-serverless-api-tags

tracingEnabled

@Stability(Stable)
public CfnApi.Builder tracingEnabled(Boolean tracingEnabled)

Parameters:

tracingEnabled - This parameter is required.

Returns:

this

See Also:

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

tracingEnabled

@Stability(Stable)
public CfnApi.Builder tracingEnabled(IResolvable tracingEnabled)

Parameters:

tracingEnabled - This parameter is required.

Returns:

this

See Also:

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

variables

@Stability(Stable)
public CfnApi.Builder variables(IResolvable variables)

Parameters:

variables - This parameter is required.

Returns:

this

See Also:

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

variables

@Stability(Stable)
public CfnApi.Builder variables(Map<String,String> variables)

Parameters:

variables - This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnApi build()

Specified by:

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

Returns:

a newly built instance of CfnApi.