software.amazon.awscdk.services.apigatewayv2

Class MappingValue

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.MappingValue

All Implemented Interfaces:

IMappingValue

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:56.746Z")
public class MappingValue
extends software.amazon.jsii.JsiiObject
implements IMappingValue

(experimental) Represents a Mapping Value.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpAlbIntegration;
 ApplicationLoadBalancer lb;
 ApplicationListener listener = lb.addListener("listener", BaseApplicationListenerProps.builder().port(80).build());
 listener.addTargets("target", AddApplicationTargetsProps.builder()
         .port(80)
         .build());
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(HttpAlbIntegration.Builder.create("DefaultIntegration", listener)
                 .parameterMapping(new ParameterMapping().appendHeader("header2", MappingValue.requestHeader("header1")).removeHeader("header1"))
                 .build())
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IMappingValue

IMappingValue.Jsii$Default, IMappingValue.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field and Description
static MappingValue	NONE (experimental) Creates an empty mapping value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MappingValue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	MappingValue(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static MappingValue	contextVariable(java.lang.String variableName) (experimental) Creates a context variable mapping value.
static MappingValue	custom(java.lang.String value) (experimental) Creates a custom mapping value.
java.lang.String	getValue() (experimental) Represents a Mapping Value.
static MappingValue	requestBody(java.lang.String name) (experimental) Creates a request body mapping value.
static MappingValue	requestHeader(java.lang.String name) (experimental) Creates a header mapping value.
static MappingValue	requestPath() (experimental) Creates a request path mapping value.
static MappingValue	requestPathParam(java.lang.String name) (experimental) Creates a request path parameter mapping value.
static MappingValue	requestQueryString(java.lang.String name) (experimental) Creates a query string mapping value.
static MappingValue	stageVariable(java.lang.String variableName) (experimental) Creates a stage variable mapping value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final MappingValue NONE

(experimental) Creates an empty mapping value.

Constructor Detail

MappingValue

protected MappingValue(software.amazon.jsii.JsiiObjectRef objRef)

MappingValue

protected MappingValue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

contextVariable

public static MappingValue contextVariable(java.lang.String variableName)

(experimental) Creates a context variable mapping value.

Parameters:

variableName - This parameter is required.

custom

public static MappingValue custom(java.lang.String value)

(experimental) Creates a custom mapping value.

Parameters:

value - This parameter is required.

requestBody

public static MappingValue requestBody(java.lang.String name)

(experimental) Creates a request body mapping value.

Parameters:

name - This parameter is required.

requestHeader

public static MappingValue requestHeader(java.lang.String name)

(experimental) Creates a header mapping value.

Parameters:

name - This parameter is required.

requestPath

public static MappingValue requestPath()

(experimental) Creates a request path mapping value.

requestPathParam

public static MappingValue requestPathParam(java.lang.String name)

(experimental) Creates a request path parameter mapping value.

Parameters:

name - This parameter is required.

requestQueryString

public static MappingValue requestQueryString(java.lang.String name)

(experimental) Creates a query string mapping value.

Parameters:

name - This parameter is required.

stageVariable

public static MappingValue stageVariable(java.lang.String variableName)

(experimental) Creates a stage variable mapping value.

Parameters:

variableName - This parameter is required.

getValue

public java.lang.String getValue()

(experimental) Represents a Mapping Value.

Specified by:

getValue in interface IMappingValue