Package software.amazon.smithy.aws.apigateway.openapi

Class ApiGatewayConfig

java.lang.Object

software.amazon.smithy.aws.apigateway.openapi.ApiGatewayConfig

public final class ApiGatewayConfig
extends Object

API Gateway OpenAPI configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiGatewayConfig.ApiType	The type of API Gateway service to generate.

Constructor Summary

Constructors

Constructor	Description
ApiGatewayConfig()

Method Summary

Modifier and Type	Method	Description
List<String>	getAdditionalAllowedCorsHeaders()	Deprecated. Use getAdditionalAllowedCorsHeadersSet()
Set<String>	getAdditionalAllowedCorsHeadersSet()
ApiGatewayDefaults	getApiGatewayDefaults()
ApiGatewayConfig.ApiType	getApiGatewayType()
boolean	getDisableCloudFormationSubstitution()
void	setAdditionalAllowedCorsHeaders(Collection<String> additionalAllowedCorsHeaders)	Sets the additional allowed CORS headers.
void	setApiGatewayDefaults(ApiGatewayDefaults apiGatewayDefaults)
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 Details

ApiGatewayConfig

public ApiGatewayConfig()

Method Details

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.

getAdditionalAllowedCorsHeaders

@Deprecated
public List<String> getAdditionalAllowedCorsHeaders()

Deprecated.

Use getAdditionalAllowedCorsHeadersSet()

getAdditionalAllowedCorsHeadersSet

public Set<String> getAdditionalAllowedCorsHeadersSet()

Returns:

the set of additional allowed CORS headers.

setAdditionalAllowedCorsHeaders

public void setAdditionalAllowedCorsHeaders(Collection<String> additionalAllowedCorsHeaders)

Sets the additional allowed CORS headers.

Parameters:

additionalAllowedCorsHeaders - additional cors headers to be allowed.

getApiGatewayDefaults

public ApiGatewayDefaults getApiGatewayDefaults()

setApiGatewayDefaults

public void setApiGatewayDefaults(ApiGatewayDefaults apiGatewayDefaults)