software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichment Maven / Gradle / Ivy
package software.amazon.awscdk.services.pipes.enrichments.alpha;
/**
* (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();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-19T18:12:10.261Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.pipes.enrichments.alpha.$Module.class, fqn = "@aws-cdk/aws-pipes-enrichments-alpha.StepFunctionsEnrichment")
public class StepFunctionsEnrichment extends software.amazon.jsii.JsiiObject implements software.amazon.awscdk.services.pipes.alpha.IEnrichment {
protected StepFunctionsEnrichment(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected StepFunctionsEnrichment(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param stateMachine This parameter is required.
* @param props
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public StepFunctionsEnrichment(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine, final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichmentProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(stateMachine, "stateMachine is required"), props });
}
/**
* @param stateMachine This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public StepFunctionsEnrichment(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(stateMachine, "stateMachine is required") });
}
/**
* (experimental) Bind this enrichment to a pipe.
*
* @param pipe This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.pipes.alpha.EnrichmentParametersConfig bind(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.pipes.alpha.IPipe pipe) {
return software.amazon.jsii.Kernel.call(this, "bind", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.pipes.alpha.EnrichmentParametersConfig.class), new Object[] { java.util.Objects.requireNonNull(pipe, "pipe is required") });
}
/**
* (experimental) Grant the pipes role to invoke the enrichment.
*
* @param pipeRole This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public void grantInvoke(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.iam.IRole pipeRole) {
software.amazon.jsii.Kernel.call(this, "grantInvoke", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(pipeRole, "pipeRole is required") });
}
/**
* (experimental) The ARN of the enrichment resource.
*
* Length Constraints: Minimum length of 0. Maximum length of 1600.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getEnrichmentArn() {
return software.amazon.jsii.Kernel.get(this, "enrichmentArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) A fluent builder for {@link software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichment}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param stateMachine This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine) {
return new Builder(stateMachine);
}
private final software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine;
private software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichmentProps.Builder props;
private Builder(final software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine) {
this.stateMachine = stateMachine;
}
/**
* (experimental) The input transformation for the enrichment.
*
* Default: - None
*
* @return {@code this}
* @see https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-input-transformation.html
* @param inputTransformation The input transformation for the enrichment. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder inputTransformation(final software.amazon.awscdk.services.pipes.alpha.InputTransformation inputTransformation) {
this.props().inputTransformation(inputTransformation);
return this;
}
/**
* @return a newly built instance of {@link software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichment}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichment build() {
return new software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichment(
this.stateMachine,
this.props != null ? this.props.build() : null
);
}
private software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichmentProps.Builder props() {
if (this.props == null) {
this.props = new software.amazon.awscdk.services.pipes.enrichments.alpha.StepFunctionsEnrichmentProps.Builder();
}
return this.props;
}
}
}