CfnApiProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.6 API)

java.lang.Object
- software.amazon.awscdk.services.apigatewayv2.CfnApiProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnApiProps>

Enclosing interface:: CfnApiProps

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

A builder for CfnApiProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnApiProps.Builder`	`apiKeySelectionExpression(String apiKeySelectionExpression)` Sets the value of `CfnApiProps.getApiKeySelectionExpression()`
`CfnApiProps.Builder`	`basePath(String basePath)` Sets the value of `CfnApiProps.getBasePath()`
`CfnApiProps.Builder`	`body(Object body)` Sets the value of `CfnApiProps.getBody()`
`CfnApiProps.Builder`	`bodyS3Location(CfnApi.BodyS3LocationProperty bodyS3Location)` Sets the value of `CfnApiProps.getBodyS3Location()`
`CfnApiProps.Builder`	`bodyS3Location(IResolvable bodyS3Location)` Sets the value of `CfnApiProps.getBodyS3Location()`
`CfnApiProps`	`build()` Builds the configured instance.
`CfnApiProps.Builder`	`corsConfiguration(CfnApi.CorsProperty corsConfiguration)` Sets the value of `CfnApiProps.getCorsConfiguration()`
`CfnApiProps.Builder`	`corsConfiguration(IResolvable corsConfiguration)` Sets the value of `CfnApiProps.getCorsConfiguration()`
`CfnApiProps.Builder`	`credentialsArn(String credentialsArn)` Sets the value of `CfnApiProps.getCredentialsArn()`
`CfnApiProps.Builder`	`description(String description)` Sets the value of `CfnApiProps.getDescription()`
`CfnApiProps.Builder`	`disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)` Sets the value of `CfnApiProps.getDisableExecuteApiEndpoint()`
`CfnApiProps.Builder`	`disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)` Sets the value of `CfnApiProps.getDisableExecuteApiEndpoint()`
`CfnApiProps.Builder`	`disableSchemaValidation(Boolean disableSchemaValidation)` Sets the value of `CfnApiProps.getDisableSchemaValidation()`
`CfnApiProps.Builder`	`disableSchemaValidation(IResolvable disableSchemaValidation)` Sets the value of `CfnApiProps.getDisableSchemaValidation()`
`CfnApiProps.Builder`	`failOnWarnings(Boolean failOnWarnings)` Sets the value of `CfnApiProps.getFailOnWarnings()`
`CfnApiProps.Builder`	`failOnWarnings(IResolvable failOnWarnings)` Sets the value of `CfnApiProps.getFailOnWarnings()`
`CfnApiProps.Builder`	`name(String name)` Sets the value of `CfnApiProps.getName()`
`CfnApiProps.Builder`	`protocolType(String protocolType)` Sets the value of `CfnApiProps.getProtocolType()`
`CfnApiProps.Builder`	`routeKey(String routeKey)` Sets the value of `CfnApiProps.getRouteKey()`
`CfnApiProps.Builder`	`routeSelectionExpression(String routeSelectionExpression)` Sets the value of `CfnApiProps.getRouteSelectionExpression()`
`CfnApiProps.Builder`	`tags(Object tags)` Sets the value of `CfnApiProps.getTags()`
`CfnApiProps.Builder`	`target(String target)` Sets the value of `CfnApiProps.getTarget()`
`CfnApiProps.Builder`	`version(String version)` Sets the value of `CfnApiProps.getVersion()`

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
  - apiKeySelectionExpression
```
@Stability(value=Stable)
public CfnApiProps.Builder apiKeySelectionExpression(String apiKeySelectionExpression)
```
    Sets the value of CfnApiProps.getApiKeySelectionExpression()
    
    Parameters:
    
    apiKeySelectionExpression - `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.
    
    Returns:
    
    this
  - basePath
```
@Stability(value=Stable)
public CfnApiProps.Builder basePath(String basePath)
```
    Sets the value of CfnApiProps.getBasePath()
    
    Parameters:
    
    basePath - `AWS::ApiGatewayV2::Api.BasePath`.
    
    Returns:
    
    this
  - body
```
@Stability(value=Stable)
public CfnApiProps.Builder body(Object body)
```
    Sets the value of CfnApiProps.getBody()
    
    Parameters:
    
    body - `AWS::ApiGatewayV2::Api.Body`.
    
    Returns:
    
    this
  - bodyS3Location
```
@Stability(value=Stable)
public CfnApiProps.Builder bodyS3Location(CfnApi.BodyS3LocationProperty bodyS3Location)
```
    Sets the value of CfnApiProps.getBodyS3Location()
    
    Parameters:
    
    bodyS3Location - `AWS::ApiGatewayV2::Api.BodyS3Location`.
    
    Returns:
    
    this
  - bodyS3Location
```
@Stability(value=Stable)
public CfnApiProps.Builder bodyS3Location(IResolvable bodyS3Location)
```
    Sets the value of CfnApiProps.getBodyS3Location()
    
    Parameters:
    
    bodyS3Location - `AWS::ApiGatewayV2::Api.BodyS3Location`.
    
    Returns:
    
    this
  - corsConfiguration
```
@Stability(value=Stable)
public CfnApiProps.Builder corsConfiguration(CfnApi.CorsProperty corsConfiguration)
```
    Sets the value of CfnApiProps.getCorsConfiguration()
    
    Parameters:
    
    corsConfiguration - `AWS::ApiGatewayV2::Api.CorsConfiguration`.
    
    Returns:
    
    this
  - corsConfiguration
