public static interface CreateTopicRequest.Builder extends SnsRequest.Builder, SdkPojo, CopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateTopicRequest.Builder |
attributes(Map<String,String> attributes)
A map of attributes with their corresponding values.
|
CreateTopicRequest.Builder |
name(String name)
The name of the topic you want to create.
|
CreateTopicRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateTopicRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateTopicRequest.Builder |
tags(Collection<Tag> tags)
The list of tags to add to a new topic.
|
CreateTopicRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
The list of tags to add to a new topic.
|
CreateTopicRequest.Builder |
tags(Tag... tags)
The list of tags to add to a new topic.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateTopicRequest.Builder name(String name)
The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
name - The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
CreateTopicRequest.Builder attributes(Map<String,String> attributes)
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
CreateTopic action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S
endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
FifoTopic – Set to true to create a FIFO topic.
Policy – The policy that defines who can access your topic. By default, only the topic owner can
publish or subscribe to the topic.
The following attribute applies only to server-side encryption:
KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon
SNS or a custom CMK. For more information, see Key Terms.
For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
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
MessageDeduplicationId parameter for the Publish action.
attributes - A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
CreateTopic action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to
HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
FifoTopic – Set to true to create a FIFO topic.
Policy – The policy that defines who can access your topic. By default, only the topic
owner can publish or subscribe to the topic.
The following attribute applies only to server-side encryption:
KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for
Amazon SNS or a custom CMK. For more information, see Key
Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
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
MessageDeduplicationId parameter for the Publish action.
CreateTopicRequest.Builder tags(Collection<Tag> 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.
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.
CreateTopicRequest.Builder tags(Tag... 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.
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.
CreateTopicRequest.Builder tags(Consumer<Tag.Builder>... 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.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateTopicRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateTopicRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.