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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.119Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGatewayResponseProps.Builder	builder()
default Object	getResponseParameters() The response parameters (paths, query strings, and headers) for the response.
default Object	getResponseTemplates() The response templates for the response.
String	getResponseType() The response type.
String	getRestApiId() The identifier of the API.
default String	getStatusCode() The HTTP status code for the response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getResponseType

@Stability(value=Stable)
 @NotNull
String getResponseType()

The response type.

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

getRestApiId

@Stability(value=Stable)
 @NotNull
String getRestApiId()

The identifier of the API.

getResponseParameters

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

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

Duplicates not allowed.

getResponseTemplates

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

The response templates for the response.

Duplicates not allowed.

getStatusCode

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

The HTTP status code for the response.

builder

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

Returns:

a CfnGatewayResponseProps.Builder of CfnGatewayResponseProps