Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnGatewayResponsePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnGatewayResponsePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGatewayResponsePropsMixin>

Enclosing class:

CfnGatewayResponsePropsMixin

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

A fluent builder for CfnGatewayResponsePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnGatewayResponsePropsMixin	build()
static CfnGatewayResponsePropsMixin.Builder	create()
static CfnGatewayResponsePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnGatewayResponsePropsMixin.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.
CfnGatewayResponsePropsMixin.Builder	responseParameters(IResolvable responseParameters)	Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
CfnGatewayResponsePropsMixin.Builder	responseTemplates(Map<String,String> responseTemplates)	Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
CfnGatewayResponsePropsMixin.Builder	responseTemplates(IResolvable responseTemplates)	Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
CfnGatewayResponsePropsMixin.Builder	responseType(String responseType)	The response type of the associated GatewayResponse.
CfnGatewayResponsePropsMixin.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnGatewayResponsePropsMixin.Builder	restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnGatewayResponsePropsMixin.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 CfnGatewayResponsePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnGatewayResponsePropsMixin.Builder.

create

@Stability(Stable)
public static CfnGatewayResponsePropsMixin.Builder create()

Returns:

a new instance of CfnGatewayResponsePropsMixin.Builder.

responseParameters

@Stability(Stable)
public CfnGatewayResponsePropsMixin.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 CfnGatewayResponsePropsMixin.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 CfnGatewayResponsePropsMixin.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 CfnGatewayResponsePropsMixin.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

responseType

@Stability(Stable)
public CfnGatewayResponsePropsMixin.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 CfnGatewayResponsePropsMixin.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 CfnGatewayResponsePropsMixin.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

statusCode

@Stability(Stable)
public CfnGatewayResponsePropsMixin.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 CfnGatewayResponsePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnGatewayResponsePropsMixin.