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

java.lang.Object
- software.amazon.awscdk.services.apigateway.CfnRestApiProps.Builder

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

Enclosing interface:: CfnRestApiProps

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

A builder for CfnRestApiProps

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
`CfnRestApiProps.Builder`	`apiKeySourceType(String apiKeySourceType)` Sets the value of `CfnRestApiProps.getApiKeySourceType()`
`CfnRestApiProps.Builder`	`binaryMediaTypes(List<String> binaryMediaTypes)` Sets the value of `CfnRestApiProps.getBinaryMediaTypes()`
`CfnRestApiProps.Builder`	`body(Object body)` Sets the value of `CfnRestApiProps.getBody()`
`CfnRestApiProps.Builder`	`bodyS3Location(CfnRestApi.S3LocationProperty bodyS3Location)` Sets the value of `CfnRestApiProps.getBodyS3Location()`
`CfnRestApiProps.Builder`	`bodyS3Location(IResolvable bodyS3Location)` Sets the value of `CfnRestApiProps.getBodyS3Location()`
`CfnRestApiProps`	`build()` Builds the configured instance.
`CfnRestApiProps.Builder`	`cloneFrom(String cloneFrom)` Sets the value of `CfnRestApiProps.getCloneFrom()`
`CfnRestApiProps.Builder`	`description(String description)` Sets the value of `CfnRestApiProps.getDescription()`
`CfnRestApiProps.Builder`	`disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)` Sets the value of `CfnRestApiProps.getDisableExecuteApiEndpoint()`
`CfnRestApiProps.Builder`	`disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)` Sets the value of `CfnRestApiProps.getDisableExecuteApiEndpoint()`
`CfnRestApiProps.Builder`	`endpointConfiguration(CfnRestApi.EndpointConfigurationProperty endpointConfiguration)` Sets the value of `CfnRestApiProps.getEndpointConfiguration()`
`CfnRestApiProps.Builder`	`endpointConfiguration(IResolvable endpointConfiguration)` Sets the value of `CfnRestApiProps.getEndpointConfiguration()`
`CfnRestApiProps.Builder`	`failOnWarnings(Boolean failOnWarnings)` Sets the value of `CfnRestApiProps.getFailOnWarnings()`
`CfnRestApiProps.Builder`	`failOnWarnings(IResolvable failOnWarnings)` Sets the value of `CfnRestApiProps.getFailOnWarnings()`
`CfnRestApiProps.Builder`	`minimumCompressionSize(Number minimumCompressionSize)` Sets the value of `CfnRestApiProps.getMinimumCompressionSize()`
`CfnRestApiProps.Builder`	`name(String name)` Sets the value of `CfnRestApiProps.getName()`
`CfnRestApiProps.Builder`	`parameters(IResolvable parameters)` Sets the value of `CfnRestApiProps.getParameters()`
`CfnRestApiProps.Builder`	`parameters(Map<String,String> parameters)` Sets the value of `CfnRestApiProps.getParameters()`
`CfnRestApiProps.Builder`	`policy(Object policy)` Sets the value of `CfnRestApiProps.getPolicy()`
`CfnRestApiProps.Builder`	`tags(List<? extends CfnTag> tags)` Sets the value of `CfnRestApiProps.getTags()`

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
  - apiKeySourceType
```
@Stability(value=Stable)
public CfnRestApiProps.Builder apiKeySourceType(String apiKeySourceType)
```
    Sets the value of CfnRestApiProps.getApiKeySourceType()
    
    Parameters:
    
    apiKeySourceType - `AWS::ApiGateway::RestApi.ApiKeySourceType`.
    
    Returns:
    
    this
  - binaryMediaTypes
```
@Stability(value=Stable)
public CfnRestApiProps.Builder binaryMediaTypes(List<String> binaryMediaTypes)
```
    Sets the value of CfnRestApiProps.getBinaryMediaTypes()
    
    Parameters:
    
    binaryMediaTypes - `AWS::ApiGateway::RestApi.BinaryMediaTypes`.
    
    Returns:
    
    this
  - body
```
@Stability(value=Stable)
public CfnRestApiProps.Builder body(Object body)
```
    Sets the value of CfnRestApiProps.getBody()
    
    Parameters:
    
    body - `AWS::ApiGateway::RestApi.Body`.
    
    Returns:
    
    this
  - bodyS3Location
```
@Stability(value=Stable)
public CfnRestApiProps.Builder bodyS3Location(CfnRestApi.S3LocationProperty bodyS3Location)
```
    Sets the value of CfnRestApiProps.getBodyS3Location()
    
    Parameters:
    
    bodyS3Location - `AWS::ApiGateway::RestApi.BodyS3Location`.
    
    Returns:
    
    this
  - bodyS3Location
```
@Stability(value=Stable)
public CfnRestApiProps.Builder bodyS3Location(IResolvable bodyS3Location)
```
    Sets the value of CfnRestApiProps.getBodyS3Location()
    
    Parameters:
    
    bodyS3Location - `AWS::ApiGateway::RestApi.BodyS3Location`.
    
    Returns:
    
    this
  - cloneFrom
