CfnHttpApiProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.sam.CfnHttpApiProps.Builder

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

Enclosing interface:: CfnHttpApiProps

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

A builder for CfnHttpApiProps

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
`CfnHttpApiProps.Builder`	`accessLogSetting(CfnHttpApi.AccessLogSettingProperty accessLogSetting)` Sets the value of `CfnHttpApiProps.getAccessLogSetting()`
`CfnHttpApiProps.Builder`	`accessLogSetting(IResolvable accessLogSetting)` Sets the value of `CfnHttpApiProps.getAccessLogSetting()`
`CfnHttpApiProps.Builder`	`auth(CfnHttpApi.HttpApiAuthProperty auth)` Sets the value of `CfnHttpApiProps.getAuth()`
`CfnHttpApiProps.Builder`	`auth(IResolvable auth)` Sets the value of `CfnHttpApiProps.getAuth()`
`CfnHttpApiProps`	`build()` Builds the configured instance.
`CfnHttpApiProps.Builder`	`corsConfiguration(Boolean corsConfiguration)` Sets the value of `CfnHttpApiProps.getCorsConfiguration()`
`CfnHttpApiProps.Builder`	`corsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty corsConfiguration)` Sets the value of `CfnHttpApiProps.getCorsConfiguration()`
`CfnHttpApiProps.Builder`	`corsConfiguration(IResolvable corsConfiguration)` Sets the value of `CfnHttpApiProps.getCorsConfiguration()`
`CfnHttpApiProps.Builder`	`defaultRouteSettings(CfnHttpApi.RouteSettingsProperty defaultRouteSettings)` Sets the value of `CfnHttpApiProps.getDefaultRouteSettings()`
`CfnHttpApiProps.Builder`	`defaultRouteSettings(IResolvable defaultRouteSettings)` Sets the value of `CfnHttpApiProps.getDefaultRouteSettings()`
`CfnHttpApiProps.Builder`	`definitionBody(Object definitionBody)` Sets the value of `CfnHttpApiProps.getDefinitionBody()`
`CfnHttpApiProps.Builder`	`definitionUri(CfnHttpApi.S3LocationProperty definitionUri)` Sets the value of `CfnHttpApiProps.getDefinitionUri()`
`CfnHttpApiProps.Builder`	`definitionUri(IResolvable definitionUri)` Sets the value of `CfnHttpApiProps.getDefinitionUri()`
`CfnHttpApiProps.Builder`	`definitionUri(String definitionUri)` Sets the value of `CfnHttpApiProps.getDefinitionUri()`
`CfnHttpApiProps.Builder`	`description(String description)` Sets the value of `CfnHttpApiProps.getDescription()`
`CfnHttpApiProps.Builder`	`disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)` Sets the value of `CfnHttpApiProps.getDisableExecuteApiEndpoint()`
`CfnHttpApiProps.Builder`	`disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)` Sets the value of `CfnHttpApiProps.getDisableExecuteApiEndpoint()`
`CfnHttpApiProps.Builder`	`domain(CfnHttpApi.HttpApiDomainConfigurationProperty domain)` Sets the value of `CfnHttpApiProps.getDomain()`
`CfnHttpApiProps.Builder`	`domain(IResolvable domain)` Sets the value of `CfnHttpApiProps.getDomain()`
`CfnHttpApiProps.Builder`	`failOnWarnings(Boolean failOnWarnings)` Sets the value of `CfnHttpApiProps.getFailOnWarnings()`
`CfnHttpApiProps.Builder`	`failOnWarnings(IResolvable failOnWarnings)` Sets the value of `CfnHttpApiProps.getFailOnWarnings()`
`CfnHttpApiProps.Builder`	`routeSettings(CfnHttpApi.RouteSettingsProperty routeSettings)` Sets the value of `CfnHttpApiProps.getRouteSettings()`
`CfnHttpApiProps.Builder`	`routeSettings(IResolvable routeSettings)` Sets the value of `CfnHttpApiProps.getRouteSettings()`
`CfnHttpApiProps.Builder`	`stageName(String stageName)` Sets the value of `CfnHttpApiProps.getStageName()`
`CfnHttpApiProps.Builder`	`stageVariables(IResolvable stageVariables)` Sets the value of `CfnHttpApiProps.getStageVariables()`
`CfnHttpApiProps.Builder`	`stageVariables(Map<String,String> stageVariables)` Sets the value of `CfnHttpApiProps.getStageVariables()`
`CfnHttpApiProps.Builder`	`tags(Map<String,String> tags)` Sets the value of `CfnHttpApiProps.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
  - accessLogSetting
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder accessLogSetting(CfnHttpApi.AccessLogSettingProperty accessLogSetting)
```
    Sets the value of CfnHttpApiProps.getAccessLogSetting()
    
    Parameters:
    
    accessLogSetting - `AWS::Serverless::HttpApi.AccessLogSetting`.
    
    Returns:
    
    this
  - accessLogSetting
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder accessLogSetting(IResolvable accessLogSetting)
```
    Sets the value of CfnHttpApiProps.getAccessLogSetting()
    
    Parameters:
    
    accessLogSetting - `AWS::Serverless::HttpApi.AccessLogSetting`.
    
    Returns:
    
    this
  - auth
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder auth(CfnHttpApi.HttpApiAuthProperty auth)
```
    Sets the value of CfnHttpApiProps.getAuth()
    
    Parameters:
    
    auth - `AWS::Serverless::HttpApi.Auth`.
    
    Returns:
    
    this
  - auth
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder auth(IResolvable auth)
```
    Sets the value of CfnHttpApiProps.getAuth()
    
    Parameters:
    
    auth - `AWS::Serverless::HttpApi.Auth`.
    
    Returns:
    
    this
  - corsConfiguration
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder corsConfiguration(Boolean corsConfiguration)
```
    Sets the value of CfnHttpApiProps.getCorsConfiguration()
    
    Parameters:
    
    corsConfiguration - `AWS::Serverless::HttpApi.CorsConfiguration`.
    
    Returns:
    
    this
  - corsConfiguration
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder corsConfiguration(CfnHttpApi.CorsConfigurationObjectProperty corsConfiguration)
```
    Sets the value of CfnHttpApiProps.getCorsConfiguration()
    
    Parameters:
    
    corsConfiguration - `AWS::Serverless::HttpApi.CorsConfiguration`.
    
    Returns:
    
    this
  - corsConfiguration
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder corsConfiguration(IResolvable corsConfiguration)
```
    Sets the value of CfnHttpApiProps.getCorsConfiguration()
    
    Parameters:
    
    corsConfiguration - `AWS::Serverless::HttpApi.CorsConfiguration`.
    
    Returns:
    
    this
  - defaultRouteSettings
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder defaultRouteSettings(CfnHttpApi.RouteSettingsProperty defaultRouteSettings)
```
    Sets the value of CfnHttpApiProps.getDefaultRouteSettings()
    
    Parameters:
    
    defaultRouteSettings - `AWS::Serverless::HttpApi.DefaultRouteSettings`.
    
    Returns:
    
    this
  - defaultRouteSettings
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder defaultRouteSettings(IResolvable defaultRouteSettings)
```
    Sets the value of CfnHttpApiProps.getDefaultRouteSettings()
    
    Parameters:
    
    defaultRouteSettings - `AWS::Serverless::HttpApi.DefaultRouteSettings`.
    
    Returns:
    
    this
  - definitionBody
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder definitionBody(Object definitionBody)
```
    Sets the value of CfnHttpApiProps.getDefinitionBody()
    
    Parameters:
    
    definitionBody - `AWS::Serverless::HttpApi.DefinitionBody`.
    
    Returns:
    
    this
  - definitionUri
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder definitionUri(String definitionUri)
```
    Sets the value of CfnHttpApiProps.getDefinitionUri()
    
    Parameters:
    
    definitionUri - `AWS::Serverless::HttpApi.DefinitionUri`.
    
    Returns:
    
    this
  - definitionUri
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder definitionUri(CfnHttpApi.S3LocationProperty definitionUri)
```
    Sets the value of CfnHttpApiProps.getDefinitionUri()
    
    Parameters:
    
    definitionUri - `AWS::Serverless::HttpApi.DefinitionUri`.
    
    Returns:
    
    this
  - definitionUri
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder definitionUri(IResolvable definitionUri)
```
    Sets the value of CfnHttpApiProps.getDefinitionUri()
    
    Parameters:
    
    definitionUri - `AWS::Serverless::HttpApi.DefinitionUri`.
    
    Returns:
    
    this
  - description
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder description(String description)
```
    Sets the value of CfnHttpApiProps.getDescription()
    
    Parameters:
    
    description - `AWS::Serverless::HttpApi.Description`.
    
    Returns:
    
    this
  - disableExecuteApiEndpoint
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
```
    Sets the value of CfnHttpApiProps.getDisableExecuteApiEndpoint()
    
    Parameters:
    
    disableExecuteApiEndpoint - `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
    
    Returns:
    
    this
  - disableExecuteApiEndpoint
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
```
    Sets the value of CfnHttpApiProps.getDisableExecuteApiEndpoint()
    
    Parameters:
    
    disableExecuteApiEndpoint - `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
    
    Returns:
    
    this
  - domain
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder domain(CfnHttpApi.HttpApiDomainConfigurationProperty domain)
```
    Sets the value of CfnHttpApiProps.getDomain()
    
    Parameters:
    
    domain - `AWS::Serverless::HttpApi.Domain`.
    
    Returns:
    
    this
  - domain
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder domain(IResolvable domain)
```
    Sets the value of CfnHttpApiProps.getDomain()
    
    Parameters:
    
    domain - `AWS::Serverless::HttpApi.Domain`.
    
    Returns:
    
    this
  - failOnWarnings
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder failOnWarnings(Boolean failOnWarnings)
```
    Sets the value of CfnHttpApiProps.getFailOnWarnings()
    
    Parameters:
    
    failOnWarnings - `AWS::Serverless::HttpApi.FailOnWarnings`.
    
    Returns:
    
    this
  - failOnWarnings
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder failOnWarnings(IResolvable failOnWarnings)
```
    Sets the value of CfnHttpApiProps.getFailOnWarnings()
    
    Parameters:
    
    failOnWarnings - `AWS::Serverless::HttpApi.FailOnWarnings`.
    
    Returns:
    
    this
  - routeSettings
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder routeSettings(CfnHttpApi.RouteSettingsProperty routeSettings)
```
    Sets the value of CfnHttpApiProps.getRouteSettings()
    
    Parameters:
    
    routeSettings - `AWS::Serverless::HttpApi.RouteSettings`.
    
    Returns:
    
    this
  - routeSettings
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder routeSettings(IResolvable routeSettings)
```
    Sets the value of CfnHttpApiProps.getRouteSettings()
    
    Parameters:
    
    routeSettings - `AWS::Serverless::HttpApi.RouteSettings`.
    
    Returns:
    
    this
  - stageName
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder stageName(String stageName)
```
    Sets the value of CfnHttpApiProps.getStageName()
    
    Parameters:
    
    stageName - `AWS::Serverless::HttpApi.StageName`.
    
    Returns:
    
    this
  - stageVariables
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder stageVariables(IResolvable stageVariables)
```
    Sets the value of CfnHttpApiProps.getStageVariables()
    
    Parameters:
    
    stageVariables - `AWS::Serverless::HttpApi.StageVariables`.
    
    Returns:
    
    this
  - stageVariables
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder stageVariables(Map<String,String> stageVariables)
```
    Sets the value of CfnHttpApiProps.getStageVariables()
    
    Parameters:
    
    stageVariables - `AWS::Serverless::HttpApi.StageVariables`.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnHttpApiProps.Builder tags(Map<String,String> tags)
```
    Sets the value of CfnHttpApiProps.getTags()
    
    Parameters:
    
    tags - `AWS::Serverless::HttpApi.Tags`.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnHttpApiProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnHttpApiProps>
    
    Returns:
    
    a new instance of CfnHttpApiProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnHttpApiProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

accessLogSetting

accessLogSetting

auth

auth

corsConfiguration

corsConfiguration

corsConfiguration

defaultRouteSettings

defaultRouteSettings

definitionBody

definitionUri

definitionUri

definitionUri

description

disableExecuteApiEndpoint

disableExecuteApiEndpoint

domain

domain

failOnWarnings

failOnWarnings

routeSettings

routeSettings

stageName

stageVariables

stageVariables

tags

build