CfnApi.Builder

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

Enclosing class:: CfnApi

public static final class CfnApi.Builder
extends java.lang.Object

A fluent builder for CfnApi.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnApi.Builder`	`accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting)` `AWS::Serverless::Api.AccessLogSetting`.
`CfnApi.Builder`	`accessLogSetting(IResolvable accessLogSetting)` `AWS::Serverless::Api.AccessLogSetting`.
`CfnApi.Builder`	`auth(CfnApi.AuthProperty auth)` `AWS::Serverless::Api.Auth`.
`CfnApi.Builder`	`auth(IResolvable auth)` `AWS::Serverless::Api.Auth`.
`CfnApi.Builder`	`binaryMediaTypes(java.util.List<java.lang.String> binaryMediaTypes)` `AWS::Serverless::Api.BinaryMediaTypes`.
`CfnApi`	`build()`
`CfnApi.Builder`	`cacheClusterEnabled(java.lang.Boolean cacheClusterEnabled)` `AWS::Serverless::Api.CacheClusterEnabled`.
`CfnApi.Builder`	`cacheClusterEnabled(IResolvable cacheClusterEnabled)` `AWS::Serverless::Api.CacheClusterEnabled`.
`CfnApi.Builder`	`cacheClusterSize(java.lang.String cacheClusterSize)` `AWS::Serverless::Api.CacheClusterSize`.
`CfnApi.Builder`	`canarySetting(CfnApi.CanarySettingProperty canarySetting)` `AWS::Serverless::Api.CanarySetting`.
`CfnApi.Builder`	`canarySetting(IResolvable canarySetting)` `AWS::Serverless::Api.CanarySetting`.
`CfnApi.Builder`	`cors(CfnApi.CorsConfigurationProperty cors)` `AWS::Serverless::Api.Cors`.
`CfnApi.Builder`	`cors(IResolvable cors)` `AWS::Serverless::Api.Cors`.
`CfnApi.Builder`	`cors(java.lang.String cors)` `AWS::Serverless::Api.Cors`.
`static CfnApi.Builder`	`create(Construct scope, java.lang.String id)`
`CfnApi.Builder`	`definitionBody(java.lang.Object definitionBody)` `AWS::Serverless::Api.DefinitionBody`.
`CfnApi.Builder`	`definitionUri(CfnApi.S3LocationProperty definitionUri)` `AWS::Serverless::Api.DefinitionUri`.
`CfnApi.Builder`	`definitionUri(IResolvable definitionUri)` `AWS::Serverless::Api.DefinitionUri`.
`CfnApi.Builder`	`definitionUri(java.lang.String definitionUri)` `AWS::Serverless::Api.DefinitionUri`.
`CfnApi.Builder`	`description(java.lang.String description)` `AWS::Serverless::Api.Description`.
`CfnApi.Builder`	`disableExecuteApiEndpoint(java.lang.Boolean disableExecuteApiEndpoint)` `AWS::Serverless::Api.DisableExecuteApiEndpoint`.
`CfnApi.Builder`	`disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)` `AWS::Serverless::Api.DisableExecuteApiEndpoint`.
`CfnApi.Builder`	`domain(CfnApi.DomainConfigurationProperty domain)` `AWS::Serverless::Api.Domain`.
`CfnApi.Builder`	`domain(IResolvable domain)` `AWS::Serverless::Api.Domain`.
`CfnApi.Builder`	`endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration)` `AWS::Serverless::Api.EndpointConfiguration`.
`CfnApi.Builder`	`endpointConfiguration(IResolvable endpointConfiguration)` `AWS::Serverless::Api.EndpointConfiguration`.
`CfnApi.Builder`	`endpointConfiguration(java.lang.String endpointConfiguration)` `AWS::Serverless::Api.EndpointConfiguration`.
`CfnApi.Builder`	`gatewayResponses(java.lang.Object gatewayResponses)` `AWS::Serverless::Api.GatewayResponses`.
`CfnApi.Builder`	`methodSettings(IResolvable methodSettings)` `AWS::Serverless::Api.MethodSettings`.
`CfnApi.Builder`	`methodSettings(java.util.List<? extends java.lang.Object> methodSettings)` `AWS::Serverless::Api.MethodSettings`.
`CfnApi.Builder`	`minimumCompressionSize(java.lang.Number minimumCompressionSize)` `AWS::Serverless::Api.MinimumCompressionSize`.
`CfnApi.Builder`	`models(java.lang.Object models)` `AWS::Serverless::Api.Models`.
`CfnApi.Builder`	`name(java.lang.String name)` `AWS::Serverless::Api.Name`.
`CfnApi.Builder`	`openApiVersion(java.lang.String openApiVersion)` `AWS::Serverless::Api.OpenApiVersion`.
`CfnApi.Builder`	`stageName(java.lang.String stageName)` `AWS::Serverless::Api.StageName`.
`CfnApi.Builder`	`tags(java.util.Map<java.lang.String,java.lang.String> tags)` `AWS::Serverless::Api.Tags`.
`CfnApi.Builder`	`tracingEnabled(java.lang.Boolean tracingEnabled)` `AWS::Serverless::Api.TracingEnabled`.
`CfnApi.Builder`	`tracingEnabled(IResolvable tracingEnabled)` `AWS::Serverless::Api.TracingEnabled`.
`CfnApi.Builder`	`variables(IResolvable variables)` `AWS::Serverless::Api.Variables`.
`CfnApi.Builder`	`variables(java.util.Map<java.lang.String,java.lang.String> variables)` `AWS::Serverless::Api.Variables`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static CfnApi.Builder create(Construct scope,
                                    java.lang.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.AccessLogSettingProperty.Builder.
  - stageName
```
public CfnApi.Builder stageName(java.lang.String stageName)
```
    `AWS::Serverless::Api.StageName`.
    
    Parameters:
    
    stageName - `AWS::Serverless::Api.StageName`. This parameter is required.
    
    Returns:
    
    this
  - accessLogSetting
```
public CfnApi.Builder accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting)
```
    `AWS::Serverless::Api.AccessLogSetting`.
    
    Parameters:
    
    accessLogSetting - `AWS::Serverless::Api.AccessLogSetting`. This parameter is required.
    
    Returns:
    
    this
  - accessLogSetting
```
public CfnApi.Builder accessLogSetting(IResolvable accessLogSetting)
```
    `AWS::Serverless::Api.AccessLogSetting`.
    
    Parameters:
    
    accessLogSetting - `AWS::Serverless::Api.AccessLogSetting`. This parameter is required.
    
    Returns:
    
    this
  - auth
```
public CfnApi.Builder auth(IResolvable auth)
```
    `AWS::Serverless::Api.Auth`.
    
    Parameters:
    
    auth - `AWS::Serverless::Api.Auth`. This parameter is required.
    
    Returns:
    
    this
  - auth
```
public CfnApi.Builder auth(CfnApi.AuthProperty auth)
```
    `AWS::Serverless::Api.Auth`.
    
    Parameters:
    
    auth - `AWS::Serverless::Api.Auth`. This parameter is required.
    
    Returns:
    
    this
  - binaryMediaTypes
```
public CfnApi.Builder binaryMediaTypes(java.util.List<java.lang.String> binaryMediaTypes)
```
    `AWS::Serverless::Api.BinaryMediaTypes`.
    
    Parameters:
    
    binaryMediaTypes - `AWS::Serverless::Api.BinaryMediaTypes`. This parameter is required.
    
    Returns:
    
    this
  - cacheClusterEnabled
```
public CfnApi.Builder cacheClusterEnabled(java.lang.Boolean cacheClusterEnabled)
```
    `AWS::Serverless::Api.CacheClusterEnabled`.
    
    Parameters:
    
    cacheClusterEnabled - `AWS::Serverless::Api.CacheClusterEnabled`. This parameter is required.
    
    Returns:
    
    this
  - cacheClusterEnabled
```
public CfnApi.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled)
```
    `AWS::Serverless::Api.CacheClusterEnabled`.
    
    Parameters:
    
    cacheClusterEnabled - `AWS::Serverless::Api.CacheClusterEnabled`. This parameter is required.
    
    Returns:
    
    this
  - cacheClusterSize
```
public CfnApi.Builder cacheClusterSize(java.lang.String cacheClusterSize)
```
    `AWS::Serverless::Api.CacheClusterSize`.
    
    Parameters:
    
    cacheClusterSize - `AWS::Serverless::Api.CacheClusterSize`. This parameter is required.
    
    Returns:
    
    this
  - canarySetting
```
public CfnApi.Builder canarySetting(IResolvable canarySetting)
```
    `AWS::Serverless::Api.CanarySetting`.
    
    Parameters:
    
    canarySetting - `AWS::Serverless::Api.CanarySetting`. This parameter is required.
    
    Returns:
    
    this
  - canarySetting
```
public CfnApi.Builder canarySetting(CfnApi.CanarySettingProperty canarySetting)
```
    `AWS::Serverless::Api.CanarySetting`.
    
    Parameters:
    
    canarySetting - `AWS::Serverless::Api.CanarySetting`. This parameter is required.
    
    Returns:
    
    this
  - cors
```
public CfnApi.Builder cors(java.lang.String cors)
```
    `AWS::Serverless::Api.Cors`.
    
    Parameters:
    
    cors - `AWS::Serverless::Api.Cors`. This parameter is required.
    
    Returns:
    
    this
  - cors
```
public CfnApi.Builder cors(IResolvable cors)
```
    `AWS::Serverless::Api.Cors`.
    
    Parameters:
    
    cors - `AWS::Serverless::Api.Cors`. This parameter is required.
    
    Returns:
    
    this
  - cors
```
public CfnApi.Builder cors(CfnApi.CorsConfigurationProperty cors)
```
    `AWS::Serverless::Api.Cors`.
    
    Parameters:
    
    cors - `AWS::Serverless::Api.Cors`. This parameter is required.
    
    Returns:
    
    this
  - definitionBody
```
public CfnApi.Builder definitionBody(java.lang.Object definitionBody)
```
    `AWS::Serverless::Api.DefinitionBody`.
    
    Parameters:
    
    definitionBody - `AWS::Serverless::Api.DefinitionBody`. This parameter is required.
    
    Returns:
    
    this
  - definitionUri
```
public CfnApi.Builder definitionUri(java.lang.String definitionUri)
```
    `AWS::Serverless::Api.DefinitionUri`.
    
    Parameters:
    
    definitionUri - `AWS::Serverless::Api.DefinitionUri`. This parameter is required.
    
    Returns:
    
    this
  - definitionUri
```
public CfnApi.Builder definitionUri(IResolvable definitionUri)
```
    `AWS::Serverless::Api.DefinitionUri`.
    
    Parameters:
    
    definitionUri - `AWS::Serverless::Api.DefinitionUri`. This parameter is required.
    
    Returns:
    
    this
  - definitionUri
```
public CfnApi.Builder definitionUri(CfnApi.S3LocationProperty definitionUri)
```
    `AWS::Serverless::Api.DefinitionUri`.
    
    Parameters:
    
    definitionUri - `AWS::Serverless::Api.DefinitionUri`. This parameter is required.
    
    Returns:
    
    this
  - description
```
public CfnApi.Builder description(java.lang.String description)
```
    `AWS::Serverless::Api.Description`.
    
    Parameters:
    
    description - `AWS::Serverless::Api.Description`. This parameter is required.
    
    Returns:
    
    this
  - disableExecuteApiEndpoint
```
public CfnApi.Builder disableExecuteApiEndpoint(java.lang.Boolean disableExecuteApiEndpoint)
```
    `AWS::Serverless::Api.DisableExecuteApiEndpoint`.
    
    Parameters:
    
    disableExecuteApiEndpoint - `AWS::Serverless::Api.DisableExecuteApiEndpoint`. This parameter is required.
    
    Returns:
    
    this
  - disableExecuteApiEndpoint
```
public CfnApi.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
```
    `AWS::Serverless::Api.DisableExecuteApiEndpoint`.
    
    Parameters:
    
    disableExecuteApiEndpoint - `AWS::Serverless::Api.DisableExecuteApiEndpoint`. This parameter is required.
    
    Returns:
    
    this
  - domain
```
public CfnApi.Builder domain(IResolvable domain)
```
    `AWS::Serverless::Api.Domain`.
    
    Parameters:
    
    domain - `AWS::Serverless::Api.Domain`. This parameter is required.
    
    Returns:
    
    this
  - domain
```
public CfnApi.Builder domain(CfnApi.DomainConfigurationProperty domain)
```
    `AWS::Serverless::Api.Domain`.
    
    Parameters:
    
    domain - `AWS::Serverless::Api.Domain`. This parameter is required.
    
    Returns:
    
    this
  - endpointConfiguration
```
public CfnApi.Builder endpointConfiguration(java.lang.String endpointConfiguration)
```
    `AWS::Serverless::Api.EndpointConfiguration`.
    
    Parameters:
    
    endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`. This parameter is required.
    
    Returns:
    
    this
  - endpointConfiguration
