Package software.amazon.awscdk.services.sam

Class CfnApiProps.Builder

java.lang.Object

software.amazon.awscdk.services.sam.CfnApiProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApiProps>

Enclosing interface:

CfnApiProps

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

A builder for CfnApiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnApiProps.Builder	accessLogSetting(software.amazon.awscdk.core.IResolvable accessLogSetting)	Sets the value of CfnApiProps.getAccessLogSetting()
CfnApiProps.Builder	accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting)	Sets the value of CfnApiProps.getAccessLogSetting()
CfnApiProps.Builder	auth(software.amazon.awscdk.core.IResolvable auth)	Sets the value of CfnApiProps.getAuth()
CfnApiProps.Builder	auth(CfnApi.AuthProperty auth)	Sets the value of CfnApiProps.getAuth()
CfnApiProps.Builder	binaryMediaTypes(List<String> binaryMediaTypes)	Sets the value of CfnApiProps.getBinaryMediaTypes()
CfnApiProps	build()	Builds the configured instance.
CfnApiProps.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled)	Sets the value of CfnApiProps.getCacheClusterEnabled()
CfnApiProps.Builder	cacheClusterEnabled(software.amazon.awscdk.core.IResolvable cacheClusterEnabled)	Sets the value of CfnApiProps.getCacheClusterEnabled()
CfnApiProps.Builder	cacheClusterSize(String cacheClusterSize)	Sets the value of CfnApiProps.getCacheClusterSize()
CfnApiProps.Builder	canarySetting(software.amazon.awscdk.core.IResolvable canarySetting)	Sets the value of CfnApiProps.getCanarySetting()
CfnApiProps.Builder	canarySetting(CfnApi.CanarySettingProperty canarySetting)	Sets the value of CfnApiProps.getCanarySetting()
CfnApiProps.Builder	cors(String cors)	Sets the value of CfnApiProps.getCors()
CfnApiProps.Builder	cors(software.amazon.awscdk.core.IResolvable cors)	Sets the value of CfnApiProps.getCors()
CfnApiProps.Builder	cors(CfnApi.CorsConfigurationProperty cors)	Sets the value of CfnApiProps.getCors()
CfnApiProps.Builder	definitionBody(Object definitionBody)	Sets the value of CfnApiProps.getDefinitionBody()
CfnApiProps.Builder	definitionUri(String definitionUri)	Sets the value of CfnApiProps.getDefinitionUri()
CfnApiProps.Builder	definitionUri(software.amazon.awscdk.core.IResolvable definitionUri)	Sets the value of CfnApiProps.getDefinitionUri()
CfnApiProps.Builder	definitionUri(CfnApi.S3LocationProperty definitionUri)	Sets the value of CfnApiProps.getDefinitionUri()
CfnApiProps.Builder	description(String description)	Sets the value of CfnApiProps.getDescription()
CfnApiProps.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)	Sets the value of CfnApiProps.getDisableExecuteApiEndpoint()
CfnApiProps.Builder	disableExecuteApiEndpoint(software.amazon.awscdk.core.IResolvable disableExecuteApiEndpoint)	Sets the value of CfnApiProps.getDisableExecuteApiEndpoint()
CfnApiProps.Builder	domain(software.amazon.awscdk.core.IResolvable domain)	Sets the value of CfnApiProps.getDomain()
CfnApiProps.Builder	domain(CfnApi.DomainConfigurationProperty domain)	Sets the value of CfnApiProps.getDomain()
CfnApiProps.Builder	endpointConfiguration(String endpointConfiguration)	Sets the value of CfnApiProps.getEndpointConfiguration()
CfnApiProps.Builder	endpointConfiguration(software.amazon.awscdk.core.IResolvable endpointConfiguration)	Sets the value of CfnApiProps.getEndpointConfiguration()
CfnApiProps.Builder	endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration)	Sets the value of CfnApiProps.getEndpointConfiguration()
CfnApiProps.Builder	gatewayResponses(Object gatewayResponses)	Sets the value of CfnApiProps.getGatewayResponses()
CfnApiProps.Builder	methodSettings(List<? extends Object> methodSettings)	Sets the value of CfnApiProps.getMethodSettings()
CfnApiProps.Builder	methodSettings(software.amazon.awscdk.core.IResolvable methodSettings)	Sets the value of CfnApiProps.getMethodSettings()
CfnApiProps.Builder	minimumCompressionSize(Number minimumCompressionSize)	Sets the value of CfnApiProps.getMinimumCompressionSize()
CfnApiProps.Builder	models(Object models)	Sets the value of CfnApiProps.getModels()
CfnApiProps.Builder	name(String name)	Sets the value of CfnApiProps.getName()
CfnApiProps.Builder	openApiVersion(String openApiVersion)	Sets the value of CfnApiProps.getOpenApiVersion()
CfnApiProps.Builder	stageName(String stageName)	Sets the value of CfnApiProps.getStageName()
CfnApiProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnApiProps.getTags()
CfnApiProps.Builder	tracingEnabled(Boolean tracingEnabled)	Sets the value of CfnApiProps.getTracingEnabled()
CfnApiProps.Builder	tracingEnabled(software.amazon.awscdk.core.IResolvable tracingEnabled)	Sets the value of CfnApiProps.getTracingEnabled()
CfnApiProps.Builder	variables(Map<String,String> variables)	Sets the value of CfnApiProps.getVariables()
CfnApiProps.Builder	variables(software.amazon.awscdk.core.IResolvable variables)	Sets the value of CfnApiProps.getVariables()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

