Package software.amazon.awscdk.services.apigatewayv2

Class CfnApi.CorsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.CfnApi.CorsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApi.CorsProperty>

Enclosing interface:

CfnApi.CorsProperty

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

A builder for CfnApi.CorsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnApi.CorsProperty.Builder	allowCredentials(Boolean allowCredentials)	Sets the value of CfnApi.CorsProperty.getAllowCredentials()
CfnApi.CorsProperty.Builder	allowCredentials(IResolvable allowCredentials)	Sets the value of CfnApi.CorsProperty.getAllowCredentials()
CfnApi.CorsProperty.Builder	allowHeaders(List<String> allowHeaders)	Sets the value of CfnApi.CorsProperty.getAllowHeaders()
CfnApi.CorsProperty.Builder	allowMethods(List<String> allowMethods)	Sets the value of CfnApi.CorsProperty.getAllowMethods()
CfnApi.CorsProperty.Builder	allowOrigins(List<String> allowOrigins)	Sets the value of CfnApi.CorsProperty.getAllowOrigins()
CfnApi.CorsProperty	build()	Builds the configured instance.
CfnApi.CorsProperty.Builder	exposeHeaders(List<String> exposeHeaders)	Sets the value of CfnApi.CorsProperty.getExposeHeaders()
CfnApi.CorsProperty.Builder	maxAge(Number maxAge)	Sets the value of CfnApi.CorsProperty.getMaxAge()

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

allowCredentials

@Stability(Stable)
public CfnApi.CorsProperty.Builder allowCredentials(Boolean allowCredentials)

Sets the value of CfnApi.CorsProperty.getAllowCredentials()

Parameters:

allowCredentials - Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

Returns:

this

allowCredentials

@Stability(Stable)
public CfnApi.CorsProperty.Builder allowCredentials(IResolvable allowCredentials)

Sets the value of CfnApi.CorsProperty.getAllowCredentials()

Parameters:

allowCredentials - Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

Returns:

this

allowHeaders

@Stability(Stable)
public CfnApi.CorsProperty.Builder allowHeaders(List<String> allowHeaders)

Sets the value of CfnApi.CorsProperty.getAllowHeaders()

Parameters:

allowHeaders - Represents a collection of allowed headers. Supported only for HTTP APIs.

Returns:

this

allowMethods

@Stability(Stable)
public CfnApi.CorsProperty.Builder allowMethods(List<String> allowMethods)

Sets the value of CfnApi.CorsProperty.getAllowMethods()

Parameters:

allowMethods - Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

Returns:

this

allowOrigins

@Stability(Stable)
public CfnApi.CorsProperty.Builder allowOrigins(List<String> allowOrigins)

Sets the value of CfnApi.CorsProperty.getAllowOrigins()

Parameters:

allowOrigins - Represents a collection of allowed origins. Supported only for HTTP APIs.

Returns:

this

exposeHeaders

@Stability(Stable)
public CfnApi.CorsProperty.Builder exposeHeaders(List<String> exposeHeaders)

Sets the value of CfnApi.CorsProperty.getExposeHeaders()

Parameters:

exposeHeaders - Represents a collection of exposed headers. Supported only for HTTP APIs.

Returns:

this

maxAge

@Stability(Stable)
public CfnApi.CorsProperty.Builder maxAge(Number maxAge)

Sets the value of CfnApi.CorsProperty.getMaxAge()

Parameters:

maxAge - The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

Returns:

this

build

@Stability(Stable)
public CfnApi.CorsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnApi.CorsProperty>

Returns:

a new instance of CfnApi.CorsProperty

Throws:

NullPointerException - if any required attribute was not provided