software.amazon.awscdk.services.apigatewayv2

Class CfnApi.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.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	apiKeySelectionExpression(String apiKeySelectionExpression) `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.
CfnApi.Builder	basePath(String basePath) `AWS::ApiGatewayV2::Api.BasePath`.
CfnApi.Builder	body(Object body) `AWS::ApiGatewayV2::Api.Body`.
CfnApi.Builder	bodyS3Location(CfnApi.BodyS3LocationProperty bodyS3Location) `AWS::ApiGatewayV2::Api.BodyS3Location`.
CfnApi.Builder	bodyS3Location(IResolvable bodyS3Location) `AWS::ApiGatewayV2::Api.BodyS3Location`.
CfnApi	build()
CfnApi.Builder	corsConfiguration(CfnApi.CorsProperty corsConfiguration) `AWS::ApiGatewayV2::Api.CorsConfiguration`.
CfnApi.Builder	corsConfiguration(IResolvable corsConfiguration) `AWS::ApiGatewayV2::Api.CorsConfiguration`.
static CfnApi.Builder	create(software.constructs.Construct scope, String id)
CfnApi.Builder	credentialsArn(String credentialsArn) `AWS::ApiGatewayV2::Api.CredentialsArn`.
CfnApi.Builder	description(String description) `AWS::ApiGatewayV2::Api.Description`.
CfnApi.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
CfnApi.Builder	disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint) `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
CfnApi.Builder	disableSchemaValidation(Boolean disableSchemaValidation) `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
CfnApi.Builder	disableSchemaValidation(IResolvable disableSchemaValidation) `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
CfnApi.Builder	failOnWarnings(Boolean failOnWarnings) `AWS::ApiGatewayV2::Api.FailOnWarnings`.
CfnApi.Builder	failOnWarnings(IResolvable failOnWarnings) `AWS::ApiGatewayV2::Api.FailOnWarnings`.
CfnApi.Builder	name(String name) `AWS::ApiGatewayV2::Api.Name`.
CfnApi.Builder	protocolType(String protocolType) `AWS::ApiGatewayV2::Api.ProtocolType`.
CfnApi.Builder	routeKey(String routeKey) `AWS::ApiGatewayV2::Api.RouteKey`.
CfnApi.Builder	routeSelectionExpression(String routeSelectionExpression) `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.
CfnApi.Builder	tags(Object tags) `AWS::ApiGatewayV2::Api.Tags`.
CfnApi.Builder	target(String target) `AWS::ApiGatewayV2::Api.Target`.
CfnApi.Builder	version(String version) `AWS::ApiGatewayV2::Api.Version`.

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.BodyS3LocationProperty.Builder.

apiKeySelectionExpression

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

`AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.

Parameters:

apiKeySelectionExpression - `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`. This parameter is required.

Returns:

this

basePath

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

`AWS::ApiGatewayV2::Api.BasePath`.

Parameters:

basePath - `AWS::ApiGatewayV2::Api.BasePath`. This parameter is required.

Returns:

this

body

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

`AWS::ApiGatewayV2::Api.Body`.

Parameters:

body - `AWS::ApiGatewayV2::Api.Body`. This parameter is required.

Returns:

this

bodyS3Location

@Stability(value=Stable)
public CfnApi.Builder bodyS3Location(CfnApi.BodyS3LocationProperty bodyS3Location)

`AWS::ApiGatewayV2::Api.BodyS3Location`.

Parameters:

bodyS3Location - `AWS::ApiGatewayV2::Api.BodyS3Location`. This parameter is required.

Returns:

this

bodyS3Location

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

`AWS::ApiGatewayV2::Api.BodyS3Location`.

Parameters:

bodyS3Location - `AWS::ApiGatewayV2::Api.BodyS3Location`. This parameter is required.

Returns:

this

corsConfiguration

@Stability(value=Stable)
public CfnApi.Builder corsConfiguration(CfnApi.CorsProperty corsConfiguration)

`AWS::ApiGatewayV2::Api.CorsConfiguration`.

Parameters:

corsConfiguration - `AWS::ApiGatewayV2::Api.CorsConfiguration`. This parameter is required.

Returns:

this

corsConfiguration

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

`AWS::ApiGatewayV2::Api.CorsConfiguration`.

Parameters:

corsConfiguration - `AWS::ApiGatewayV2::Api.CorsConfiguration`. This parameter is required.

Returns:

this

credentialsArn

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

`AWS::ApiGatewayV2::Api.CredentialsArn`.

Parameters:

credentialsArn - `AWS::ApiGatewayV2::Api.CredentialsArn`. This parameter is required.

Returns:

this

description

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

`AWS::ApiGatewayV2::Api.Description`.

Parameters:

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

Returns:

this

disableExecuteApiEndpoint

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

`AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.

Parameters:

disableExecuteApiEndpoint - `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`. This parameter is required.

Returns:

this

disableExecuteApiEndpoint

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

`AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.

Parameters:

disableExecuteApiEndpoint - `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`. This parameter is required.

Returns:

this

disableSchemaValidation

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

`AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

Parameters:

disableSchemaValidation - `AWS::ApiGatewayV2::Api.DisableSchemaValidation`. This parameter is required.

Returns:

this

disableSchemaValidation

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

`AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

Parameters:

disableSchemaValidation - `AWS::ApiGatewayV2::Api.DisableSchemaValidation`. This parameter is required.

Returns:

this

failOnWarnings

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

`AWS::ApiGatewayV2::Api.FailOnWarnings`.

Parameters:

failOnWarnings - `AWS::ApiGatewayV2::Api.FailOnWarnings`. This parameter is required.

Returns:

this

failOnWarnings

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

`AWS::ApiGatewayV2::Api.FailOnWarnings`.

Parameters:

failOnWarnings - `AWS::ApiGatewayV2::Api.FailOnWarnings`. This parameter is required.

Returns:

this

name

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

`AWS::ApiGatewayV2::Api.Name`.

Parameters:

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

Returns:

this

protocolType

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

`AWS::ApiGatewayV2::Api.ProtocolType`.

Parameters:

protocolType - `AWS::ApiGatewayV2::Api.ProtocolType`. This parameter is required.

Returns:

this

routeKey

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

`AWS::ApiGatewayV2::Api.RouteKey`.

Parameters:

routeKey - `AWS::ApiGatewayV2::Api.RouteKey`. This parameter is required.

Returns:

this

routeSelectionExpression

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

`AWS::ApiGatewayV2::Api.RouteSelectionExpression`.

Parameters:

routeSelectionExpression - `AWS::ApiGatewayV2::Api.RouteSelectionExpression`. This parameter is required.

Returns:

this

tags

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

`AWS::ApiGatewayV2::Api.Tags`.

Parameters:

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

Returns:

this

target

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

`AWS::ApiGatewayV2::Api.Target`.

Parameters:

target - `AWS::ApiGatewayV2::Api.Target`. This parameter is required.

Returns:

this

version

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

`AWS::ApiGatewayV2::Api.Version`.

Parameters:

version - `AWS::ApiGatewayV2::Api.Version`. This parameter is required.

Returns:

this

build

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

Specified by:

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