software.amazon.awscdk.services.apigatewayv2

Interface CfnIntegration.ResponseParameterListProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegration.ResponseParameterListProperty.Jsii$Proxy

Enclosing class:

CfnIntegration

@Stability(value=Stable)
public static interface CfnIntegration.ResponseParameterListProperty
extends software.amazon.jsii.JsiiSerializable

Specifies a list of response parameters for an HTTP API.

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.apigatewayv2.*;
 ResponseParameterListProperty responseParameterListProperty = ResponseParameterListProperty.builder()
         .responseParameters(List.of(ResponseParameterProperty.builder()
                 .destination("destination")
                 .source("source")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnIntegration.ResponseParameterListProperty.Builder	builder()
default Object	getResponseParameters() Supported only for HTTP APIs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getResponseParameters

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

Supported only for HTTP APIs.

You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match the pattern <action>:<header>.<location> or overwrite.statuscode . The action can be append , overwrite or remove . The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

builder

@Stability(value=Stable)
static CfnIntegration.ResponseParameterListProperty.Builder builder()

Returns:

a CfnIntegration.ResponseParameterListProperty.Builder of CfnIntegration.ResponseParameterListProperty