software.amazon.awscdk.services.apigateway

Class CfnGatewayResponse.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnGatewayResponse.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGatewayResponse>

Enclosing class:

CfnGatewayResponse

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

A fluent builder for CfnGatewayResponse.

Method Summary

Modifier and Type	Method and Description
CfnGatewayResponse	build()
static CfnGatewayResponse.Builder	create(software.constructs.Construct scope, String id)
CfnGatewayResponse.Builder	responseParameters(IResolvable responseParameters) The response parameters (paths, query strings, and headers) for the response.
CfnGatewayResponse.Builder	responseParameters(Map<String,String> responseParameters) The response parameters (paths, query strings, and headers) for the response.
CfnGatewayResponse.Builder	responseTemplates(IResolvable responseTemplates) The response templates for the response.
CfnGatewayResponse.Builder	responseTemplates(Map<String,String> responseTemplates) The response templates for the response.
CfnGatewayResponse.Builder	responseType(String responseType) The response type.
CfnGatewayResponse.Builder	restApiId(String restApiId) The identifier of the API.
CfnGatewayResponse.Builder	statusCode(String statusCode) The HTTP status code for the response.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnGatewayResponse.Builder create(software.constructs.Construct scope,
                                                                         String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnGatewayResponse.Builder.

responseType

@Stability(value=Stable)
public CfnGatewayResponse.Builder responseType(String responseType)

The response type.

For valid values, see GatewayResponse in the API Gateway API Reference .

Parameters:

responseType - The response type. This parameter is required.

Returns:

this

restApiId

@Stability(value=Stable)
public CfnGatewayResponse.Builder restApiId(String restApiId)

The identifier of the API.

Parameters:

restApiId - The identifier of the API. This parameter is required.

Returns:

this

responseParameters

@Stability(value=Stable)
public CfnGatewayResponse.Builder responseParameters(IResolvable responseParameters)

The response parameters (paths, query strings, and headers) for the response.

Duplicates not allowed.

Parameters:

responseParameters - The response parameters (paths, query strings, and headers) for the response. This parameter is required.

Returns:

this

responseParameters

@Stability(value=Stable)
public CfnGatewayResponse.Builder responseParameters(Map<String,String> responseParameters)

The response parameters (paths, query strings, and headers) for the response.

Duplicates not allowed.

Parameters:

responseParameters - The response parameters (paths, query strings, and headers) for the response. This parameter is required.

Returns:

this

responseTemplates

@Stability(value=Stable)
public CfnGatewayResponse.Builder responseTemplates(IResolvable responseTemplates)

The response templates for the response.

Duplicates not allowed.

Parameters:

responseTemplates - The response templates for the response. This parameter is required.

Returns:

this

responseTemplates

@Stability(value=Stable)
public CfnGatewayResponse.Builder responseTemplates(Map<String,String> responseTemplates)

The response templates for the response.

Duplicates not allowed.

Parameters:

responseTemplates - The response templates for the response. This parameter is required.

Returns:

this

statusCode

@Stability(value=Stable)
public CfnGatewayResponse.Builder statusCode(String statusCode)

The HTTP status code for the response.

Parameters:

statusCode - The HTTP status code for the response. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnGatewayResponse build()

Specified by:

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