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

Class SqsTarget.Builder

java.lang.Object

software.amazon.awscdk.services.pipes.targets.alpha.SqsTarget.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SqsTarget>

Enclosing class:

SqsTarget

@Stability(Experimental)
public static final class SqsTarget.Builder
extends Object
implements software.amazon.jsii.Builder<SqsTarget>

(experimental) A fluent builder for SqsTarget.

Method Summary

Modifier and Type	Method	Description
SqsTarget	build()
static SqsTarget.Builder	create(IQueue queue)
SqsTarget.Builder	inputTransformation(IInputTransformation inputTransformation)	(experimental) The input transformation to apply to the message before sending it to the target.
SqsTarget.Builder	messageDeduplicationId(String messageDeduplicationId)	(experimental) This parameter applies only to FIFO (first-in-first-out) queues.
SqsTarget.Builder	messageGroupId(String messageGroupId)	(experimental) The FIFO message group ID to use as the target.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static SqsTarget.Builder create(IQueue queue)

Parameters:

queue - This parameter is required.

Returns:

a new instance of SqsTarget.Builder.

inputTransformation

@Stability(Experimental)
public SqsTarget.Builder inputTransformation(IInputTransformation inputTransformation)

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

Default: - none

Parameters:

inputTransformation - The input transformation to apply to the message before sending it to the target. This parameter is required.

Returns:

this

See Also:

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

messageDeduplicationId

@Stability(Experimental)
public SqsTarget.Builder messageDeduplicationId(String messageDeduplicationId)

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

The token used for deduplication of sent messages.

Default: - none

Parameters:

messageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) queues. This parameter is required.

Returns:

this

See Also:

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

messageGroupId

@Stability(Experimental)
public SqsTarget.Builder messageGroupId(String messageGroupId)

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

Default: - none

Parameters:

messageGroupId - The FIFO message group ID to use as the target. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Experimental)
public SqsTarget build()

Specified by:

build in interface software.amazon.jsii.Builder<SqsTarget>

Returns:

a newly built instance of SqsTarget.