@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateTopicRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input for CreateTopic action.
NOOP
Constructor and Description |
---|
CreateTopicRequest()
Default constructor for CreateTopicRequest object.
|
CreateTopicRequest(String name)
Constructs a new CreateTopicRequest object.
|
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.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CreateTopicRequest()
public CreateTopicRequest(String name)
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.
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.
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.
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.
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.
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.
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.
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 AWS-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 AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to
generate the MessageDeduplicationId
using the body of the message (but not the attributes of the
message).
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides
the generated one.
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 AWS-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 AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication. Amazon SNS uses a SHA-256
hash to generate the MessageDeduplicationId
using the body of the message (but not the
attributes of the message).
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides the generated one.
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 AWS-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 AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to
generate the MessageDeduplicationId
using the body of the message (but not the attributes of the
message).
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides
the generated one.
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 AWS-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 AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication. Amazon SNS uses a SHA-256
hash to generate the MessageDeduplicationId
using the body of the message (but not the
attributes of the message).
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides the generated one.
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 AWS-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 AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to
generate the MessageDeduplicationId
using the body of the message (but not the attributes of the
message).
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides
the generated one.
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 AWS-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 AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication. Amazon SNS uses a SHA-256
hash to generate the MessageDeduplicationId
using the body of the message (but not the
attributes of the message).
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides the generated one.
public CreateTopicRequest addAttributesEntry(String key, String value)
public CreateTopicRequest clearAttributesEntries()
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.
To be able to tag a topic on creation, you must have the sns:CreateTopic
and
sns:TagResource
permissions.
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.
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.
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.
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.
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.
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.
public String toString()
toString
in class Object
Object.toString()
public CreateTopicRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2020. All rights reserved.