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(value=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 and Description
CfnApi.Builder	accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting) `AWS::Serverless::Api.AccessLogSetting`.
CfnApi.Builder	accessLogSetting(IResolvable accessLogSetting) `AWS::Serverless::Api.AccessLogSetting`.
CfnApi.Builder	auth(CfnApi.AuthProperty auth) `AWS::Serverless::Api.Auth`.
CfnApi.Builder	auth(IResolvable auth) `AWS::Serverless::Api.Auth`.
CfnApi.Builder	binaryMediaTypes(List<String> binaryMediaTypes) `AWS::Serverless::Api.BinaryMediaTypes`.
CfnApi	build()
CfnApi.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled) `AWS::Serverless::Api.CacheClusterEnabled`.
CfnApi.Builder	cacheClusterEnabled(IResolvable cacheClusterEnabled) `AWS::Serverless::Api.CacheClusterEnabled`.
CfnApi.Builder	cacheClusterSize(String cacheClusterSize) `AWS::Serverless::Api.CacheClusterSize`.
CfnApi.Builder	canarySetting(CfnApi.CanarySettingProperty canarySetting) `AWS::Serverless::Api.CanarySetting`.
CfnApi.Builder	canarySetting(IResolvable canarySetting) `AWS::Serverless::Api.CanarySetting`.
CfnApi.Builder	cors(CfnApi.CorsConfigurationProperty cors) `AWS::Serverless::Api.Cors`.
CfnApi.Builder	cors(IResolvable cors) `AWS::Serverless::Api.Cors`.
CfnApi.Builder	cors(String cors) `AWS::Serverless::Api.Cors`.
static CfnApi.Builder	create(software.constructs.Construct scope, String id)
CfnApi.Builder	definitionBody(Object definitionBody) `AWS::Serverless::Api.DefinitionBody`.
CfnApi.Builder	definitionUri(CfnApi.S3LocationProperty definitionUri) `AWS::Serverless::Api.DefinitionUri`.
CfnApi.Builder	definitionUri(IResolvable definitionUri) `AWS::Serverless::Api.DefinitionUri`.
CfnApi.Builder	definitionUri(String definitionUri) `AWS::Serverless::Api.DefinitionUri`.
CfnApi.Builder	description(String description) `AWS::Serverless::Api.Description`.
CfnApi.Builder	domain(CfnApi.DomainConfigurationProperty domain) `AWS::Serverless::Api.Domain`.
CfnApi.Builder	domain(IResolvable domain) `AWS::Serverless::Api.Domain`.
CfnApi.Builder	endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration) `AWS::Serverless::Api.EndpointConfiguration`.
CfnApi.Builder	endpointConfiguration(IResolvable endpointConfiguration) `AWS::Serverless::Api.EndpointConfiguration`.
CfnApi.Builder	endpointConfiguration(String endpointConfiguration) `AWS::Serverless::Api.EndpointConfiguration`.
CfnApi.Builder	gatewayResponses(Object gatewayResponses) `AWS::Serverless::Api.GatewayResponses`.
CfnApi.Builder	methodSettings(IResolvable methodSettings) `AWS::Serverless::Api.MethodSettings`.
CfnApi.Builder	methodSettings(List<? extends Object> methodSettings) `AWS::Serverless::Api.MethodSettings`.
CfnApi.Builder	minimumCompressionSize(Number minimumCompressionSize) `AWS::Serverless::Api.MinimumCompressionSize`.
CfnApi.Builder	models(Object models) `AWS::Serverless::Api.Models`.
CfnApi.Builder	name(String name) `AWS::Serverless::Api.Name`.
CfnApi.Builder	openApiVersion(String openApiVersion) `AWS::Serverless::Api.OpenApiVersion`.
CfnApi.Builder	stageName(String stageName) `AWS::Serverless::Api.StageName`.
CfnApi.Builder	tags(Map<String,String> tags) `AWS::Serverless::Api.Tags`.
CfnApi.Builder	tracingEnabled(Boolean tracingEnabled) `AWS::Serverless::Api.TracingEnabled`.
CfnApi.Builder	tracingEnabled(IResolvable tracingEnabled) `AWS::Serverless::Api.TracingEnabled`.
CfnApi.Builder	variables(IResolvable variables) `AWS::Serverless::Api.Variables`.
CfnApi.Builder	variables(Map<String,String> variables) `AWS::Serverless::Api.Variables`.

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

stageName

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

`AWS::Serverless::Api.StageName`.

Parameters:

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

Returns:

this

accessLogSetting

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

`AWS::Serverless::Api.AccessLogSetting`.

Parameters:

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

Returns:

this

accessLogSetting

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

`AWS::Serverless::Api.AccessLogSetting`.

Parameters:

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

Returns:

this

auth

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

`AWS::Serverless::Api.Auth`.

Parameters:

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

Returns:

this

auth

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

`AWS::Serverless::Api.Auth`.

Parameters:

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

Returns:

this

binaryMediaTypes

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

`AWS::Serverless::Api.BinaryMediaTypes`.

Parameters:

binaryMediaTypes - `AWS::Serverless::Api.BinaryMediaTypes`. This parameter is required.

