Package 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(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	Description
CfnGatewayResponse	build()
static CfnGatewayResponse.Builder	create(software.constructs.Construct scope, String id)
CfnGatewayResponse.Builder	responseParameters(Map<String,String> responseParameters)	Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
CfnGatewayResponse.Builder	responseParameters(IResolvable responseParameters)	Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
CfnGatewayResponse.Builder	responseTemplates(Map<String,String> responseTemplates)	Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
CfnGatewayResponse.Builder	responseTemplates(IResolvable responseTemplates)	Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
CfnGatewayResponse.Builder	responseType(String responseType)	The response type of the associated GatewayResponse.
CfnGatewayResponse.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnGatewayResponse.Builder	restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnGatewayResponse.Builder	statusCode(String statusCode)	The HTTP status code for this GatewayResponse.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGatewayResponse.Builder.

responseType

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

The response type of the associated GatewayResponse.

Parameters:

responseType - The response type of the associated GatewayResponse. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype

restApiId

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

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid

restApiId

@Stability(Stable)
public CfnGatewayResponse.Builder restApiId(IRestApiRef restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid

responseParameters

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

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

Parameters:

responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters

responseParameters

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

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

Parameters:

responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters

responseTemplates

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

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

Parameters:

responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates

responseTemplates

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

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

Parameters:

responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates

statusCode

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

The HTTP status code for this GatewayResponse.

Parameters:

statusCode - The HTTP status code for this GatewayResponse. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode

build

@Stability(Stable)
public CfnGatewayResponse build()

Specified by:

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

Returns:

a newly built instance of CfnGatewayResponse.