software.amazon.awscdk.services.events.targets

Class SnsTopic.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.SnsTopic.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SnsTopic>

Enclosing class:

SnsTopic

@Stability(value=Stable)
public static final class SnsTopic.Builder
extends Object
implements software.amazon.jsii.Builder<SnsTopic>

A fluent builder for SnsTopic.

Method Summary

Modifier and Type	Method and Description
SnsTopic	build()
static SnsTopic.Builder	create(ITopic topic)
SnsTopic.Builder	deadLetterQueue(IQueue deadLetterQueue) The SQS queue to be used as deadLetterQueue.
SnsTopic.Builder	maxEventAge(Duration maxEventAge) The maximum age of a request that Lambda sends to a function for processing.
SnsTopic.Builder	message(RuleTargetInput message) The message to send to the topic.
SnsTopic.Builder	retryAttempts(Number retryAttempts) The maximum number of times to retry when the function returns an error.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static SnsTopic.Builder create(ITopic topic)

Parameters:

topic - This parameter is required.

Returns:

a new instance of SnsTopic.Builder.

deadLetterQueue

@Stability(value=Stable)
public SnsTopic.Builder deadLetterQueue(IQueue deadLetterQueue)

The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations). This parameter is required.

Returns:

this

maxEventAge

@Stability(value=Stable)
public SnsTopic.Builder maxEventAge(Duration maxEventAge)

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.

Returns:

this

retryAttempts

@Stability(value=Stable)
public SnsTopic.Builder retryAttempts(Number retryAttempts)

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default: 185

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.

Returns:

this

message

@Stability(value=Stable)
public SnsTopic.Builder message(RuleTargetInput message)

The message to send to the topic.

Default: the entire EventBridge event

Parameters:

message - The message to send to the topic. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public SnsTopic build()

Specified by:

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