Class CreateTopicRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sns.model.SnsRequest
software.amazon.awssdk.services.sns.model.CreateTopicRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTopicRequest extends SnsRequest implements ToCopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>

Input for CreateTopic action.

  • Method Details

    • name

      public final 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.

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

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributes

      public final Map<String,String> attributes()

      A map of attributes with their corresponding values.

      The following lists 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      A map of attributes with their corresponding values.

      The following lists 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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • dataProtectionPolicy

      public final 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.

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

    • toBuilder

      public CreateTopicRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>
      Specified by:
      toBuilder in class SnsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateTopicRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTopicRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.