@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 |
getDataProtectionPolicy()
The body of the policy document you want to use for this topic.
|
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 |
setDataProtectionPolicy(String dataProtectionPolicy)
The body of the policy document you want to use for this topic.
|
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 |
withDataProtectionPolicy(String dataProtectionPolicy)
The body of the policy document you want to use for this topic.
|
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 void setDataProtectionPolicy(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.
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.
public String getDataProtectionPolicy()
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.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
public CreateTopicRequest withDataProtectionPolicy(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.
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.
public String toString()
toString
in class Object
Object.toString()
public CreateTopicRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2024. All rights reserved.