Returns:

this

cacheClusterEnabled

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

`AWS::Serverless::Api.CacheClusterEnabled`.

Parameters:

cacheClusterEnabled - `AWS::Serverless::Api.CacheClusterEnabled`. This parameter is required.

Returns:

this

cacheClusterEnabled

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

`AWS::Serverless::Api.CacheClusterEnabled`.

Parameters:

cacheClusterEnabled - `AWS::Serverless::Api.CacheClusterEnabled`. This parameter is required.

Returns:

this

cacheClusterSize

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

`AWS::Serverless::Api.CacheClusterSize`.

Parameters:

cacheClusterSize - `AWS::Serverless::Api.CacheClusterSize`. This parameter is required.

Returns:

this

canarySetting

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

`AWS::Serverless::Api.CanarySetting`.

Parameters:

canarySetting - `AWS::Serverless::Api.CanarySetting`. This parameter is required.

Returns:

this

canarySetting

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

`AWS::Serverless::Api.CanarySetting`.

Parameters:

canarySetting - `AWS::Serverless::Api.CanarySetting`. This parameter is required.

Returns:

this

cors

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

`AWS::Serverless::Api.Cors`.

Parameters:

cors - `AWS::Serverless::Api.Cors`. This parameter is required.

Returns:

this

cors

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

`AWS::Serverless::Api.Cors`.

Parameters:

cors - `AWS::Serverless::Api.Cors`. This parameter is required.

Returns:

this

cors

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

`AWS::Serverless::Api.Cors`.

Parameters:

cors - `AWS::Serverless::Api.Cors`. This parameter is required.

Returns:

this

definitionBody

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

`AWS::Serverless::Api.DefinitionBody`.

Parameters:

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

Returns:

this

definitionUri

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

`AWS::Serverless::Api.DefinitionUri`.

Parameters:

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

Returns:

this

definitionUri

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

`AWS::Serverless::Api.DefinitionUri`.

Parameters:

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

Returns:

this

definitionUri

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

`AWS::Serverless::Api.DefinitionUri`.

Parameters:

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

Returns:

this

description

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

`AWS::Serverless::Api.Description`.

Parameters:

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

Returns:

this

domain

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

`AWS::Serverless::Api.Domain`.

Parameters:

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

Returns:

this

domain

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

`AWS::Serverless::Api.Domain`.

Parameters:

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

Returns:

this

endpointConfiguration

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

`AWS::Serverless::Api.EndpointConfiguration`.

Parameters:

endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`. This parameter is required.

Returns:

this

endpointConfiguration

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

`AWS::Serverless::Api.EndpointConfiguration`.

Parameters:

endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`. This parameter is required.

Returns:

this

endpointConfiguration

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

`AWS::Serverless::Api.EndpointConfiguration`.

Parameters:

endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`. This parameter is required.

Returns:

this

gatewayResponses

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

`AWS::Serverless::Api.GatewayResponses`.

Parameters:

gatewayResponses - `AWS::Serverless::Api.GatewayResponses`. This parameter is required.

Returns:

this

methodSettings

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

`AWS::Serverless::Api.MethodSettings`.

Parameters:

methodSettings - `AWS::Serverless::Api.MethodSettings`. This parameter is required.

Returns:

this

methodSettings

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

`AWS::Serverless::Api.MethodSettings`.

Parameters:

methodSettings - `AWS::Serverless::Api.MethodSettings`. This parameter is required.

Returns:

this

minimumCompressionSize

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

`AWS::Serverless::Api.MinimumCompressionSize`.

Parameters:

minimumCompressionSize - `AWS::Serverless::Api.MinimumCompressionSize`. This parameter is required.

Returns:

this

models

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

`AWS::Serverless::Api.Models`.

Parameters:

models - `AWS::Serverless::Api.Models`. This parameter is required.

Returns:

this

name

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

`AWS::Serverless::Api.Name`.

Parameters:

name - `AWS::Serverless::Api.Name`. This parameter is required.

Returns:

this

openApiVersion

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

`AWS::Serverless::Api.OpenApiVersion`.

Parameters:

openApiVersion - `AWS::Serverless::Api.OpenApiVersion`. This parameter is required.

Returns:

this

tags

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

`AWS::Serverless::Api.Tags`.

Parameters:

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

Returns:

this

tracingEnabled

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

`AWS::Serverless::Api.TracingEnabled`.

Parameters:

tracingEnabled - `AWS::Serverless::Api.TracingEnabled`. This parameter is required.

Returns:

this

tracingEnabled

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

`AWS::Serverless::Api.TracingEnabled`.

Parameters:

tracingEnabled - `AWS::Serverless::Api.TracingEnabled`. This parameter is required.

Returns:

this

variables

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

`AWS::Serverless::Api.Variables`.

Parameters:

variables - `AWS::Serverless::Api.Variables`. This parameter is required.

Returns:

this

variables

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

`AWS::Serverless::Api.Variables`.

Parameters:

variables - `AWS::Serverless::Api.Variables`. This parameter is required.

Returns:

this

build

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

Specified by:

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