stageName

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

Sets the value of CfnApiProps.getStageName()

Parameters:

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

Returns:

this

accessLogSetting

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

Sets the value of CfnApiProps.getAccessLogSetting()

Parameters:

accessLogSetting - `AWS::Serverless::Api.AccessLogSetting`.

Returns:

this

accessLogSetting

@Stability(Stable)
public CfnApiProps.Builder accessLogSetting(software.amazon.awscdk.core.IResolvable accessLogSetting)

Sets the value of CfnApiProps.getAccessLogSetting()

Parameters:

accessLogSetting - `AWS::Serverless::Api.AccessLogSetting`.

Returns:

this

auth

@Stability(Stable)
public CfnApiProps.Builder auth(software.amazon.awscdk.core.IResolvable auth)

Sets the value of CfnApiProps.getAuth()

Parameters:

auth - `AWS::Serverless::Api.Auth`.

Returns:

this

auth

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

Sets the value of CfnApiProps.getAuth()

Parameters:

auth - `AWS::Serverless::Api.Auth`.

Returns:

this

binaryMediaTypes

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

Sets the value of CfnApiProps.getBinaryMediaTypes()

Parameters:

binaryMediaTypes - `AWS::Serverless::Api.BinaryMediaTypes`.

Returns:

this

cacheClusterEnabled

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

Sets the value of CfnApiProps.getCacheClusterEnabled()

Parameters:

cacheClusterEnabled - `AWS::Serverless::Api.CacheClusterEnabled`.

Returns:

this

cacheClusterEnabled

@Stability(Stable)
public CfnApiProps.Builder cacheClusterEnabled(software.amazon.awscdk.core.IResolvable cacheClusterEnabled)

Sets the value of CfnApiProps.getCacheClusterEnabled()

Parameters:

cacheClusterEnabled - `AWS::Serverless::Api.CacheClusterEnabled`.

Returns:

this

cacheClusterSize

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

Sets the value of CfnApiProps.getCacheClusterSize()

Parameters:

cacheClusterSize - `AWS::Serverless::Api.CacheClusterSize`.

Returns:

this

canarySetting

@Stability(Stable)
public CfnApiProps.Builder canarySetting(software.amazon.awscdk.core.IResolvable canarySetting)

Sets the value of CfnApiProps.getCanarySetting()

Parameters:

canarySetting - `AWS::Serverless::Api.CanarySetting`.

Returns:

this

canarySetting

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

Sets the value of CfnApiProps.getCanarySetting()

Parameters:

canarySetting - `AWS::Serverless::Api.CanarySetting`.

Returns:

this

cors

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

Sets the value of CfnApiProps.getCors()

Parameters:

cors - `AWS::Serverless::Api.Cors`.

Returns:

this

cors

@Stability(Stable)
public CfnApiProps.Builder cors(software.amazon.awscdk.core.IResolvable cors)

Sets the value of CfnApiProps.getCors()

Parameters:

cors - `AWS::Serverless::Api.Cors`.

Returns:

this

cors

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

Sets the value of CfnApiProps.getCors()

Parameters:

cors - `AWS::Serverless::Api.Cors`.

Returns:

this

definitionBody

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

Sets the value of CfnApiProps.getDefinitionBody()

Parameters:

definitionBody - `AWS::Serverless::Api.DefinitionBody`.

Returns:

this

definitionUri

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

Sets the value of CfnApiProps.getDefinitionUri()

Parameters:

definitionUri - `AWS::Serverless::Api.DefinitionUri`.

Returns:

this

definitionUri

@Stability(Stable)
public CfnApiProps.Builder definitionUri(software.amazon.awscdk.core.IResolvable definitionUri)

Sets the value of CfnApiProps.getDefinitionUri()

Parameters:

