Package software.amazon.awscdk.services.events.targets

Class SnsTopicProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SnsTopicProps>

Enclosing interface:

SnsTopicProps

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

A builder for SnsTopicProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnsTopicProps	build()	Builds the configured instance.
SnsTopicProps.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of TargetBaseProps.getDeadLetterQueue()
SnsTopicProps.Builder	maxEventAge(Duration maxEventAge)	Sets the value of TargetBaseProps.getMaxEventAge()
SnsTopicProps.Builder	message(RuleTargetInput message)	Sets the value of SnsTopicProps.getMessage()
SnsTopicProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of TargetBaseProps.getRetryAttempts()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

message

@Stability(Stable)
public SnsTopicProps.Builder message(RuleTargetInput message)

Sets the value of SnsTopicProps.getMessage()

Parameters:

message - The message to send to the topic.

Returns:

this

deadLetterQueue

@Stability(Stable)
public SnsTopicProps.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of TargetBaseProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. 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.

Returns:

this

maxEventAge

@Stability(Stable)
public SnsTopicProps.Builder maxEventAge(Duration maxEventAge)

Sets the value of TargetBaseProps.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.

Returns:

this

retryAttempts

@Stability(Stable)
public SnsTopicProps.Builder retryAttempts(Number retryAttempts)

Sets the value of TargetBaseProps.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.

Returns:

this

build

@Stability(Stable)
public SnsTopicProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SnsTopicProps

Throws:

NullPointerException - if any required attribute was not provided