```
@Stability(value=Stable)
public CfnApiProps.Builder corsConfiguration(IResolvable corsConfiguration)
```
    Sets the value of CfnApiProps.getCorsConfiguration()
    
    Parameters:
    
    corsConfiguration - `AWS::ApiGatewayV2::Api.CorsConfiguration`.
    
    Returns:
    
    this
  - credentialsArn
```
@Stability(value=Stable)
public CfnApiProps.Builder credentialsArn(String credentialsArn)
```
    Sets the value of CfnApiProps.getCredentialsArn()
    
    Parameters:
    
    credentialsArn - `AWS::ApiGatewayV2::Api.CredentialsArn`.
    
    Returns:
    
    this
  - description
```
@Stability(value=Stable)
public CfnApiProps.Builder description(String description)
```
    Sets the value of CfnApiProps.getDescription()
    
    Parameters:
    
    description - `AWS::ApiGatewayV2::Api.Description`.
    
    Returns:
    
    this
  - disableExecuteApiEndpoint
```
@Stability(value=Stable)
public CfnApiProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
```
    Sets the value of CfnApiProps.getDisableExecuteApiEndpoint()
    
    Parameters:
    
    disableExecuteApiEndpoint - `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
    
    Returns:
    
    this
  - disableExecuteApiEndpoint
```
@Stability(value=Stable)
public CfnApiProps.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
```
    Sets the value of CfnApiProps.getDisableExecuteApiEndpoint()
    
    Parameters:
    
    disableExecuteApiEndpoint - `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
    
    Returns:
    
    this
  - disableSchemaValidation
```
@Stability(value=Stable)
public CfnApiProps.Builder disableSchemaValidation(Boolean disableSchemaValidation)
```
    Sets the value of CfnApiProps.getDisableSchemaValidation()
    
    Parameters:
    
    disableSchemaValidation - `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
    
    Returns:
    
    this
  - disableSchemaValidation
```
@Stability(value=Stable)
public CfnApiProps.Builder disableSchemaValidation(IResolvable disableSchemaValidation)
```
    Sets the value of CfnApiProps.getDisableSchemaValidation()
    
    Parameters:
    
    disableSchemaValidation - `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
    
    Returns:
    
    this
  - failOnWarnings
```
@Stability(value=Stable)
public CfnApiProps.Builder failOnWarnings(Boolean failOnWarnings)
```
    Sets the value of CfnApiProps.getFailOnWarnings()
    
    Parameters:
    
    failOnWarnings - `AWS::ApiGatewayV2::Api.FailOnWarnings`.
    
    Returns:
    
    this
  - failOnWarnings
```
@Stability(value=Stable)
public CfnApiProps.Builder failOnWarnings(IResolvable failOnWarnings)
```
    Sets the value of CfnApiProps.getFailOnWarnings()
    
    Parameters:
    
    failOnWarnings - `AWS::ApiGatewayV2::Api.FailOnWarnings`.
    
    Returns:
    
    this
  - name
```
@Stability(value=Stable)
public CfnApiProps.Builder name(String name)
```
    Sets the value of CfnApiProps.getName()
    
    Parameters:
    
    name - `AWS::ApiGatewayV2::Api.Name`.
    
    Returns:
    
    this
  - protocolType
```
@Stability(value=Stable)
public CfnApiProps.Builder protocolType(String protocolType)
```
    Sets the value of CfnApiProps.getProtocolType()
    
    Parameters:
    
    protocolType - `AWS::ApiGatewayV2::Api.ProtocolType`.
    
    Returns:
    
    this
  - routeKey
```
@Stability(value=Stable)
public CfnApiProps.Builder routeKey(String routeKey)
```
    Sets the value of CfnApiProps.getRouteKey()
    
    Parameters:
    
    routeKey - `AWS::ApiGatewayV2::Api.RouteKey`.
    
    Returns:
    
    this
  - routeSelectionExpression
```
@Stability(value=Stable)
public CfnApiProps.Builder routeSelectionExpression(String routeSelectionExpression)
```
    Sets the value of CfnApiProps.getRouteSelectionExpression()
    
    Parameters:
    
    routeSelectionExpression - `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnApiProps.Builder tags(Object tags)
```
    Sets the value of CfnApiProps.getTags()
    
    Parameters:
    
    tags - `AWS::ApiGatewayV2::Api.Tags`.
    
    Returns:
    
    this
  - target
```
@Stability(value=Stable)
public CfnApiProps.Builder target(String target)
```
    Sets the value of CfnApiProps.getTarget()
    
    Parameters:
    
    target - `AWS::ApiGatewayV2::Api.Target`.
    
    Returns:
    
    this
  - version
```
@Stability(value=Stable)
public CfnApiProps.Builder version(String version)
```
    Sets the value of CfnApiProps.getVersion()
    
    Parameters:
    
    version - `AWS::ApiGatewayV2::Api.Version`.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnApiProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnApiProps>
    
    Returns:
    
    a new instance of CfnApiProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnApiProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

apiKeySelectionExpression

basePath

body

bodyS3Location

bodyS3Location

corsConfiguration

corsConfiguration

credentialsArn

description

disableExecuteApiEndpoint

disableExecuteApiEndpoint

disableSchemaValidation

disableSchemaValidation

failOnWarnings

failOnWarnings

name

protocolType

routeKey

routeSelectionExpression

tags

target

version

build