CfnTopicProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.sns.CfnTopicProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnTopicProps>

Enclosing interface:: CfnTopicProps

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

A builder for CfnTopicProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnTopicProps`	`build()` Builds the configured instance.
`CfnTopicProps.Builder`	`contentBasedDeduplication(Boolean contentBasedDeduplication)` Sets the value of `CfnTopicProps.getContentBasedDeduplication()`
`CfnTopicProps.Builder`	`contentBasedDeduplication(IResolvable contentBasedDeduplication)` Sets the value of `CfnTopicProps.getContentBasedDeduplication()`
`CfnTopicProps.Builder`	`dataProtectionPolicy(Object dataProtectionPolicy)` Sets the value of `CfnTopicProps.getDataProtectionPolicy()`
`CfnTopicProps.Builder`	`displayName(String displayName)` Sets the value of `CfnTopicProps.getDisplayName()`
`CfnTopicProps.Builder`	`fifoTopic(Boolean fifoTopic)` Sets the value of `CfnTopicProps.getFifoTopic()`
`CfnTopicProps.Builder`	`fifoTopic(IResolvable fifoTopic)` Sets the value of `CfnTopicProps.getFifoTopic()`
`CfnTopicProps.Builder`	`kmsMasterKeyId(String kmsMasterKeyId)` Sets the value of `CfnTopicProps.getKmsMasterKeyId()`
`CfnTopicProps.Builder`	`subscription(IResolvable subscription)` Sets the value of `CfnTopicProps.getSubscription()`
`CfnTopicProps.Builder`	`subscription(List<? extends Object> subscription)` Sets the value of `CfnTopicProps.getSubscription()`
`CfnTopicProps.Builder`	`tags(List<? extends CfnTag> tags)` Sets the value of `CfnTopicProps.getTags()`
`CfnTopicProps.Builder`	`topicName(String topicName)` Sets the value of `CfnTopicProps.getTopicName()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - contentBasedDeduplication
```
@Stability(value=Stable)
public CfnTopicProps.Builder contentBasedDeduplication(Boolean contentBasedDeduplication)
```
    Sets the value of CfnTopicProps.getContentBasedDeduplication()
    Parameters:
    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.
    Returns:
    
    this
  - contentBasedDeduplication
```
@Stability(value=Stable)
public CfnTopicProps.Builder contentBasedDeduplication(IResolvable contentBasedDeduplication)
```
    Sets the value of CfnTopicProps.getContentBasedDeduplication()
    Parameters:
    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.
    Returns:
    
    this
  - dataProtectionPolicy
```
@Stability(value=Stable)
public CfnTopicProps.Builder dataProtectionPolicy(Object dataProtectionPolicy)
```
    Sets the value of CfnTopicProps.getDataProtectionPolicy()
    
    Parameters:
    
    dataProtectionPolicy - `AWS::SNS::Topic.DataProtectionPolicy`.
    
    Returns:
    
    this
  - displayName
```
@Stability(value=Stable)
public CfnTopicProps.Builder displayName(String displayName)
```
    Sets the value of CfnTopicProps.getDisplayName()
    
    Parameters:
    
    displayName - The display name to use for an Amazon SNS topic with SMS subscriptions.
    
    Returns:
    
    this
  - fifoTopic
```
@Stability(value=Stable)
public CfnTopicProps.Builder fifoTopic(Boolean fifoTopic)
```
    Sets the value of CfnTopicProps.getFifoTopic()
    
    Parameters:
    
    fifoTopic - Set to true to create a FIFO topic.
    
    Returns:
    
    this
  - fifoTopic
```
@Stability(value=Stable)
public CfnTopicProps.Builder fifoTopic(IResolvable fifoTopic)
```
    Sets the value of CfnTopicProps.getFifoTopic()
    
    Parameters:
    
    fifoTopic - Set to true to create a FIFO topic.
    
    Returns:
    
    this
  - kmsMasterKeyId
```
@Stability(value=Stable)
public CfnTopicProps.Builder kmsMasterKeyId(String kmsMasterKeyId)
```
    Sets the value of CfnTopicProps.getKmsMasterKeyId()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - subscription
```
@Stability(value=Stable)
public CfnTopicProps.Builder subscription(IResolvable subscription)
```
    Sets the value of CfnTopicProps.getSubscription()
    
    Parameters:
    
    subscription - The Amazon SNS subscriptions (endpoints) for this topic.
    
    Returns:
    
    this
  - subscription
```
@Stability(value=Stable)
public CfnTopicProps.Builder subscription(List<? extends Object> subscription)
```
    Sets the value of CfnTopicProps.getSubscription()
    
    Parameters:
    
    subscription - The Amazon SNS subscriptions (endpoints) for this topic.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnTopicProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnTopicProps.getTags()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - topicName
```
@Stability(value=Stable)
public CfnTopicProps.Builder topicName(String topicName)
```
    Sets the value of CfnTopicProps.getTopicName()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnTopicProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnTopicProps>
    
    Returns:
    
    a new instance of CfnTopicProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnTopicProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

contentBasedDeduplication

contentBasedDeduplication

dataProtectionPolicy

displayName

fifoTopic

fifoTopic

kmsMasterKeyId

subscription

subscription

tags

topicName

build