software.amazon.awscdk.services.apigateway

Class CfnRestApi.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnRestApi.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRestApi>

Enclosing class:

CfnRestApi

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

A fluent builder for CfnRestApi.

Method Summary

Modifier and Type	Method and Description
CfnRestApi.Builder	apiKeySourceType(String apiKeySourceType) `AWS::ApiGateway::RestApi.ApiKeySourceType`.
CfnRestApi.Builder	binaryMediaTypes(List<String> binaryMediaTypes) `AWS::ApiGateway::RestApi.BinaryMediaTypes`.
CfnRestApi.Builder	body(Object body) `AWS::ApiGateway::RestApi.Body`.
CfnRestApi.Builder	bodyS3Location(CfnRestApi.S3LocationProperty bodyS3Location) `AWS::ApiGateway::RestApi.BodyS3Location`.
CfnRestApi.Builder	bodyS3Location(IResolvable bodyS3Location) `AWS::ApiGateway::RestApi.BodyS3Location`.
CfnRestApi	build()
CfnRestApi.Builder	cloneFrom(String cloneFrom) `AWS::ApiGateway::RestApi.CloneFrom`.
static CfnRestApi.Builder	create(software.constructs.Construct scope, String id)
CfnRestApi.Builder	description(String description) `AWS::ApiGateway::RestApi.Description`.
CfnRestApi.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
CfnRestApi.Builder	disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint) `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
CfnRestApi.Builder	endpointConfiguration(CfnRestApi.EndpointConfigurationProperty endpointConfiguration) `AWS::ApiGateway::RestApi.EndpointConfiguration`.
CfnRestApi.Builder	endpointConfiguration(IResolvable endpointConfiguration) `AWS::ApiGateway::RestApi.EndpointConfiguration`.
CfnRestApi.Builder	failOnWarnings(Boolean failOnWarnings) `AWS::ApiGateway::RestApi.FailOnWarnings`.
CfnRestApi.Builder	failOnWarnings(IResolvable failOnWarnings) `AWS::ApiGateway::RestApi.FailOnWarnings`.
CfnRestApi.Builder	minimumCompressionSize(Number minimumCompressionSize) `AWS::ApiGateway::RestApi.MinimumCompressionSize`.
CfnRestApi.Builder	name(String name) `AWS::ApiGateway::RestApi.Name`.
CfnRestApi.Builder	parameters(IResolvable parameters) `AWS::ApiGateway::RestApi.Parameters`.
CfnRestApi.Builder	parameters(Map<String,String> parameters) `AWS::ApiGateway::RestApi.Parameters`.
CfnRestApi.Builder	policy(Object policy) `AWS::ApiGateway::RestApi.Policy`.
CfnRestApi.Builder	tags(List<? extends CfnTag> tags) `AWS::ApiGateway::RestApi.Tags`.

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 CfnRestApi.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 CfnRestApi.EndpointConfigurationProperty.Builder.

apiKeySourceType

@Stability(value=Stable)
public CfnRestApi.Builder apiKeySourceType(String apiKeySourceType)

`AWS::ApiGateway::RestApi.ApiKeySourceType`.

Parameters:

apiKeySourceType - `AWS::ApiGateway::RestApi.ApiKeySourceType`. This parameter is required.

Returns:

this

binaryMediaTypes

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

`AWS::ApiGateway::RestApi.BinaryMediaTypes`.

Parameters:

binaryMediaTypes - `AWS::ApiGateway::RestApi.BinaryMediaTypes`. This parameter is required.

Returns:

this

body

@Stability(value=Stable)
public CfnRestApi.Builder body(Object body)

`AWS::ApiGateway::RestApi.Body`.

Parameters:

body - `AWS::ApiGateway::RestApi.Body`. This parameter is required.

Returns:

this

bodyS3Location

@Stability(value=Stable)
public CfnRestApi.Builder bodyS3Location(CfnRestApi.S3LocationProperty bodyS3Location)

`AWS::ApiGateway::RestApi.BodyS3Location`.

Parameters:

bodyS3Location - `AWS::ApiGateway::RestApi.BodyS3Location`. This parameter is required.

Returns:

this

bodyS3Location

@Stability(value=Stable)
public CfnRestApi.Builder bodyS3Location(IResolvable bodyS3Location)

`AWS::ApiGateway::RestApi.BodyS3Location`.

Parameters:

bodyS3Location - `AWS::ApiGateway::RestApi.BodyS3Location`. This parameter is required.

Returns:

this

cloneFrom

@Stability(value=Stable)
public CfnRestApi.Builder cloneFrom(String cloneFrom)

`AWS::ApiGateway::RestApi.CloneFrom`.

Parameters:

cloneFrom - `AWS::ApiGateway::RestApi.CloneFrom`. This parameter is required.

Returns:

this

description

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

`AWS::ApiGateway::RestApi.Description`.

Parameters:

description - `AWS::ApiGateway::RestApi.Description`. This parameter is required.

Returns:

this

disableExecuteApiEndpoint

@Stability(value=Stable)
public CfnRestApi.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)

`AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.

