Interface CfnPipePropsMixin.IPipeEnrichmentParametersProperty

The parameters required to set up enrichment on your pipe.

Namespace: Amazon.CDK.Mixins.Preview.AWS.Pipes.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnPipePropsMixin.IPipeEnrichmentParametersProperty

Syntax (vb)

Public Interface CfnPipePropsMixin.IPipeEnrichmentParametersProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Pipes.Mixins;

             var pipeEnrichmentParametersProperty = new PipeEnrichmentParametersProperty {
                 HttpParameters = new PipeEnrichmentHttpParametersProperty {
                     HeaderParameters = new Dictionary<string, string> {
                         { "headerParametersKey", "headerParameters" }
                     },
                     PathParameterValues = new [] { "pathParameterValues" },
                     QueryStringParameters = new Dictionary<string, string> {
                         { "queryStringParametersKey", "queryStringParameters" }
                     }
                 },
                 InputTemplate = "inputTemplate"
             };

Synopsis

Properties

HttpParameters	Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
InputTemplate	Valid JSON text passed to the enrichment.

Properties

HttpParameters

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

object? HttpParameters { get; }

Property Value

object

Remarks

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html#cfn-pipes-pipe-pipeenrichmentparameters-httpparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeEnrichmentHttpParametersProperty

InputTemplate

Valid JSON text passed to the enrichment.

string? InputTemplate { get; }

Property Value

string

Remarks

In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .

To remove an input template, specify an empty string.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html#cfn-pipes-pipe-pipeenrichmentparameters-inputtemplate