```
public CfnApi.Builder endpointConfiguration(IResolvable endpointConfiguration)
```
    `AWS::Serverless::Api.EndpointConfiguration`.
    
    Parameters:
    
    endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`. This parameter is required.
    
    Returns:
    
    this
  - endpointConfiguration
```
public CfnApi.Builder endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration)
```
    `AWS::Serverless::Api.EndpointConfiguration`.
    
    Parameters:
    
    endpointConfiguration - `AWS::Serverless::Api.EndpointConfiguration`. This parameter is required.
    
    Returns:
    
    this
  - gatewayResponses
```
public CfnApi.Builder gatewayResponses(java.lang.Object gatewayResponses)
```
    `AWS::Serverless::Api.GatewayResponses`.
    
    Parameters:
    
    gatewayResponses - `AWS::Serverless::Api.GatewayResponses`. This parameter is required.
    
    Returns:
    
    this
  - methodSettings
```
public CfnApi.Builder methodSettings(java.util.List<? extends java.lang.Object> methodSettings)
```
    `AWS::Serverless::Api.MethodSettings`.
    
    Parameters:
    
    methodSettings - `AWS::Serverless::Api.MethodSettings`. This parameter is required.
    
    Returns:
    
    this
  - methodSettings
```
public CfnApi.Builder methodSettings(IResolvable methodSettings)
```
    `AWS::Serverless::Api.MethodSettings`.
    
    Parameters:
    
    methodSettings - `AWS::Serverless::Api.MethodSettings`. This parameter is required.
    
    Returns:
    
    this
  - minimumCompressionSize
```
public CfnApi.Builder minimumCompressionSize(java.lang.Number minimumCompressionSize)
```
    `AWS::Serverless::Api.MinimumCompressionSize`.
    
    Parameters:
    
    minimumCompressionSize - `AWS::Serverless::Api.MinimumCompressionSize`. This parameter is required.
    
    Returns:
    
    this
  - models
```
public CfnApi.Builder models(java.lang.Object models)
```
    `AWS::Serverless::Api.Models`.
    
    Parameters:
    
    models - `AWS::Serverless::Api.Models`. This parameter is required.
    
    Returns:
    
    this
  - name
```
public CfnApi.Builder name(java.lang.String name)
```
    `AWS::Serverless::Api.Name`.
    
    Parameters:
    
    name - `AWS::Serverless::Api.Name`. This parameter is required.
    
    Returns:
    
    this
  - openApiVersion
```
public CfnApi.Builder openApiVersion(java.lang.String openApiVersion)
```
    `AWS::Serverless::Api.OpenApiVersion`.
    
    Parameters:
    
    openApiVersion - `AWS::Serverless::Api.OpenApiVersion`. This parameter is required.
    
    Returns:
    
    this
  - tags
```
public CfnApi.Builder tags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    `AWS::Serverless::Api.Tags`.
    
    Parameters:
    
    tags - `AWS::Serverless::Api.Tags`. This parameter is required.
    
    Returns:
    
    this
  - tracingEnabled
