Package software.amazon.awssdk.services.sns.model

Interface CreateTopicRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>, SdkBuilder<CreateTopicRequest.Builder,CreateTopicRequest>, SdkPojo, SdkRequest.Builder, SnsRequest.Builder
Enclosing class:
CreateTopicRequest
public static interface CreateTopicRequest.Builder extends SnsRequest.Builder, SdkPojo, CopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>

  • Method Details

    • name

      CreateTopicRequest.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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      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.

      • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.

      • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

      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:

      • ArchivePolicy – Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic.

      • BeginningArchiveTime – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy.

      • 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.

      Parameters:
      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.

      • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.

      • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

      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:

      • ArchivePolicy – Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic.

      • BeginningArchiveTime – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy.

      • 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataProtectionPolicy

      CreateTopicRequest.Builder dataProtectionPolicy(String dataProtectionPolicy)

      The body of the policy document you want to use for this topic.

      You can only add one policy per topic.

      The policy must be in JSON string format.

      Length Constraints: Maximum length of 30,720.

      Parameters:
      dataProtectionPolicy - The body of the policy document you want to use for this topic.

      You can only add one policy per topic.

      The policy must be in JSON string format.

      Length Constraints: Maximum length of 30,720.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateTopicRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateTopicRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.