Package software.amazon.awscdk.services.pipes.enrichments.alpha

Class ApiDestinationEnrichment

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.pipes.enrichments.alpha.ApiDestinationEnrichment

All Implemented Interfaces:

IEnrichment, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:41.176Z")
@Stability(Experimental)
public class ApiDestinationEnrichment
extends software.amazon.jsii.JsiiObject
implements IEnrichment

(experimental) An API Destination enrichment for a pipe.

Example:

 Queue sourceQueue;
 Queue targetQueue;
 ApiDestination apiDestination;
 ApiDestinationEnrichment enrichment = new ApiDestinationEnrichment(apiDestination);
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(new SomeSource(sourceQueue))
         .enrichment(enrichment)
         .target(new SomeTarget(targetQueue))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ApiDestinationEnrichment.Builder	(experimental) A fluent builder for ApiDestinationEnrichment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.pipes.alpha.IEnrichment

IEnrichment.Jsii$Default, IEnrichment.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	ApiDestinationEnrichment(IApiDestination destination)
	ApiDestinationEnrichment(IApiDestination destination, ApiDestinationEnrichmentProps props)
protected	ApiDestinationEnrichment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiDestinationEnrichment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
EnrichmentParametersConfig	bind(IPipe pipe)	(experimental) Bind this enrichment to a pipe.
String	getEnrichmentArn()	(experimental) The ARN of the enrichment resource.
void	grantInvoke(IRole pipeRole)	(experimental) Grant the pipes role to invoke the enrichment.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ApiDestinationEnrichment

protected ApiDestinationEnrichment(software.amazon.jsii.JsiiObjectRef objRef)

ApiDestinationEnrichment

protected ApiDestinationEnrichment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ApiDestinationEnrichment

@Stability(Experimental)
public ApiDestinationEnrichment(@NotNull
 IApiDestination destination,
 @Nullable
 ApiDestinationEnrichmentProps props)

Parameters:

destination - This parameter is required.

props -

ApiDestinationEnrichment

@Stability(Experimental)
public ApiDestinationEnrichment(@NotNull
 IApiDestination destination)

Parameters:

destination - This parameter is required.

Method Details

bind

@Stability(Experimental)
@NotNull
public EnrichmentParametersConfig bind(@NotNull
 IPipe pipe)

(experimental) Bind this enrichment to a pipe.

Specified by:

bind in interface IEnrichment

Parameters:

pipe - This parameter is required.

grantInvoke

@Stability(Experimental)
public void grantInvoke(@NotNull
 IRole pipeRole)

(experimental) Grant the pipes role to invoke the enrichment.

Specified by:

grantInvoke in interface IEnrichment

Parameters:

pipeRole - This parameter is required.

getEnrichmentArn

@Stability(Experimental)
@NotNull
public String getEnrichmentArn()

(experimental) The ARN of the enrichment resource.

Length Constraints: Minimum length of 0. Maximum length of 1600.

Specified by:

getEnrichmentArn in interface IEnrichment

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-enrichment