definitionUri - `AWS::Serverless::Api.DefinitionUri`.

Returns:

this

definitionUri

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

Sets the value of CfnApiProps.getDefinitionUri()

Parameters:

definitionUri - `AWS::Serverless::Api.DefinitionUri`.

Returns:

this

description

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

Sets the value of CfnApiProps.getDescription()

Parameters:

description - `AWS::Serverless::Api.Description`.

Returns:

this

disableExecuteApiEndpoint

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

Sets the value of CfnApiProps.getDisableExecuteApiEndpoint()

Parameters:

disableExecuteApiEndpoint - `AWS::Serverless::Api.DisableExecuteApiEndpoint`.

Returns:

this

disableExecuteApiEndpoint

@Stability(Stable)
public CfnApiProps.Builder disableExecuteApiEndpoint(software.amazon.awscdk.core.IResolvable disableExecuteApiEndpoint)

Sets the value of CfnApiProps.getDisableExecuteApiEndpoint()

Parameters:

disableExecuteApiEndpoint - `AWS::Serverless::Api.DisableExecuteApiEndpoint`.

Returns:

this

domain

@Stability(Stable)
public CfnApiProps.Builder domain(software.amazon.awscdk.core.IResolvable domain)

Sets the value of CfnApiProps.getDomain()

Parameters:

domain - `AWS::Serverless::Api.Domain`.

Returns:

this

domain

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

Sets the value of CfnApiProps.getDomain()

Parameters:

domain - `AWS::Serverless::Api.Domain`.

Returns:

this

endpointConfiguration

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

Sets the value of CfnApiProps.getEndpointConfiguration()

Parameters:

endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`.

Returns:

this

endpointConfiguration

@Stability(Stable)
public CfnApiProps.Builder endpointConfiguration(software.amazon.awscdk.core.IResolvable endpointConfiguration)

Sets the value of CfnApiProps.getEndpointConfiguration()

Parameters:

endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`.

Returns:

this

endpointConfiguration

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

Sets the value of CfnApiProps.getEndpointConfiguration()

Parameters:

endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`.

Returns:

this

gatewayResponses

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

Sets the value of CfnApiProps.getGatewayResponses()

Parameters:

gatewayResponses - `AWS::Serverless::Api.GatewayResponses`.

Returns:

this

methodSettings

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

Sets the value of CfnApiProps.getMethodSettings()

Parameters:

methodSettings - `AWS::Serverless::Api.MethodSettings`.

Returns:

this

methodSettings

@Stability(Stable)
public CfnApiProps.Builder methodSettings(software.amazon.awscdk.core.IResolvable methodSettings)

Sets the value of CfnApiProps.getMethodSettings()

Parameters:

methodSettings - `AWS::Serverless::Api.MethodSettings`.

Returns:

this

minimumCompressionSize

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

Sets the value of CfnApiProps.getMinimumCompressionSize()

Parameters:

minimumCompressionSize - `AWS::Serverless::Api.MinimumCompressionSize`.

Returns:

this

models

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

Sets the value of CfnApiProps.getModels()

Parameters:

models - `AWS::Serverless::Api.Models`.

Returns:

this

name

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

Sets the value of CfnApiProps.getName()

Parameters:

name - `AWS::Serverless::Api.Name`.

Returns:

this

openApiVersion

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

Sets the value of CfnApiProps.getOpenApiVersion()

Parameters:

openApiVersion - `AWS::Serverless::Api.OpenApiVersion`.

Returns:

this

tags

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

Sets the value of CfnApiProps.getTags()

Parameters:

tags - `AWS::Serverless::Api.Tags`.

Returns:

this

tracingEnabled

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

Sets the value of CfnApiProps.getTracingEnabled()

Parameters:

tracingEnabled - `AWS::Serverless::Api.TracingEnabled`.

Returns:

this

tracingEnabled

@Stability(Stable)
public CfnApiProps.Builder tracingEnabled(software.amazon.awscdk.core.IResolvable tracingEnabled)

Sets the value of CfnApiProps.getTracingEnabled()

Parameters:

tracingEnabled - `AWS::Serverless::Api.TracingEnabled`.

Returns:

this

variables

@Stability(Stable)
public CfnApiProps.Builder variables(software.amazon.awscdk.core.IResolvable variables)

Sets the value of CfnApiProps.getVariables()

Parameters:

variables - `AWS::Serverless::Api.Variables`.

Returns:

this

variables

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

Sets the value of CfnApiProps.getVariables()

Parameters:

variables - `AWS::Serverless::Api.Variables`.

Returns:

this

build

@Stability(Stable)
public CfnApiProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnApiProps

Throws:

NullPointerException - if any required attribute was not provided