/* * 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 SetTopicAttributes action. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SetTopicAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** The ARN of the topic to modify. *
*/ private String topicArn; /** ** A map of attributes with their corresponding values. *
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes
action uses:
*
* ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to a platform application endpoint.
*
* 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.
*
* Policy
– The policy that defines who can access your topic. By default, only the topic owner can
* publish or subscribe to the topic.
*
* 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.
*
* HTTP *
*
* HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an HTTP endpoint.
*
* HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon
* SNS topic that is subscribed to an HTTP endpoint.
*
* HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that
* is subscribed to an HTTP endpoint.
*
* Amazon Kinesis Data Firehose *
*
* FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* Lambda *
*
* LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an Lambda endpoint.
*
* LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that
* is subscribed to an Lambda endpoint.
*
* Platform application endpoint *
*
* ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon Web Services application endpoint.
*
* In addition to being able to configure topic attributes for message delivery status of notification messages sent * to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of * push notification messages sent to push notification services. *
** For example, For more information, see Using Amazon SNS Application Attributes for * Message Delivery Status. *
** Amazon SQS *
*
* SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon SQS endpoint.
*
* SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon
* SNS topic that is subscribed to an Amazon SQS endpoint.
*
* SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is
* subscribed to an Amazon SQS endpoint.
*
* The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give * Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate * attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you * configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate * CloudWatch Logs. *
** 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.
*
* 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
.
*
* The following attribute applies only to FIFO topics: *
*
* 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 new value for the attribute. *
*/ private String attributeValue; /** * Default constructor for SetTopicAttributesRequest object. Callers should use the setter or fluent setter * (with...) methods to initialize the object after creating it. */ public SetTopicAttributesRequest() { } /** * Constructs a new SetTopicAttributesRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize any additional object members. * * @param topicArn * The ARN of the topic to modify. * @param attributeName * A map of attributes with their corresponding values. *
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes
action uses:
*
* ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon
* SNS topic that is subscribed to a platform application endpoint.
*
* 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.
*
* Policy
– The policy that defines who can access your topic. By default, only the topic owner
* can publish or subscribe to the topic.
*
* 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.
*
* HTTP *
*
* HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an HTTP endpoint.
*
* HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an HTTP endpoint.
*
* HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an HTTP endpoint.
*
* Amazon Kinesis Data Firehose *
*
* FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon
* SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for
* an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* Lambda *
*
* LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Lambda endpoint.
*
* LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for
* an Amazon SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an Lambda endpoint.
*
* Platform application endpoint *
*
* ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an
* Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample
* for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon
* SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* In addition to being able to configure topic attributes for message delivery status of notification * messages sent to Amazon SNS application endpoints, you can also configure application attributes for the * delivery status of push notification messages sent to push notification services. *
** For example, For more information, see Using Amazon SNS Application * Attributes for Message Delivery Status. *
** Amazon SQS *
*
* SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon SQS endpoint.
*
* SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
*
* SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon SQS endpoint.
*
* The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used * to give Amazon SNS write access to use CloudWatch Logs on your behalf. The * <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) * of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn * attribute, then all failed message deliveries generate CloudWatch Logs. *
** 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.
*
* 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
.
*
* The following attribute applies only to FIFO topics: *
*
* 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 ARN of the topic to modify. *
* * @param topicArn * The ARN of the topic to modify. */ public void setTopicArn(String topicArn) { this.topicArn = topicArn; } /** ** The ARN of the topic to modify. *
* * @return The ARN of the topic to modify. */ public String getTopicArn() { return this.topicArn; } /** ** The ARN of the topic to modify. *
* * @param topicArn * The ARN of the topic to modify. * @return Returns a reference to this object so that method calls can be chained together. */ public SetTopicAttributesRequest withTopicArn(String topicArn) { setTopicArn(topicArn); 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
* SetTopicAttributes
action uses:
*
* ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to a platform application endpoint.
*
* 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.
*
* Policy
– The policy that defines who can access your topic. By default, only the topic owner can
* publish or subscribe to the topic.
*
* 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.
*
* HTTP *
*
* HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an HTTP endpoint.
*
* HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon
* SNS topic that is subscribed to an HTTP endpoint.
*
* HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that
* is subscribed to an HTTP endpoint.
*
* Amazon Kinesis Data Firehose *
*
* FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* Lambda *
*
* LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an Lambda endpoint.
*
* LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that
* is subscribed to an Lambda endpoint.
*
* Platform application endpoint *
*
* ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon Web Services application endpoint.
*
* In addition to being able to configure topic attributes for message delivery status of notification messages sent * to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of * push notification messages sent to push notification services. *
** For example, For more information, see Using Amazon SNS Application Attributes for * Message Delivery Status. *
** Amazon SQS *
*
* SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon SQS endpoint.
*
* SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon
* SNS topic that is subscribed to an Amazon SQS endpoint.
*
* SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is
* subscribed to an Amazon SQS endpoint.
*
* The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give * Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate * attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you * configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate * CloudWatch Logs. *
** 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.
*
* 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
.
*
* The following attribute applies only to FIFO topics: *
*
* 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
* SetTopicAttributes
action uses:
*
* ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon
* SNS topic that is subscribed to a platform application endpoint.
*
* 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.
*
* Policy
– The policy that defines who can access your topic. By default, only the topic owner
* can publish or subscribe to the topic.
*
* 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.
*
* HTTP *
*
* HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an HTTP endpoint.
*
* HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an HTTP endpoint.
*
* HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an HTTP endpoint.
*
* Amazon Kinesis Data Firehose *
*
* FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon
* SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for
* an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* Lambda *
*
* LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Lambda endpoint.
*
* LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for
* an Amazon SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an Lambda endpoint.
*
* Platform application endpoint *
*
* ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an
* Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample
* for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon
* SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* In addition to being able to configure topic attributes for message delivery status of notification * messages sent to Amazon SNS application endpoints, you can also configure application attributes for the * delivery status of push notification messages sent to push notification services. *
** For example, For more information, see Using Amazon SNS Application * Attributes for Message Delivery Status. *
** Amazon SQS *
*
* SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon SQS endpoint.
*
* SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
*
* SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon SQS endpoint.
*
* The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used * to give Amazon SNS write access to use CloudWatch Logs on your behalf. The * <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) * of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn * attribute, then all failed message deliveries generate CloudWatch Logs. *
** 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.
*
* 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
.
*
* The following attribute applies only to FIFO topics: *
*
* 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
* SetTopicAttributes
action uses:
*
* ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to a platform application endpoint.
*
* 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.
*
* Policy
– The policy that defines who can access your topic. By default, only the topic owner can
* publish or subscribe to the topic.
*
* 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.
*
* HTTP *
*
* HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an HTTP endpoint.
*
* HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon
* SNS topic that is subscribed to an HTTP endpoint.
*
* HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that
* is subscribed to an HTTP endpoint.
*
* Amazon Kinesis Data Firehose *
*
* FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* Lambda *
*
* LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an Lambda endpoint.
*
* LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that
* is subscribed to an Lambda endpoint.
*
* Platform application endpoint *
*
* ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon Web Services application endpoint.
*
* In addition to being able to configure topic attributes for message delivery status of notification messages sent * to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of * push notification messages sent to push notification services. *
** For example, For more information, see Using Amazon SNS Application Attributes for * Message Delivery Status. *
** Amazon SQS *
*
* SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon SQS endpoint.
*
* SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon
* SNS topic that is subscribed to an Amazon SQS endpoint.
*
* SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is
* subscribed to an Amazon SQS endpoint.
*
* The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give * Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate * attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you * configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate * CloudWatch Logs. *
** 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.
*
* 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
.
*
* The following attribute applies only to FIFO topics: *
*
* 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
* SetTopicAttributes
action uses:
*
* ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon
* SNS topic that is subscribed to a platform application endpoint.
*
* 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.
*
* Policy
– The policy that defines who can access your topic. By default, only the topic owner
* can publish or subscribe to the topic.
*
* 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.
*
* HTTP *
*
* HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an HTTP endpoint.
*
* HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an HTTP endpoint.
*
* HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an HTTP endpoint.
*
* Amazon Kinesis Data Firehose *
*
* FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon
* SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample
* for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* Lambda *
*
* LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon
* SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for
* an Amazon SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an Lambda endpoint.
*
* Platform application endpoint *
*
* ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an
* Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample
* for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon
* SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* In addition to being able to configure topic attributes for message delivery status of notification * messages sent to Amazon SNS application endpoints, you can also configure application attributes for the * delivery status of push notification messages sent to push notification services. *
** For example, For more information, see Using Amazon SNS Application * Attributes for Message Delivery Status. *
** Amazon SQS *
*
* SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon SQS endpoint.
*
* SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
*
* SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon SQS endpoint.
*
* The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used * to give Amazon SNS write access to use CloudWatch Logs on your behalf. The * <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) * of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn * attribute, then all failed message deliveries generate CloudWatch Logs. *
** 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.
*
* 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
.
*
* The following attribute applies only to FIFO topics: *
*
* 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
* SetTopicAttributes
action uses:
*
* ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to a platform application endpoint.
*
* 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.
*
* Policy
– The policy that defines who can access your topic. By default, only the topic owner can
* publish or subscribe to the topic.
*
* 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.
*
* HTTP *
*
* HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an HTTP endpoint.
*
* HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon
* SNS topic that is subscribed to an HTTP endpoint.
*
* HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that
* is subscribed to an HTTP endpoint.
*
* Amazon Kinesis Data Firehose *
*
* FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* Lambda *
*
* LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an Lambda endpoint.
*
* LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that
* is subscribed to an Lambda endpoint.
*
* Platform application endpoint *
*
* ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon Web Services application endpoint.
*
* In addition to being able to configure topic attributes for message delivery status of notification messages sent * to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of * push notification messages sent to push notification services. *
** For example, For more information, see Using Amazon SNS Application Attributes for * Message Delivery Status. *
** Amazon SQS *
*
* SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon SQS endpoint.
*
* SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon
* SNS topic that is subscribed to an Amazon SQS endpoint.
*
* SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is
* subscribed to an Amazon SQS endpoint.
*
* The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give * Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate * attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you * configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate * CloudWatch Logs. *
** 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.
*
* 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
.
*
* The following attribute applies only to FIFO topics: *
*
* 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
* SetTopicAttributes
action uses:
*
* ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon
* SNS topic that is subscribed to a platform application endpoint.
*
* 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.
*
* Policy
– The policy that defines who can access your topic. By default, only the topic owner
* can publish or subscribe to the topic.
*
* 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.
*
* HTTP *
*
* HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an HTTP endpoint.
*
* HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an HTTP endpoint.
*
* HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an HTTP endpoint.
*
* Amazon Kinesis Data Firehose *
*
* FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon
* SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for
* an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
*
* Lambda *
*
* LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Lambda endpoint.
*
* LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for
* an Amazon SNS topic that is subscribed to an Lambda endpoint.
*
* LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS
* topic that is subscribed to an Lambda endpoint.
*
* Platform application endpoint *
*
* ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an
* Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample
* for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon
* SNS topic that is subscribed to an Amazon Web Services application endpoint.
*
* In addition to being able to configure topic attributes for message delivery status of notification * messages sent to Amazon SNS application endpoints, you can also configure application attributes for the * delivery status of push notification messages sent to push notification services. *
** For example, For more information, see Using Amazon SNS Application * Attributes for Message Delivery Status. *
** Amazon SQS *
*
* SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS
* topic that is subscribed to an Amazon SQS endpoint.
*
* SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an
* Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
*
* SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic
* that is subscribed to an Amazon SQS endpoint.
*
* The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used * to give Amazon SNS write access to use CloudWatch Logs on your behalf. The * <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) * of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn * attribute, then all failed message deliveries generate CloudWatch Logs. *
** 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.
*
* 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
.
*
* The following attribute applies only to FIFO topics: *
*
* 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 new value for the attribute. *
* * @param attributeValue * The new value for the attribute. */ public void setAttributeValue(String attributeValue) { this.attributeValue = attributeValue; } /** ** The new value for the attribute. *
* * @return The new value for the attribute. */ public String getAttributeValue() { return this.attributeValue; } /** ** The new value for the attribute. *
* * @param attributeValue * The new value for the attribute. * @return Returns a reference to this object so that method calls can be chained together. */ public SetTopicAttributesRequest withAttributeValue(String attributeValue) { setAttributeValue(attributeValue); 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 (getTopicArn() != null) sb.append("TopicArn: ").append(getTopicArn()).append(","); if (getAttributeName() != null) sb.append("AttributeName: ").append(getAttributeName()).append(","); if (getAttributeValue() != null) sb.append("AttributeValue: ").append(getAttributeValue()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SetTopicAttributesRequest == false) return false; SetTopicAttributesRequest other = (SetTopicAttributesRequest) obj; if (other.getTopicArn() == null ^ this.getTopicArn() == null) return false; if (other.getTopicArn() != null && other.getTopicArn().equals(this.getTopicArn()) == false) return false; if (other.getAttributeName() == null ^ this.getAttributeName() == null) return false; if (other.getAttributeName() != null && other.getAttributeName().equals(this.getAttributeName()) == false) return false; if (other.getAttributeValue() == null ^ this.getAttributeValue() == null) return false; if (other.getAttributeValue() != null && other.getAttributeValue().equals(this.getAttributeValue()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTopicArn() == null) ? 0 : getTopicArn().hashCode()); hashCode = prime * hashCode + ((getAttributeName() == null) ? 0 : getAttributeName().hashCode()); hashCode = prime * hashCode + ((getAttributeValue() == null) ? 0 : getAttributeValue().hashCode()); return hashCode; } @Override public SetTopicAttributesRequest clone() { return (SetTopicAttributesRequest) super.clone(); } }