Parameters:

disableExecuteApiEndpoint - `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`. This parameter is required.

Returns:

this

disableExecuteApiEndpoint

@Stability(value=Stable)
public CfnRestApi.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)

`AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.

Parameters:

disableExecuteApiEndpoint - `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`. This parameter is required.

Returns:

this

endpointConfiguration

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

`AWS::ApiGateway::RestApi.EndpointConfiguration`.

Parameters:

endpointConfiguration - `AWS::ApiGateway::RestApi.EndpointConfiguration`. This parameter is required.

Returns:

this

endpointConfiguration

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

`AWS::ApiGateway::RestApi.EndpointConfiguration`.

Parameters:

endpointConfiguration - `AWS::ApiGateway::RestApi.EndpointConfiguration`. This parameter is required.

Returns:

this

failOnWarnings

@Stability(value=Stable)
public CfnRestApi.Builder failOnWarnings(Boolean failOnWarnings)

`AWS::ApiGateway::RestApi.FailOnWarnings`.

Parameters:

failOnWarnings - `AWS::ApiGateway::RestApi.FailOnWarnings`. This parameter is required.

Returns:

this

failOnWarnings

@Stability(value=Stable)
public CfnRestApi.Builder failOnWarnings(IResolvable failOnWarnings)

`AWS::ApiGateway::RestApi.FailOnWarnings`.

Parameters:

failOnWarnings - `AWS::ApiGateway::RestApi.FailOnWarnings`. This parameter is required.

Returns:

this

minimumCompressionSize

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

`AWS::ApiGateway::RestApi.MinimumCompressionSize`.

Parameters:

minimumCompressionSize - `AWS::ApiGateway::RestApi.MinimumCompressionSize`. This parameter is required.

Returns:

this

name

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

`AWS::ApiGateway::RestApi.Name`.

Parameters:

name - `AWS::ApiGateway::RestApi.Name`. This parameter is required.

Returns:

this

parameters

@Stability(value=Stable)
public CfnRestApi.Builder parameters(IResolvable parameters)

`AWS::ApiGateway::RestApi.Parameters`.

Parameters:

parameters - `AWS::ApiGateway::RestApi.Parameters`. This parameter is required.

Returns:

this

parameters

@Stability(value=Stable)
public CfnRestApi.Builder parameters(Map<String,String> parameters)

`AWS::ApiGateway::RestApi.Parameters`.

Parameters:

parameters - `AWS::ApiGateway::RestApi.Parameters`. This parameter is required.

Returns:

this

policy

@Stability(value=Stable)
public CfnRestApi.Builder policy(Object policy)

`AWS::ApiGateway::RestApi.Policy`.

Parameters:

policy - `AWS::ApiGateway::RestApi.Policy`. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnRestApi.Builder tags(List<? extends CfnTag> tags)

`AWS::ApiGateway::RestApi.Tags`.

Parameters:

tags - `AWS::ApiGateway::RestApi.Tags`. This parameter is required.

Returns:

this

build

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

Specified by:

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