software.amazon.awscdk.services.sam

Class CfnApiProps.Builder

java.lang.Object

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

Enclosing interface:

CfnApiProps

@Stability(value=External)
public static final class CfnApiProps.Builder
extends Object

A builder for CfnApiProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnApiProps.Builder	accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting) Sets the value of AccessLogSetting
CfnApiProps.Builder	accessLogSetting(software.amazon.awscdk.core.IResolvable accessLogSetting) Sets the value of AccessLogSetting
CfnApiProps.Builder	auth(CfnApi.AuthProperty auth) Sets the value of Auth
CfnApiProps.Builder	auth(software.amazon.awscdk.core.IResolvable auth) Sets the value of Auth
CfnApiProps.Builder	binaryMediaTypes(List<String> binaryMediaTypes) Sets the value of BinaryMediaTypes
CfnApiProps	build() Builds the configured instance.
CfnApiProps.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled) Sets the value of CacheClusterEnabled
CfnApiProps.Builder	cacheClusterEnabled(software.amazon.awscdk.core.IResolvable cacheClusterEnabled) Sets the value of CacheClusterEnabled
CfnApiProps.Builder	cacheClusterSize(String cacheClusterSize) Sets the value of CacheClusterSize
CfnApiProps.Builder	cors(String cors) Sets the value of Cors
CfnApiProps.Builder	definitionBody(Object definitionBody) Sets the value of DefinitionBody
CfnApiProps.Builder	definitionUri(CfnApi.S3LocationProperty definitionUri) Sets the value of DefinitionUri
CfnApiProps.Builder	definitionUri(software.amazon.awscdk.core.IResolvable definitionUri) Sets the value of DefinitionUri
CfnApiProps.Builder	definitionUri(String definitionUri) Sets the value of DefinitionUri
CfnApiProps.Builder	endpointConfiguration(String endpointConfiguration) Sets the value of EndpointConfiguration
CfnApiProps.Builder	methodSettings(Object methodSettings) Sets the value of MethodSettings
CfnApiProps.Builder	name(String name) Sets the value of Name
CfnApiProps.Builder	stageName(String stageName) Sets the value of StageName
CfnApiProps.Builder	tracingEnabled(Boolean tracingEnabled) Sets the value of TracingEnabled
CfnApiProps.Builder	tracingEnabled(software.amazon.awscdk.core.IResolvable tracingEnabled) Sets the value of TracingEnabled
CfnApiProps.Builder	variables(software.amazon.awscdk.core.IResolvable variables) Sets the value of Variables
CfnApiProps.Builder	variables(Map<String,String> variables) Sets the value of Variables

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

stageName

@Stability(value=External)
public CfnApiProps.Builder stageName(String stageName)

Sets the value of StageName

Parameters:

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

Returns:

this

accessLogSetting

@Stability(value=External)
public CfnApiProps.Builder accessLogSetting(software.amazon.awscdk.core.IResolvable accessLogSetting)

Sets the value of AccessLogSetting

Parameters:

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

Returns:

this

accessLogSetting

@Stability(value=External)
public CfnApiProps.Builder accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting)

Sets the value of AccessLogSetting

Parameters:

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

Returns:

this

auth

@Stability(value=External)
public CfnApiProps.Builder auth(software.amazon.awscdk.core.IResolvable auth)

Sets the value of Auth

Parameters:

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

Returns:

this

auth

@Stability(value=External)
public CfnApiProps.Builder auth(CfnApi.AuthProperty auth)

Sets the value of Auth

Parameters:

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

Returns:

this

binaryMediaTypes

@Stability(value=External)
public CfnApiProps.Builder binaryMediaTypes(List<String> binaryMediaTypes)

Sets the value of BinaryMediaTypes

Parameters:

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

Returns:

this

cacheClusterEnabled

@Stability(value=External)
public CfnApiProps.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

Sets the value of CacheClusterEnabled

Parameters:

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

Returns:

this

cacheClusterEnabled

@Stability(value=External)
public CfnApiProps.Builder cacheClusterEnabled(software.amazon.awscdk.core.IResolvable cacheClusterEnabled)

Sets the value of CacheClusterEnabled

Parameters:

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

Returns:

this

cacheClusterSize

@Stability(value=External)
public CfnApiProps.Builder cacheClusterSize(String cacheClusterSize)

Sets the value of CacheClusterSize

Parameters:

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

Returns:

this

cors

@Stability(value=External)
public CfnApiProps.Builder cors(String cors)

Sets the value of Cors

Parameters:

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

Returns:

this

definitionBody

@Stability(value=External)
public CfnApiProps.Builder definitionBody(Object definitionBody)

Sets the value of DefinitionBody

Parameters:

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

Returns:

this

definitionUri

@Stability(value=External)
public CfnApiProps.Builder definitionUri(String definitionUri)

Sets the value of DefinitionUri

Parameters:

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

Returns:

this

definitionUri

@Stability(value=External)
public CfnApiProps.Builder definitionUri(software.amazon.awscdk.core.IResolvable definitionUri)

Sets the value of DefinitionUri

Parameters:

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

Returns:

this

definitionUri

@Stability(value=External)
public CfnApiProps.Builder definitionUri(CfnApi.S3LocationProperty definitionUri)

Sets the value of DefinitionUri

Parameters:

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

Returns:

this

endpointConfiguration

@Stability(value=External)
public CfnApiProps.Builder endpointConfiguration(String endpointConfiguration)

Sets the value of EndpointConfiguration

Parameters:

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

Returns:

this

methodSettings

@Stability(value=External)
public CfnApiProps.Builder methodSettings(Object methodSettings)

Sets the value of MethodSettings

Parameters:

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

Returns:

this

name

@Stability(value=External)
public CfnApiProps.Builder name(String name)

Sets the value of Name

Parameters:

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

Returns:

this

tracingEnabled

@Stability(value=External)
public CfnApiProps.Builder tracingEnabled(Boolean tracingEnabled)

Sets the value of TracingEnabled

Parameters:

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

Returns:

this

tracingEnabled

@Stability(value=External)
public CfnApiProps.Builder tracingEnabled(software.amazon.awscdk.core.IResolvable tracingEnabled)

Sets the value of TracingEnabled

Parameters:

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

Returns:

this

variables

@Stability(value=External)
public CfnApiProps.Builder variables(software.amazon.awscdk.core.IResolvable variables)

Sets the value of Variables

Parameters:

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

Returns:

this

variables

@Stability(value=External)
public CfnApiProps.Builder variables(Map<String,String> variables)

Sets the value of Variables

Parameters:

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

Returns:

this

build

@Stability(value=External)
public CfnApiProps build()

Builds the configured instance.

Returns:

a new instance of CfnApiProps

Throws:

NullPointerException - if any required attribute was not provided