CreateTopicRequest (AWS Java SDK for Amazon SNS 1.12.63 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sns.model.CreateTopicRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTopicRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Input for CreateTopic action.

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`CreateTopicRequest()` Default constructor for CreateTopicRequest object.
`CreateTopicRequest(String name)` Constructs a new CreateTopicRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateTopicRequest`	`addAttributesEntry(String key, String value)` Add a single Attributes entry
`CreateTopicRequest`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`CreateTopicRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` A map of attributes with their corresponding values.
`String`	`getName()` The name of the topic you want to create.
`List<Tag>`	`getTags()` The list of tags to add to a new topic.
`int`	`hashCode()`
`void`	`setAttributes(Map<String,String> attributes)` A map of attributes with their corresponding values.
`void`	`setName(String name)` The name of the topic you want to create.
`void`	`setTags(Collection<Tag> tags)` The list of tags to add to a new topic.
`String`	`toString()` Returns a string representation of this object.
`CreateTopicRequest`	`withAttributes(Map<String,String> attributes)` A map of attributes with their corresponding values.
`CreateTopicRequest`	`withName(String name)` The name of the topic you want to create.
`CreateTopicRequest`	`withTags(Collection<Tag> tags)` The list of tags to add to a new topic.
`CreateTopicRequest`	`withTags(Tag... tags)` The list of tags to add to a new topic.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateTopicRequest
```
public CreateTopicRequest()
```
    Default constructor for CreateTopicRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - CreateTopicRequest
```
public CreateTopicRequest(String name)
```
    Constructs a new CreateTopicRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    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.
- Method Detail
  - setName
```
public void setName(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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public CreateTopicRequest withName(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.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    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.
    Returns:
    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.
  - setAttributes
```
public void setAttributes(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.
    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.
    
    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.
  - withAttributes
```
public CreateTopicRequest withAttributes(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.
    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.
    
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public CreateTopicRequest addAttributesEntry(String key,
                                             String value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributesEntries
```
public CreateTopicRequest clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    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:
    
    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.
  - setTags
```
public void setTags(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.
  - withTags
```
public CreateTopicRequest withTags(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    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.
  - withTags
```
public CreateTopicRequest withTags(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateTopicRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class CreateTopicRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateTopicRequest

CreateTopicRequest

Method Detail

setName

getName

withName

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone