@aws-cdk/aws-pipes-enrichments-alpha.ApiGatewayEnrichmentProps

ApiGatewayEnrichmentProps Struct

Properties for a ApiGatewayEnrichment.

Stability

Experimental

Source

lib/api-gateway.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes_alpha from '@aws-cdk/aws-pipes-alpha';
import * as pipes_enrichments_alpha from '@aws-cdk/aws-pipes-enrichments-alpha';

declare const inputTransformation: pipes_alpha.InputTransformation;
const apiGatewayEnrichmentProps: pipes_enrichments_alpha.ApiGatewayEnrichmentProps = {
  headerParameters: {
    headerParametersKey: 'headerParameters',
  },
  inputTransformation: inputTransformation,
  method: 'method',
  path: 'path',
  pathParameterValues: ['pathParameterValues'],
  queryStringParameters: {
    queryStringParametersKey: 'queryStringParameters',
  },
  stage: 'stage',
};

Properties

headerParameters{ [key: string]: string }header_parameterstyping.Mapping[str, str]headerParametersMap<String, String>HeaderParametersIDictionary<string, string>HeaderParameters*map[string]*string= none#

The headers that need to be sent as part of request invoking the API Gateway REST API.

inputTransformationInputTransformationinput_transformationInputTransformationinputTransformationInputTransformationInputTransformationInputTransformationInputTransformationInputTransformation= None#

The input transformation for the enrichment.

methodstringmethodstrmethodStringMethodstringMethod*string= '*' - ANY#

The method for API Gateway resource.

pathstringpathstrpathStringPathstringPath*string= '/'#

The path for the API Gateway resource.

pathParameterValuesstring[]path_parameter_valuestyping.List[str]pathParameterValuesList<String>PathParameterValuesstring[]PathParameterValues*[]*string= none#

The path parameter values used to populate the API Gateway REST API path wildcards ("*").

queryStringParameters{ [key: string]: string }query_string_parameterstyping.Mapping[str, str]queryStringParametersMap<String, String>QueryStringParametersIDictionary<string, string>QueryStringParameters*map[string]*string= none#

The query string keys/values that need to be sent as part of request invoking the EventBridge API destination.

stagestringstagestrstageStringStagestringStage*string= the value of `deploymentStage.st…#

The deployment stage for the API Gateway resource.

default

Default: the value of deploymentStage.stageName of target API Gateway resource.

Used as props by

• ApiGatewayEnrichment