/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace SNS { namespace Model { /** *

Input for SetTopicAttributes action.

See Also:

AWS * API Reference

*/ class SetTopicAttributesRequest : public SNSRequest { public: AWS_SNS_API SetTopicAttributesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "SetTopicAttributes"; } AWS_SNS_API Aws::String SerializePayload() const override; protected: AWS_SNS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The ARN of the topic to modify.

*/ inline const Aws::String& GetTopicArn() const{ return m_topicArn; } /** *

The ARN of the topic to modify.

*/ inline bool TopicArnHasBeenSet() const { return m_topicArnHasBeenSet; } /** *

The ARN of the topic to modify.

*/ inline void SetTopicArn(const Aws::String& value) { m_topicArnHasBeenSet = true; m_topicArn = value; } /** *

The ARN of the topic to modify.

*/ inline void SetTopicArn(Aws::String&& value) { m_topicArnHasBeenSet = true; m_topicArn = std::move(value); } /** *

The ARN of the topic to modify.

*/ inline void SetTopicArn(const char* value) { m_topicArnHasBeenSet = true; m_topicArn.assign(value); } /** *

The ARN of the topic to modify.

*/ inline SetTopicAttributesRequest& WithTopicArn(const Aws::String& value) { SetTopicArn(value); return *this;} /** *

The ARN of the topic to modify.

*/ inline SetTopicAttributesRequest& WithTopicArn(Aws::String&& value) { SetTopicArn(std::move(value)); return *this;} /** *

The ARN of the topic to modify.

*/ inline SetTopicAttributesRequest& WithTopicArn(const char* value) { SetTopicArn(value); 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.

*/ inline const Aws::String& GetAttributeName() const{ return m_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.

*/ inline bool AttributeNameHasBeenSet() const { return m_attributeNameHasBeenSet; } /** *

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.

*/ inline void SetAttributeName(const Aws::String& value) { m_attributeNameHasBeenSet = true; m_attributeName = value; } /** *

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.

*/ inline void SetAttributeName(Aws::String&& value) { m_attributeNameHasBeenSet = true; m_attributeName = std::move(value); } /** *

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.

*/ inline void SetAttributeName(const char* value) { m_attributeNameHasBeenSet = true; m_attributeName.assign(value); } /** *

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.

*/ inline SetTopicAttributesRequest& WithAttributeName(const Aws::String& value) { SetAttributeName(value); 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.

*/ inline SetTopicAttributesRequest& WithAttributeName(Aws::String&& value) { SetAttributeName(std::move(value)); 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.

*/ inline SetTopicAttributesRequest& WithAttributeName(const char* value) { SetAttributeName(value); return *this;} /** *

The new value for the attribute.

*/ inline const Aws::String& GetAttributeValue() const{ return m_attributeValue; } /** *

The new value for the attribute.

*/ inline bool AttributeValueHasBeenSet() const { return m_attributeValueHasBeenSet; } /** *

The new value for the attribute.

*/ inline void SetAttributeValue(const Aws::String& value) { m_attributeValueHasBeenSet = true; m_attributeValue = value; } /** *

The new value for the attribute.

*/ inline void SetAttributeValue(Aws::String&& value) { m_attributeValueHasBeenSet = true; m_attributeValue = std::move(value); } /** *

The new value for the attribute.

*/ inline void SetAttributeValue(const char* value) { m_attributeValueHasBeenSet = true; m_attributeValue.assign(value); } /** *

The new value for the attribute.

*/ inline SetTopicAttributesRequest& WithAttributeValue(const Aws::String& value) { SetAttributeValue(value); return *this;} /** *

The new value for the attribute.

*/ inline SetTopicAttributesRequest& WithAttributeValue(Aws::String&& value) { SetAttributeValue(std::move(value)); return *this;} /** *

The new value for the attribute.

*/ inline SetTopicAttributesRequest& WithAttributeValue(const char* value) { SetAttributeValue(value); return *this;} private: Aws::String m_topicArn; bool m_topicArnHasBeenSet = false; Aws::String m_attributeName; bool m_attributeNameHasBeenSet = false; Aws::String m_attributeValue; bool m_attributeValueHasBeenSet = false; }; } // namespace Model } // namespace SNS } // namespace Aws