Class ParameterMapping
(experimental) Represents a Parameter Mapping.
Inheritance
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class ParameterMapping : DeputyBase
Syntax (vb)
Public Class ParameterMapping
Inherits DeputyBase
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.APIGatewayv2.Integrations;
ApplicationLoadBalancer lb;
var listener = lb.AddListener("listener", new BaseApplicationListenerProps { Port = 80 });
listener.AddTargets("target", new AddApplicationTargetsProps {
Port = 80
});
var httpEndpoint = new HttpApi(this, "HttpProxyPrivateApi", new HttpApiProps {
DefaultIntegration = new HttpAlbIntegration("DefaultIntegration", listener, new HttpAlbIntegrationProps {
ParameterMapping = new ParameterMapping().AppendHeader("header2", MappingValue.RequestHeader("header1")).RemoveHeader("header1")
})
});
Synopsis
Constructors
ParameterMapping() | |
ParameterMapping(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
ParameterMapping(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
Mappings | (experimental) Represents all created parameter mappings. |
Methods
AppendHeader(String, MappingValue) | (experimental) Creates a mapping to append a header. |
AppendQueryString(String, MappingValue) | (experimental) Creates a mapping to append a query string. |
Custom(String, String) | (experimental) Creates a custom mapping. |
FromObject(IDictionary<String, MappingValue>) | (experimental) Creates a mapping from an object. |
OverwriteHeader(String, MappingValue) | (experimental) Creates a mapping to overwrite a header. |
OverwritePath(MappingValue) | (experimental) Creates a mapping to overwrite a path. |
OverwriteQueryString(String, MappingValue) | (experimental) Creates a mapping to overwrite a querystring. |
RemoveHeader(String) | (experimental) Creates a mapping to remove a header. |
RemoveQueryString(String) | (experimental) Creates a mapping to remove a querystring. |
Constructors
ParameterMapping()
public ParameterMapping()
Remarks
Stability: Experimental
ParameterMapping(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected ParameterMapping(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
ParameterMapping(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected ParameterMapping(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Mappings
(experimental) Represents all created parameter mappings.
public virtual IDictionary<string, string> Mappings { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Stability: Experimental
Methods
AppendHeader(String, MappingValue)
(experimental) Creates a mapping to append a header.
public virtual ParameterMapping AppendHeader(string name, MappingValue value)
Parameters
- name System.String
- value MappingValue
Returns
Remarks
Stability: Experimental
AppendQueryString(String, MappingValue)
(experimental) Creates a mapping to append a query string.
public virtual ParameterMapping AppendQueryString(string name, MappingValue value)
Parameters
- name System.String
- value MappingValue
Returns
Remarks
Stability: Experimental
Custom(String, String)
(experimental) Creates a custom mapping.
public virtual ParameterMapping Custom(string key, string value)
Parameters
- key System.String
- value System.String
Returns
Remarks
Stability: Experimental
FromObject(IDictionary<String, MappingValue>)
(experimental) Creates a mapping from an object.
public static ParameterMapping FromObject(IDictionary<string, MappingValue> obj)
Parameters
- obj System.Collections.Generic.IDictionary<System.String, MappingValue>
Returns
Remarks
Stability: Experimental
OverwriteHeader(String, MappingValue)
(experimental) Creates a mapping to overwrite a header.
public virtual ParameterMapping OverwriteHeader(string name, MappingValue value)
Parameters
- name System.String
- value MappingValue
Returns
Remarks
Stability: Experimental
OverwritePath(MappingValue)
(experimental) Creates a mapping to overwrite a path.
public virtual ParameterMapping OverwritePath(MappingValue value)
Parameters
- value MappingValue
Returns
Remarks
Stability: Experimental
OverwriteQueryString(String, MappingValue)
(experimental) Creates a mapping to overwrite a querystring.
public virtual ParameterMapping OverwriteQueryString(string name, MappingValue value)
Parameters
- name System.String
- value MappingValue
Returns
Remarks
Stability: Experimental
RemoveHeader(String)
(experimental) Creates a mapping to remove a header.
public virtual ParameterMapping RemoveHeader(string name)
Parameters
- name System.String
Returns
Remarks
Stability: Experimental
RemoveQueryString(String)
(experimental) Creates a mapping to remove a querystring.
public virtual ParameterMapping RemoveQueryString(string name)
Parameters
- name System.String
Returns
Remarks
Stability: Experimental