Package software.amazon.awscdk.services.apigatewayv2

Class HttpApiProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpApiProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpApiProps>

Enclosing interface:

HttpApiProps

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

A builder for HttpApiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpApiProps.Builder	apiName(String apiName)	Sets the value of HttpApiProps.getApiName()
HttpApiProps	build()	Builds the configured instance.
HttpApiProps.Builder	corsPreflight(CorsPreflightOptions corsPreflight)	Sets the value of HttpApiProps.getCorsPreflight()
HttpApiProps.Builder	createDefaultStage(Boolean createDefaultStage)	Sets the value of HttpApiProps.getCreateDefaultStage()
HttpApiProps.Builder	defaultAuthorizationScopes(List<String> defaultAuthorizationScopes)	Sets the value of HttpApiProps.getDefaultAuthorizationScopes()
HttpApiProps.Builder	defaultAuthorizer(IHttpRouteAuthorizer defaultAuthorizer)	Sets the value of HttpApiProps.getDefaultAuthorizer()
HttpApiProps.Builder	defaultDomainMapping(DomainMappingOptions defaultDomainMapping)	Sets the value of HttpApiProps.getDefaultDomainMapping()
HttpApiProps.Builder	defaultIntegration(HttpRouteIntegration defaultIntegration)	Sets the value of HttpApiProps.getDefaultIntegration()
HttpApiProps.Builder	description(String description)	Sets the value of HttpApiProps.getDescription()
HttpApiProps.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)	Sets the value of HttpApiProps.getDisableExecuteApiEndpoint()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

apiName

@Stability(Stable)
public HttpApiProps.Builder apiName(String apiName)

Sets the value of HttpApiProps.getApiName()

Parameters:

apiName - Name for the HTTP API resource.

Returns:

this

corsPreflight

@Stability(Stable)
public HttpApiProps.Builder corsPreflight(CorsPreflightOptions corsPreflight)

Sets the value of HttpApiProps.getCorsPreflight()

Parameters:

corsPreflight - Specifies a CORS configuration for an API.

Returns:

this

createDefaultStage

@Stability(Stable)
public HttpApiProps.Builder createDefaultStage(Boolean createDefaultStage)

Sets the value of HttpApiProps.getCreateDefaultStage()

Parameters:

createDefaultStage - Whether a default stage and deployment should be automatically created.

Returns:

this

defaultAuthorizationScopes

@Stability(Stable)
public HttpApiProps.Builder defaultAuthorizationScopes(List<String> defaultAuthorizationScopes)

Sets the value of HttpApiProps.getDefaultAuthorizationScopes()

Parameters:

defaultAuthorizationScopes - Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

Returns:

this

defaultAuthorizer

@Stability(Stable)
public HttpApiProps.Builder defaultAuthorizer(IHttpRouteAuthorizer defaultAuthorizer)

Sets the value of HttpApiProps.getDefaultAuthorizer()

Parameters:

defaultAuthorizer - Default Authorizer applied to all routes in the gateway.

Returns:

this

defaultDomainMapping

@Stability(Stable)
public HttpApiProps.Builder defaultDomainMapping(DomainMappingOptions defaultDomainMapping)

Sets the value of HttpApiProps.getDefaultDomainMapping()

Parameters:

defaultDomainMapping - Configure a custom domain with the API mapping resource to the HTTP API.

Returns:

this

defaultIntegration

@Stability(Stable)
public HttpApiProps.Builder defaultIntegration(HttpRouteIntegration defaultIntegration)

Sets the value of HttpApiProps.getDefaultIntegration()

Parameters:

defaultIntegration - An integration that will be configured on the catch-all route ($default).

Returns:

this

description

@Stability(Stable)
public HttpApiProps.Builder description(String description)

Sets the value of HttpApiProps.getDescription()

Parameters:

description - The description of the API.

Returns:

this

disableExecuteApiEndpoint

@Stability(Stable)
public HttpApiProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)

Sets the value of HttpApiProps.getDisableExecuteApiEndpoint()

Parameters:

disableExecuteApiEndpoint - Specifies whether clients can invoke your API using the default endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. Enable this if you would like clients to use your custom domain name.

Returns:

this

build

@Stability(Stable)
public HttpApiProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<HttpApiProps>

Returns:

a new instance of HttpApiProps

Throws:

NullPointerException - if any required attribute was not provided