```
@Stability(value=Stable)
public CfnRestApiProps.Builder cloneFrom(String cloneFrom)
```
    Sets the value of CfnRestApiProps.getCloneFrom()
    
    Parameters:
    
    cloneFrom - `AWS::ApiGateway::RestApi.CloneFrom`.
    
    Returns:
    
    this
  - description
```
@Stability(value=Stable)
public CfnRestApiProps.Builder description(String description)
```
    Sets the value of CfnRestApiProps.getDescription()
    
    Parameters:
    
    description - `AWS::ApiGateway::RestApi.Description`.
    
    Returns:
    
    this
  - disableExecuteApiEndpoint
```
@Stability(value=Stable)
public CfnRestApiProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
```
    Sets the value of CfnRestApiProps.getDisableExecuteApiEndpoint()
    
    Parameters:
    
    disableExecuteApiEndpoint - `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
    
    Returns:
    
    this
  - disableExecuteApiEndpoint
```
@Stability(value=Stable)
public CfnRestApiProps.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
```
    Sets the value of CfnRestApiProps.getDisableExecuteApiEndpoint()
    
    Parameters:
    
    disableExecuteApiEndpoint - `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
    
    Returns:
    
    this
  - endpointConfiguration
```
@Stability(value=Stable)
public CfnRestApiProps.Builder endpointConfiguration(CfnRestApi.EndpointConfigurationProperty endpointConfiguration)
```
    Sets the value of CfnRestApiProps.getEndpointConfiguration()
    
    Parameters:
    
    endpointConfiguration - `AWS::ApiGateway::RestApi.EndpointConfiguration`.
    
    Returns:
    
    this
  - endpointConfiguration
```
@Stability(value=Stable)
public CfnRestApiProps.Builder endpointConfiguration(IResolvable endpointConfiguration)
```
    Sets the value of CfnRestApiProps.getEndpointConfiguration()
    
    Parameters:
    
    endpointConfiguration - `AWS::ApiGateway::RestApi.EndpointConfiguration`.
    
    Returns:
    
    this
  - failOnWarnings
```
@Stability(value=Stable)
public CfnRestApiProps.Builder failOnWarnings(Boolean failOnWarnings)
```
    Sets the value of CfnRestApiProps.getFailOnWarnings()
    
    Parameters:
    
    failOnWarnings - `AWS::ApiGateway::RestApi.FailOnWarnings`.
    
    Returns:
    
    this
  - failOnWarnings
```
@Stability(value=Stable)
public CfnRestApiProps.Builder failOnWarnings(IResolvable failOnWarnings)
```
    Sets the value of CfnRestApiProps.getFailOnWarnings()
    
    Parameters:
    
    failOnWarnings - `AWS::ApiGateway::RestApi.FailOnWarnings`.
    
    Returns:
    
    this
  - minimumCompressionSize
```
@Stability(value=Stable)
public CfnRestApiProps.Builder minimumCompressionSize(Number minimumCompressionSize)
```
    Sets the value of CfnRestApiProps.getMinimumCompressionSize()
    
    Parameters:
    
    minimumCompressionSize - `AWS::ApiGateway::RestApi.MinimumCompressionSize`.
    
    Returns:
    
    this
  - name
```
@Stability(value=Stable)
public CfnRestApiProps.Builder name(String name)
```
    Sets the value of CfnRestApiProps.getName()
    
    Parameters:
    
    name - `AWS::ApiGateway::RestApi.Name`.
    
    Returns:
    
    this
  - parameters
```
@Stability(value=Stable)
public CfnRestApiProps.Builder parameters(IResolvable parameters)
```
    Sets the value of CfnRestApiProps.getParameters()
    
    Parameters:
    
    parameters - `AWS::ApiGateway::RestApi.Parameters`.
    
    Returns:
    
    this
  - parameters
```
@Stability(value=Stable)
public CfnRestApiProps.Builder parameters(Map<String,String> parameters)
```
    Sets the value of CfnRestApiProps.getParameters()
    
    Parameters:
    
    parameters - `AWS::ApiGateway::RestApi.Parameters`.
    
    Returns:
    
    this
  - policy
```
@Stability(value=Stable)
public CfnRestApiProps.Builder policy(Object policy)
```
    Sets the value of CfnRestApiProps.getPolicy()
    
    Parameters:
    
    policy - `AWS::ApiGateway::RestApi.Policy`.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnRestApiProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnRestApiProps.getTags()
    
    Parameters:
    
    tags - `AWS::ApiGateway::RestApi.Tags`.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnRestApiProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnRestApiProps>
    
    Returns:
    
    a new instance of CfnRestApiProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnRestApiProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

apiKeySourceType

binaryMediaTypes

body

bodyS3Location

bodyS3Location

cloneFrom

description

disableExecuteApiEndpoint

disableExecuteApiEndpoint

endpointConfiguration

endpointConfiguration

failOnWarnings

failOnWarnings

minimumCompressionSize

name

parameters

parameters

policy

tags

build