/* * Copyright 2018-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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* Input for CreateTopic action. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateTopicRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** 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 the object after creating it. */ 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.
*/
public CreateTopicRequest(String name) {
setName(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.
*
* 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) {
this.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.
*
* 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() {
return this.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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTopicRequest withName(String name) {
setName(name);
return this;
}
/**
*
* 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 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 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 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.
*
* To be able to tag a topic on creation, you must have the sns:CreateTopic
and
* sns:TagResource
permissions.
*
* 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.
*
* 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 * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @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 sns:CreateTopic
and
* sns:TagResource
permissions.
*
* 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.
*
* 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. *
* * @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. */ public void setDataProtectionPolicy(String dataProtectionPolicy) { this.dataProtectionPolicy = 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. *
* * @return 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() { return this.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. *
* * @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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateTopicRequest withDataProtectionPolicy(String dataProtectionPolicy) { setDataProtectionPolicy(dataProtectionPolicy); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getAttributes() != null) sb.append("Attributes: ").append(getAttributes()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getDataProtectionPolicy() != null) sb.append("DataProtectionPolicy: ").append(getDataProtectionPolicy()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateTopicRequest == false) return false; CreateTopicRequest other = (CreateTopicRequest) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getAttributes() == null ^ this.getAttributes() == null) return false; if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getDataProtectionPolicy() == null ^ this.getDataProtectionPolicy() == null) return false; if (other.getDataProtectionPolicy() != null && other.getDataProtectionPolicy().equals(this.getDataProtectionPolicy()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getDataProtectionPolicy() == null) ? 0 : getDataProtectionPolicy().hashCode()); return hashCode; } @Override public CreateTopicRequest clone() { return (CreateTopicRequest) super.clone(); } }