class ApiGatewayEnrichment
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pipes.Enrichments.Alpha.ApiGatewayEnrichment |
![]() | github.com/aws/aws-cdk-go/awscdkpipesenrichmentsalpha/v2#ApiGatewayEnrichment |
![]() | software.amazon.awscdk.services.pipes.enrichments.alpha.ApiGatewayEnrichment |
![]() | aws_cdk.aws_pipes_enrichments_alpha.ApiGatewayEnrichment |
![]() | @aws-cdk/aws-pipes-enrichments-alpha ยป ApiGatewayEnrichment |
Implements
IEnrichment
An API Gateway enrichment for a pipe.
Example
declare const sourceQueue: sqs.Queue;
declare const targetQueue: sqs.Queue;
declare const restApi: apigateway.RestApi;
const enrichment = new enrichments.ApiGatewayEnrichment(restApi);
const pipe = new pipes.Pipe(this, 'Pipe', {
source: new SomeSource(sourceQueue),
enrichment,
target: new SomeTarget(targetQueue),
});
Initializer
new ApiGatewayEnrichment(restApi: IRestApi, props?: ApiGatewayEnrichmentProps)
Parameters
- restApi
IRest
Api - props
Api
Gateway Enrichment Props
Properties
Name | Type | Description |
---|---|---|
enrichment | string | The ARN of the enrichment resource. |
enrichmentArn
Type:
string
The ARN of the enrichment resource.
Length Constraints: Minimum length of 0. Maximum length of 1600.
Methods
Name | Description |
---|---|
bind(pipe) | Bind this enrichment to a pipe. |
grant | Grant the pipes role to invoke the enrichment. |
bind(pipe)
public bind(pipe: IPipe): EnrichmentParametersConfig
Parameters
- pipe
IPipe
Returns
Bind this enrichment to a pipe.
grantInvoke(pipeRole)
public grantInvoke(pipeRole: IRole): void
Parameters
- pipeRole
IRole
Grant the pipes role to invoke the enrichment.