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

Interface CfnGatewayResponseMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayResponseMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.460Z")
@Stability(Stable)
public interface CfnGatewayResponseMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnGatewayResponsePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigateway.*;
 CfnGatewayResponseMixinProps cfnGatewayResponseMixinProps = CfnGatewayResponseMixinProps.builder()
         .responseParameters(Map.of(
                 "responseParametersKey", "responseParameters"))
         .responseTemplates(Map.of(
                 "responseTemplatesKey", "responseTemplates"))
         .responseType("responseType")
         .restApiId("restApiId")
         .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	CfnGatewayResponseMixinProps.Builder	A builder for CfnGatewayResponseMixinProps
static final class	CfnGatewayResponseMixinProps.Jsii$Proxy	An implementation for CfnGatewayResponseMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnGatewayResponseMixinProps.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.
default String	getResponseType()	The response type of the associated GatewayResponse.
default Object	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

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

getResponseType

@Stability(Stable)
@Nullable
default 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)
@Nullable
default Object getRestApiId()

The string identifier of the associated RestApi.

Returns union: either String or IRestApiRef

See Also:

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

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 CfnGatewayResponseMixinProps.Builder builder()

Returns:

a CfnGatewayResponseMixinProps.Builder of CfnGatewayResponseMixinProps