software.amazon.awscdk.services.apigatewayv2

Interface CfnIntegration.ResponseParameterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegration.ResponseParameterProperty.Jsii$Proxy

Enclosing class:

CfnIntegration

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

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 .

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.*;
 ResponseParameterProperty responseParameterProperty = ResponseParameterProperty.builder()
         .destination("destination")
         .source("source")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnIntegration.ResponseParameterProperty.Builder	builder()
String	getDestination() Specifies the location of the response to modify, and how to modify it.
String	getSource() Specifies the data to update the parameter with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDestination

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

Specifies the location of the response to modify, and how to modify it.

To learn more, see Transforming API requests and responses .

getSource

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

Specifies the data to update the parameter with.

To learn more, see Transforming API requests and responses .

builder

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

Returns:

a CfnIntegration.ResponseParameterProperty.Builder of CfnIntegration.ResponseParameterProperty