```
public CfnApi.Builder tracingEnabled(java.lang.Boolean tracingEnabled)
```
    `AWS::Serverless::Api.TracingEnabled`.
    
    Parameters:
    
    tracingEnabled - `AWS::Serverless::Api.TracingEnabled`. This parameter is required.
    
    Returns:
    
    this
  - tracingEnabled
```
public CfnApi.Builder tracingEnabled(IResolvable tracingEnabled)
```
    `AWS::Serverless::Api.TracingEnabled`.
    
    Parameters:
    
    tracingEnabled - `AWS::Serverless::Api.TracingEnabled`. This parameter is required.
    
    Returns:
    
    this
  - variables
```
public CfnApi.Builder variables(IResolvable variables)
```
    `AWS::Serverless::Api.Variables`.
    
    Parameters:
    
    variables - `AWS::Serverless::Api.Variables`. This parameter is required.
    
    Returns:
    
    this
  - variables
```
public CfnApi.Builder variables(java.util.Map<java.lang.String,java.lang.String> variables)
```
    `AWS::Serverless::Api.Variables`.
    
    Parameters:
    
    variables - `AWS::Serverless::Api.Variables`. This parameter is required.
    
    Returns:
    
    this
  - build
```
public CfnApi build()
```

Class CfnApi.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

stageName

accessLogSetting

accessLogSetting

auth

auth

binaryMediaTypes

cacheClusterEnabled

cacheClusterEnabled

cacheClusterSize

canarySetting

canarySetting

cors

cors

cors

definitionBody

definitionUri

definitionUri

definitionUri

description

disableExecuteApiEndpoint

disableExecuteApiEndpoint

domain

domain

endpointConfiguration

endpointConfiguration

endpointConfiguration

gatewayResponses

methodSettings

methodSettings

minimumCompressionSize

models

name

openApiVersion

tags

tracingEnabled

tracingEnabled

variables

variables

build