Package software.amazon.awscdk.services.apigateway

Class GatewayResponseProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.GatewayResponseProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GatewayResponseProps>

Enclosing interface:

GatewayResponseProps

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

A builder for GatewayResponseProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GatewayResponseProps	build()	Builds the configured instance.
GatewayResponseProps.Builder	responseHeaders(Map<String,String> responseHeaders)	Sets the value of GatewayResponseOptions.getResponseHeaders()
GatewayResponseProps.Builder	restApi(IRestApi restApi)	Sets the value of GatewayResponseProps.getRestApi()
GatewayResponseProps.Builder	statusCode(String statusCode)	Sets the value of GatewayResponseOptions.getStatusCode()
GatewayResponseProps.Builder	templates(Map<String,String> templates)	Sets the value of GatewayResponseOptions.getTemplates()
GatewayResponseProps.Builder	type(ResponseType type)	Sets the value of GatewayResponseOptions.getType()

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

restApi

@Stability(Stable)
public GatewayResponseProps.Builder restApi(IRestApi restApi)

Sets the value of GatewayResponseProps.getRestApi()

Parameters:

restApi - Rest api resource to target. This parameter is required.

Returns:

this

type

@Stability(Stable)
public GatewayResponseProps.Builder type(ResponseType type)

Sets the value of GatewayResponseOptions.getType()

Parameters:

type - Response type to associate with gateway response. This parameter is required.

Returns:

this

responseHeaders

@Stability(Stable)
public GatewayResponseProps.Builder responseHeaders(Map<String,String> responseHeaders)

Sets the value of GatewayResponseOptions.getResponseHeaders()

Parameters:

responseHeaders - Custom headers parameters for response.

Returns:

this

statusCode

@Stability(Stable)
public GatewayResponseProps.Builder statusCode(String statusCode)

Sets the value of GatewayResponseOptions.getStatusCode()

Parameters:

statusCode - Http status code for response.

Returns:

this

templates

@Stability(Stable)
public GatewayResponseProps.Builder templates(Map<String,String> templates)

Sets the value of GatewayResponseOptions.getTemplates()

Parameters:

templates - Custom templates to get mapped as response.

Returns:

this

build

@Stability(Stable)
public GatewayResponseProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GatewayResponseProps

Throws:

NullPointerException - if any required attribute was not provided