ApiGatewayConfig (Smithy API 1.0.6)

java.lang.Object
- software.amazon.smithy.aws.apigateway.openapi.ApiGatewayConfig

public final class ApiGatewayConfig
extends java.lang.Object

API Gateway OpenAPI configuration.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ApiGatewayConfig.ApiType
The type of API Gateway service to generate.

Constructor Summary

Constructors
Constructor Description

ApiGatewayConfig()

Method Summary

Modifier and Type	Method	Description
`ApiGatewayConfig.ApiType`	`getApiGatewayType()`
`boolean`	`getDisableCloudFormationSubstitution()`
`void`	`setApiGatewayType(ApiGatewayConfig.ApiType apiGatewayType)`	Sets the type of API Gateway API to generate.
`void`	`setDisableCloudFormationSubstitution(boolean disableCloudFormationSubstitution)`	Disables CloudFormation substitutions of specific paths when they contain ${} placeholders.

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

- Constructor Detail
  - ApiGatewayConfig
```
public ApiGatewayConfig()
```
- Method Detail
  - getDisableCloudFormationSubstitution
```
public boolean getDisableCloudFormationSubstitution()
```
    Returns:
    
    Returns true if CloudFormation substitutions are disabled.
  - setDisableCloudFormationSubstitution
```
public void setDisableCloudFormationSubstitution(boolean disableCloudFormationSubstitution)
```
    Disables CloudFormation substitutions of specific paths when they contain ${} placeholders. When found, these are expanded into CloudFormation Fn::Sub intrinsic functions.
    
    Parameters:
    
    disableCloudFormationSubstitution - Set to true to disable intrinsics.
  - getApiGatewayType
```
public ApiGatewayConfig.ApiType getApiGatewayType()
```
    Returns:
    
    the type of API Gateway API to generate.
  - setApiGatewayType
```
public void setApiGatewayType(ApiGatewayConfig.ApiType apiGatewayType)
```
    Sets the type of API Gateway API to generate.
    If not set, this value defaults to a "REST" API.
    
    Parameters:
    
    apiGatewayType - API type to set.