software.amazon.awscdk.services.sns

Class CfnTopic.Builder

java.lang.Object

software.amazon.awscdk.services.sns.CfnTopic.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTopic>

Enclosing class:

CfnTopic

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

A fluent builder for CfnTopic.

Method Summary

Modifier and Type	Method and Description
CfnTopic	build()
CfnTopic.Builder	contentBasedDeduplication(Boolean contentBasedDeduplication) Enables content-based deduplication for FIFO topics.
CfnTopic.Builder	contentBasedDeduplication(IResolvable contentBasedDeduplication) Enables content-based deduplication for FIFO topics.
static CfnTopic.Builder	create(software.constructs.Construct scope, String id)
CfnTopic.Builder	dataProtectionPolicy(Object dataProtectionPolicy) `AWS::SNS::Topic.DataProtectionPolicy`.
CfnTopic.Builder	displayName(String displayName) The display name to use for an Amazon SNS topic with SMS subscriptions.
CfnTopic.Builder	fifoTopic(Boolean fifoTopic) Set to true to create a FIFO topic.
CfnTopic.Builder	fifoTopic(IResolvable fifoTopic) Set to true to create a FIFO topic.
CfnTopic.Builder	kmsMasterKeyId(String kmsMasterKeyId) The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.
CfnTopic.Builder	subscription(IResolvable subscription) The Amazon SNS subscriptions (endpoints) for this topic.
CfnTopic.Builder	subscription(List<? extends Object> subscription) The Amazon SNS subscriptions (endpoints) for this topic.
CfnTopic.Builder	tags(List<? extends CfnTag> tags) The list of tags to add to a new topic.
CfnTopic.Builder	topicName(String topicName) The name of the topic you want to create.

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 CfnTopic.Builder create(software.constructs.Construct scope,
                                                               String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnTopic.SubscriptionProperty.Builder.

contentBasedDeduplication

@Stability(value=Stable)
public CfnTopic.Builder contentBasedDeduplication(Boolean contentBasedDeduplication)

Enables content-based deduplication for FIFO topics.

• By default, ContentBasedDeduplication is set to false . If you create a FIFO topic and this attribute is false , you must specify a value for the MessageDeduplicationId parameter for the Publish action.
• When you set ContentBasedDeduplication to true , Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

Parameters:

contentBasedDeduplication - Enables content-based deduplication for FIFO topics. This parameter is required.

Returns:

this

contentBasedDeduplication

@Stability(value=Stable)
public CfnTopic.Builder contentBasedDeduplication(IResolvable contentBasedDeduplication)

Enables content-based deduplication for FIFO topics.

• By default, ContentBasedDeduplication is set to false . If you create a FIFO topic and this attribute is false , you must specify a value for the MessageDeduplicationId parameter for the Publish action.
• When you set ContentBasedDeduplication to true , Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

Parameters:

contentBasedDeduplication - Enables content-based deduplication for FIFO topics. This parameter is required.

Returns:

this

dataProtectionPolicy

@Stability(value=Stable)
public CfnTopic.Builder dataProtectionPolicy(Object dataProtectionPolicy)

`AWS::SNS::Topic.DataProtectionPolicy`.

Parameters:

dataProtectionPolicy - `AWS::SNS::Topic.DataProtectionPolicy`. This parameter is required.

Returns:

this

displayName

@Stability(value=Stable)
public CfnTopic.Builder displayName(String displayName)

The display name to use for an Amazon SNS topic with SMS subscriptions.

Parameters:

displayName - The display name to use for an Amazon SNS topic with SMS subscriptions. This parameter is required.

Returns:

this

fifoTopic

@Stability(value=Stable)
public CfnTopic.Builder fifoTopic(Boolean fifoTopic)

Set to true to create a FIFO topic.

Parameters:

fifoTopic - Set to true to create a FIFO topic. This parameter is required.

Returns:

this

fifoTopic

@Stability(value=Stable)
public CfnTopic.Builder fifoTopic(IResolvable fifoTopic)

Set to true to create a FIFO topic.

Parameters:

fifoTopic - Set to true to create a FIFO topic. This parameter is required.

Returns:

this

kmsMasterKeyId

@Stability(value=Stable)
public CfnTopic.Builder kmsMasterKeyId(String kmsMasterKeyId)

The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.

For more information, see Key terms . For more examples, see [KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the AWS Key Management Service API Reference .

This property applies only to server-side-encryption .

Parameters:

kmsMasterKeyId - The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. This parameter is required.

Returns:

this

subscription

@Stability(value=Stable)
public CfnTopic.Builder subscription(IResolvable subscription)

The Amazon SNS subscriptions (endpoints) for this topic.

Parameters:

subscription - The Amazon SNS subscriptions (endpoints) for this topic. This parameter is required.

Returns:

this

subscription

@Stability(value=Stable)
public CfnTopic.Builder subscription(List<? extends Object> subscription)

The Amazon SNS subscriptions (endpoints) for this topic.

Parameters:

subscription - The Amazon SNS subscriptions (endpoints) for this topic. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnTopic.Builder tags(List<? extends CfnTag> tags)

The list of tags to add to a new topic.

To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

Parameters:

tags - The list of tags to add to a new topic. This parameter is required.

Returns:

this

topicName

@Stability(value=Stable)
public CfnTopic.Builder topicName(String topicName)

The name of the topic you want to create.

Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo .

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name type .

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

topicName - The name of the topic you want to create. This parameter is required.

Returns:

this

build

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

Specified by:

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