software.amazon.awscdk.services.sam

Class CfnApi.Builder

java.lang.Object

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

Enclosing class:

CfnApi

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

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	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(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	endpointConfiguration(String endpointConfiguration) `AWS::Serverless::Api.EndpointConfiguration`.
CfnApi.Builder	methodSettings(IResolvable methodSettings) `AWS::Serverless::Api.MethodSettings`.
CfnApi.Builder	methodSettings(List<Object> methodSettings) `AWS::Serverless::Api.MethodSettings`.
CfnApi.Builder	name(String name) `AWS::Serverless::Api.Name`.
CfnApi.Builder	stageName(String stageName) `AWS::Serverless::Api.StageName`.
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=External)
public static CfnApi.Builder create(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=External)
public CfnApi.Builder stageName(String stageName)

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

accessLogSetting

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

accessLogSetting

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

auth

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

auth

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

binaryMediaTypes

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

cacheClusterEnabled

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

cacheClusterEnabled

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

cacheClusterSize

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

cors

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

cors

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

cors

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

definitionBody

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

definitionUri

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

definitionUri

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

definitionUri

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

endpointConfiguration

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

methodSettings

@Stability(value=External)
public CfnApi.Builder methodSettings(List<Object> methodSettings)

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

methodSettings

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

name

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

tracingEnabled

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

tracingEnabled

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

variables

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

variables

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

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

Parameters:

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

Returns:

this

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

build

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