Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeEnrichmentParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeEnrichmentParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeEnrichmentParametersProperty
extends software.amazon.jsii.JsiiSerializable

The parameters required to set up enrichment on your pipe.

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.pipes.*;
 PipeEnrichmentParametersProperty pipeEnrichmentParametersProperty = PipeEnrichmentParametersProperty.builder()
         .httpParameters(PipeEnrichmentHttpParametersProperty.builder()
                 .headerParameters(Map.of(
                         "headerParametersKey", "headerParameters"))
                 .pathParameterValues(List.of("pathParameterValues"))
                 .queryStringParameters(Map.of(
                         "queryStringParametersKey", "queryStringParameters"))
                 .build())
         .inputTemplate("inputTemplate")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeEnrichmentParametersProperty.Builder	A builder for CfnPipe.PipeEnrichmentParametersProperty
static final class	CfnPipe.PipeEnrichmentParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeEnrichmentParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeEnrichmentParametersProperty.Builder	builder()
default Object	getHttpParameters()	Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
default String	getInputTemplate()	Valid JSON text passed to the enrichment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpParameters

@Stability(Stable)
@Nullable
default Object getHttpParameters()

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

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 Also:

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

getInputTemplate

@Stability(Stable)
@Nullable
default String getInputTemplate()

Valid JSON text passed to the enrichment.

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 Also:

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

builder

@Stability(Stable)
static CfnPipe.PipeEnrichmentParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeEnrichmentParametersProperty.Builder of CfnPipe.PipeEnrichmentParametersProperty