interface ApiGatewayEnrichmentProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pipes.Enrichments.Alpha.ApiGatewayEnrichmentProps |
![]() | github.com/aws/aws-cdk-go/awscdkpipesenrichmentsalpha/v2#ApiGatewayEnrichmentProps |
![]() | software.amazon.awscdk.services.pipes.enrichments.alpha.ApiGatewayEnrichmentProps |
![]() | aws_cdk.aws_pipes_enrichments_alpha.ApiGatewayEnrichmentProps |
![]() | @aws-cdk/aws-pipes-enrichments-alpha ยป ApiGatewayEnrichmentProps |
Properties for a ApiGatewayEnrichment.
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
Name | Type | Description |
---|---|---|
header | { [string]: string } | The headers that need to be sent as part of request invoking the API Gateway REST API. |
input | Input | The input transformation for the enrichment. |
method? | string | The method for API Gateway resource. |
path? | string | The path for the API Gateway resource. |
path | string[] | The path parameter values used to populate the API Gateway REST API path wildcards ("*"). |
query | { [string]: string } | The query string keys/values that need to be sent as part of request invoking the EventBridge API destination. |
stage? | string | The deployment stage for the API Gateway resource. |
headerParameters?
Type:
{ [string]: string }
(optional, default: none)
The headers that need to be sent as part of request invoking the API Gateway REST API.
inputTransformation?
Type:
Input
(optional, default: None)
The input transformation for the enrichment.
method?
Type:
string
(optional, default: '' - ANY)*
The method for API Gateway resource.
path?
Type:
string
(optional, default: '/')
The path for the API Gateway resource.
pathParameterValues?
Type:
string[]
(optional, default: none)
The path parameter values used to populate the API Gateway REST API path wildcards ("*").
queryStringParameters?
Type:
{ [string]: string }
(optional, default: none)
The query string keys/values that need to be sent as part of request invoking the EventBridge API destination.
stage?
Type:
string
(optional, default: the value of deploymentStage.stageName
of target API Gateway resource.)
The deployment stage for the API Gateway resource.