/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.sns.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *
* Creates a topic to which notifications can be published. Users can create at * most 100,000 standard topics (at most 1,000 FIFO topics). For more * information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. * This action is idempotent, so if the requester already owns a topic with the * specified name, that topic's ARN is returned without creating a new topic. *
*/ public class CreateTopicRequest extends AmazonWebServiceRequest implements Serializable { /** ** 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.
*
* 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: *
*
* 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.
*
* 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.
*
* 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. *
*/ private String dataProtectionPolicy; /** * Default constructor for CreateTopicRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. */ public CreateTopicRequest() { } /** * Constructs a new CreateTopicRequest object. Callers should use the setter * or fluent setter (with...) methods to initialize any additional object * members. * * @param 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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 a reference to this object so that method calls can be chained * together. * * @param 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.
*
* 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: *
*
* 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.
*
* 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: *
*
* 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.
*
* 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: *
*
* 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.
*
* 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: *
*
* 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.
*
* 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: *
*
* 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 reference to this object so that method calls can be chained * together. * * @param 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: *
*
* 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.
*
* 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: *
*
* 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.
*
* The method adds a new key-value pair into Attributes parameter, and
* returns a reference to this object so that method calls can be chained
* together.
*
* @param key The key of the entry to be added into Attributes.
* @param value The corresponding value of the entry to be added into
* Attributes.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public CreateTopicRequest addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public CreateTopicRequest clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
*
* The list of tags to add to a new topic.
*
* To be able to tag a topic on creation, you must have the
*
* The list of tags to add to a new topic.
*
* To be able to tag a topic on creation, you must have the
*
* The list of tags to add to a new topic.
*
* To be able to tag a topic on creation, you must have the
*
* The list of tags to add to a new topic.
*
* To be able to tag a topic on creation, you must have the
*
* The list of tags to add to a new topic.
*
* To be able to tag a topic on creation, you must have the
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param tags
* The list of tags to add to a new topic.
*
* To be able to tag a topic on creation, you must have the
*
* The list of tags to add to a new topic.
*
* To be able to tag a topic on creation, you must have the
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param tags
* The list of tags to add to a new topic.
*
* To be able to tag a topic on creation, you must have the
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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 a reference to this object so that method calls can be chained
* together.
*
* @param 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.
* sns:CreateTopic
and sns:TagResource
* permissions.
* sns:CreateTopic
and sns:TagResource
* permissions.
* sns:CreateTopic
and sns:TagResource
* permissions.
* sns:CreateTopic
and sns:TagResource
* permissions.
* sns:CreateTopic
and sns:TagResource
* permissions.
* sns:CreateTopic
and sns:TagResource
* permissions.
* sns:CreateTopic
and sns:TagResource
* permissions.
* sns:CreateTopic
and sns:TagResource
* permissions.
*