ApiDestinationEnrichment
- class aws_cdk.aws_pipes_enrichments_alpha.ApiDestinationEnrichment(destination, *, header_parameters=None, input_transformation=None, path_parameter_values=None, query_string_parameters=None)
Bases:
object
(experimental) An API Destination enrichment for a pipe.
- Stability:
experimental
- ExampleMetadata:
infused
Example:
# source_queue: sqs.Queue # target_queue: sqs.Queue # api_destination: events.ApiDestination enrichment = enrichments.ApiDestinationEnrichment(api_destination) pipe = pipes.Pipe(self, "Pipe", source=SomeSource(source_queue), enrichment=enrichment, target=SomeTarget(target_queue) )
- Parameters:
destination (
IApiDestination
) –header_parameters (
Optional
[Mapping
[str
,str
]]) – (experimental) The headers that need to be sent as part of request invoking the EventBridge ApiDestination. Default: - noneinput_transformation (
Optional
[InputTransformation
]) – (experimental) The input transformation for the enrichment. Default: - Nonepath_parameter_values (
Optional
[Sequence
[str
]]) – (experimental) The path parameter values used to populate the EventBridge API destination path wildcards (“*”). Default: - nonequery_string_parameters (
Optional
[Mapping
[str
,str
]]) – (experimental) The query string keys/values that need to be sent as part of request invoking the EventBridge API destination. Default: - none
- Stability:
experimental
Methods
- bind(pipe)
(experimental) Bind this enrichment to a pipe.
- Parameters:
pipe (
IPipe
) –- Stability:
experimental
- Return type:
- grant_invoke(pipe_role)
(experimental) Grant the pipes role to invoke the enrichment.
- Parameters:
pipe_role (
IRole
) –- Stability:
experimental
- Return type:
None
Attributes
- enrichment_arn
(experimental) The ARN of the enrichment resource.
Length Constraints: Minimum length of 0. Maximum length of 1600.
- Stability:
experimental