Package software.amazon.awscdk.services.apigateway

Interface CfnGatewayResponseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayResponseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:33.325Z")
@Stability(Stable)
public interface CfnGatewayResponseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGatewayResponse.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnGatewayResponseProps cfnGatewayResponseProps = CfnGatewayResponseProps.builder()
         .responseType("responseType")
         .restApiId("restApiId")
         // the properties below are optional
         .responseParameters(Map.of(
                 "responseParametersKey", "responseParameters"))
         .responseTemplates(Map.of(
                 "responseTemplatesKey", "responseTemplates"))
         .statusCode("statusCode")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGatewayResponseProps.Builder	A builder for CfnGatewayResponseProps
static final class	CfnGatewayResponseProps.Jsii$Proxy	An implementation for CfnGatewayResponseProps

Method Summary

Modifier and Type	Method	Description
static CfnGatewayResponseProps.Builder	builder()
default Object	getResponseParameters()	Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
default Object	getResponseTemplates()	Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
String	getResponseType()	The response type of the associated GatewayResponse.
String	getRestApiId()	The string identifier of the associated RestApi.
default String	getStatusCode()	The HTTP status code for this GatewayResponse.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResponseType

@Stability(Stable)
@NotNull
String getResponseType()

The response type of the associated GatewayResponse.

See Also:

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

getRestApiId

@Stability(Stable)
@NotNull
String getRestApiId()

The string identifier of the associated RestApi.

See Also:

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

getResponseParameters

@Stability(Stable)
@Nullable
default Object getResponseParameters()

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

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getResponseTemplates

@Stability(Stable)
@Nullable
default Object getResponseTemplates()

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

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getStatusCode

@Stability(Stable)
@Nullable
default String getStatusCode()

The HTTP status code for this GatewayResponse.

See Also:

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

builder

@Stability(Stable)
static CfnGatewayResponseProps.Builder builder()

Returns:

a CfnGatewayResponseProps.Builder of CfnGatewayResponseProps