class ParameterMapping

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.ParameterMapping
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#ParameterMapping
Java	software.amazon.awscdk.services.apigatewayv2.ParameterMapping
Python	aws_cdk.aws_apigatewayv2.ParameterMapping
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » ParameterMapping

Represents a Parameter Mapping.

Example

import { HttpAlbIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';

declare const lb: elbv2.ApplicationLoadBalancer;
const listener = lb.addListener('listener', { port: 80 });
listener.addTargets('target', {
  port: 80,
});

const httpEndpoint = new apigwv2.HttpApi(this, 'HttpProxyPrivateApi', {
  defaultIntegration: new HttpAlbIntegration('DefaultIntegration', listener, {
    parameterMapping: new apigwv2.ParameterMapping()
      .appendHeader('header2', apigwv2.MappingValue.requestHeader('header1'))
      .removeHeader('header1'),
  }),
});

Initializer

new ParameterMapping()

Properties

Name	Type	Description
mappings	{ [string]: string }	Represents all created parameter mappings.

---

mappings

Type: { [string]: string }

Represents all created parameter mappings.

Methods

Name	Description
appendHeader(name, value)	Creates a mapping to append a header.
appendQueryString(name, value)	Creates a mapping to append a query string.
custom(key, value)	Creates a custom mapping.
overwriteHeader(name, value)	Creates a mapping to overwrite a header.
overwritePath(value)	Creates a mapping to overwrite a path.
overwriteQueryString(name, value)	Creates a mapping to overwrite a querystring.
removeHeader(name)	Creates a mapping to remove a header.
removeQueryString(name)	Creates a mapping to remove a querystring.
static fromObject(obj)	Creates a mapping from an object.

---

appendHeader(name, value)

public appendHeader(name: string, value: MappingValue): ParameterMapping

Parameters

• name string
• value MappingValue

Returns

• ParameterMapping

Creates a mapping to append a header.

---

appendQueryString(name, value)

public appendQueryString(name: string, value: MappingValue): ParameterMapping

Parameters

• name string
• value MappingValue

Returns

• ParameterMapping

Creates a mapping to append a query string.

---

custom(key, value)

public custom(key: string, value: string): ParameterMapping

Parameters

• key string
• value string

Returns

• ParameterMapping

Creates a custom mapping.

---

overwriteHeader(name, value)

public overwriteHeader(name: string, value: MappingValue): ParameterMapping

Parameters

• name string
• value MappingValue

Returns

• ParameterMapping

Creates a mapping to overwrite a header.

---

overwritePath(value)

public overwritePath(value: MappingValue): ParameterMapping

Parameters

• value MappingValue

Returns

• ParameterMapping

Creates a mapping to overwrite a path.

---

overwriteQueryString(name, value)

public overwriteQueryString(name: string, value: MappingValue): ParameterMapping

Parameters

• name string
• value MappingValue

Returns

• ParameterMapping

Creates a mapping to overwrite a querystring.

---

removeHeader(name)

public removeHeader(name: string): ParameterMapping

Parameters

• name string

Returns

• ParameterMapping

Creates a mapping to remove a header.

---

removeQueryString(name)

public removeQueryString(name: string): ParameterMapping

Parameters

• name string

Returns

• ParameterMapping

Creates a mapping to remove a querystring.

---

static fromObject(obj)

public static fromObject(obj: { [string]: MappingValue }): ParameterMapping

Parameters

• obj { [string]: MappingValue }

Returns

• ParameterMapping

Creates a mapping from an object.