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

Class StepFunctionsEnrichment

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

IEnrichment, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-05T20:26:41.041Z")
@Stability(Experimental)
public class StepFunctionsEnrichment
extends software.amazon.jsii.JsiiObject
implements IEnrichment

(experimental) A StepFunctions enrichment for a pipe.

Example:

 Queue sourceQueue;
 Queue targetQueue;
 StateMachine enrichmentStateMachine;
 StepFunctionsEnrichment enrichment = new StepFunctionsEnrichment(enrichmentStateMachine);
 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	StepFunctionsEnrichment.Builder	(experimental) A fluent builder for StepFunctionsEnrichment.

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
	StepFunctionsEnrichment(IStateMachine stateMachine)
	StepFunctionsEnrichment(IStateMachine stateMachine, StepFunctionsEnrichmentProps props)
protected	StepFunctionsEnrichment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StepFunctionsEnrichment(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

StepFunctionsEnrichment

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

StepFunctionsEnrichment

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

StepFunctionsEnrichment

@Stability(Experimental)
public StepFunctionsEnrichment(@NotNull
 IStateMachine stateMachine,
 @Nullable
 StepFunctionsEnrichmentProps props)

Parameters:

stateMachine - This parameter is required.

props -

StepFunctionsEnrichment

@Stability(Experimental)
public StepFunctionsEnrichment(@NotNull
 IStateMachine stateMachine)

Parameters:

stateMachine - 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