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

Interface SqsTargetParameters

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SqsTargetParameters.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:16.127Z")
@Stability(Experimental)
public interface SqsTargetParameters
extends software.amazon.jsii.JsiiSerializable

(experimental) SQS target properties.

Example:

 Queue sourceQueue;
 Queue targetQueue;
 SqsTarget pipeTarget = SqsTarget.Builder.create(targetQueue)
         .inputTransformation(InputTransformation.fromObject(Map.of(
                 "SomeKey", DynamicInput.fromEventPath("$.body"))))
         .build();
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(new SomeSource(sourceQueue))
         .target(pipeTarget)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SqsTargetParameters.Builder	A builder for SqsTargetParameters
static final class	SqsTargetParameters.Jsii$Proxy	An implementation for SqsTargetParameters

Method Summary

Modifier and Type	Method	Description
static SqsTargetParameters.Builder	builder()
default IInputTransformation	getInputTransformation()	(experimental) The input transformation to apply to the message before sending it to the target.
default String	getMessageDeduplicationId()	(experimental) This parameter applies only to FIFO (first-in-first-out) queues.
default String	getMessageGroupId()	(experimental) The FIFO message group ID to use as the target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInputTransformation

@Stability(Experimental)
@Nullable
default IInputTransformation getInputTransformation()

(experimental) The input transformation to apply to the message before sending it to the target.

Default: none

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-inputtemplate

getMessageDeduplicationId

@Stability(Experimental)
@Nullable
default String getMessageDeduplicationId()

(experimental) This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages.

Default: none

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid

getMessageGroupId

@Stability(Experimental)
@Nullable
default String getMessageGroupId()

(experimental) The FIFO message group ID to use as the target.

Default: none

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagegroupid

builder

@Stability(Experimental)
static SqsTargetParameters.Builder builder()

Returns:

a SqsTargetParameters.Builder of SqsTargetParameters