/** * 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 SetSubscriptionAttributes action.

See Also:

AWS * API Reference

*/ class SetSubscriptionAttributesRequest : public SNSRequest { public: AWS_SNS_API SetSubscriptionAttributesRequest(); // 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 "SetSubscriptionAttributes"; } 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 subscription to modify.

*/ inline const Aws::String& GetSubscriptionArn() const{ return m_subscriptionArn; } /** *

The ARN of the subscription to modify.

*/ inline bool SubscriptionArnHasBeenSet() const { return m_subscriptionArnHasBeenSet; } /** *

The ARN of the subscription to modify.

*/ inline void SetSubscriptionArn(const Aws::String& value) { m_subscriptionArnHasBeenSet = true; m_subscriptionArn = value; } /** *

The ARN of the subscription to modify.

*/ inline void SetSubscriptionArn(Aws::String&& value) { m_subscriptionArnHasBeenSet = true; m_subscriptionArn = std::move(value); } /** *

The ARN of the subscription to modify.

*/ inline void SetSubscriptionArn(const char* value) { m_subscriptionArnHasBeenSet = true; m_subscriptionArn.assign(value); } /** *

The ARN of the subscription to modify.

*/ inline SetSubscriptionAttributesRequest& WithSubscriptionArn(const Aws::String& value) { SetSubscriptionArn(value); return *this;} /** *

The ARN of the subscription to modify.

*/ inline SetSubscriptionAttributesRequest& WithSubscriptionArn(Aws::String&& value) { SetSubscriptionArn(std::move(value)); return *this;} /** *

The ARN of the subscription to modify.

*/ inline SetSubscriptionAttributesRequest& WithSubscriptionArn(const char* value) { SetSubscriptionArn(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 * this action uses:

  • DeliveryPolicy – The policy * that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    *
  • FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic.

  • * FilterPolicyScope – This attribute lets you choose the filtering * scope by using one of the following string value types:

    • * MessageAttributes (default) – The filter is applied on the message * attributes.

    • MessageBody – The filter is applied * on the message body.

  • * RawMessageDelivery – When set to true, enables raw * message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for * the endpoints to process JSON formatting, which is otherwise created for Amazon * SNS metadata.

  • RedrivePolicy – When specified, * sends undeliverable messages to the specified Amazon SQS dead-letter queue. * Messages that can't be delivered due to client errors (for example, when the * subscribed endpoint is unreachable) or server errors (for example, when the * service that powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing.

The * following attribute applies only to Amazon Kinesis Data Firehose delivery stream * subscriptions:

  • SubscriptionRoleArn – The ARN of * the IAM role that has the following:

    • Permission to write to the * Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a * trusted entity

    Specifying a valid ARN for this attribute is * required for Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

*/ 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 * this action uses:

  • DeliveryPolicy – The policy * that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    *
  • FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic.

  • * FilterPolicyScope – This attribute lets you choose the filtering * scope by using one of the following string value types:

    • * MessageAttributes (default) – The filter is applied on the message * attributes.

    • MessageBody – The filter is applied * on the message body.

  • * RawMessageDelivery – When set to true, enables raw * message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for * the endpoints to process JSON formatting, which is otherwise created for Amazon * SNS metadata.

  • RedrivePolicy – When specified, * sends undeliverable messages to the specified Amazon SQS dead-letter queue. * Messages that can't be delivered due to client errors (for example, when the * subscribed endpoint is unreachable) or server errors (for example, when the * service that powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing.

The * following attribute applies only to Amazon Kinesis Data Firehose delivery stream * subscriptions:

  • SubscriptionRoleArn – The ARN of * the IAM role that has the following:

    • Permission to write to the * Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a * trusted entity

    Specifying a valid ARN for this attribute is * required for Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

*/ 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 * this action uses:

  • DeliveryPolicy – The policy * that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    *
  • FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic.

  • * FilterPolicyScope – This attribute lets you choose the filtering * scope by using one of the following string value types:

    • * MessageAttributes (default) – The filter is applied on the message * attributes.

    • MessageBody – The filter is applied * on the message body.

  • * RawMessageDelivery – When set to true, enables raw * message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for * the endpoints to process JSON formatting, which is otherwise created for Amazon * SNS metadata.

  • RedrivePolicy – When specified, * sends undeliverable messages to the specified Amazon SQS dead-letter queue. * Messages that can't be delivered due to client errors (for example, when the * subscribed endpoint is unreachable) or server errors (for example, when the * service that powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing.

The * following attribute applies only to Amazon Kinesis Data Firehose delivery stream * subscriptions:

  • SubscriptionRoleArn – The ARN of * the IAM role that has the following:

    • Permission to write to the * Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a * trusted entity

    Specifying a valid ARN for this attribute is * required for Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

*/ 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 * this action uses:

  • DeliveryPolicy – The policy * that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    *
  • FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic.

  • * FilterPolicyScope – This attribute lets you choose the filtering * scope by using one of the following string value types:

    • * MessageAttributes (default) – The filter is applied on the message * attributes.

    • MessageBody – The filter is applied * on the message body.

  • * RawMessageDelivery – When set to true, enables raw * message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for * the endpoints to process JSON formatting, which is otherwise created for Amazon * SNS metadata.

  • RedrivePolicy – When specified, * sends undeliverable messages to the specified Amazon SQS dead-letter queue. * Messages that can't be delivered due to client errors (for example, when the * subscribed endpoint is unreachable) or server errors (for example, when the * service that powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing.

The * following attribute applies only to Amazon Kinesis Data Firehose delivery stream * subscriptions:

  • SubscriptionRoleArn – The ARN of * the IAM role that has the following:

    • Permission to write to the * Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a * trusted entity

    Specifying a valid ARN for this attribute is * required for Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

*/ 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 * this action uses:

  • DeliveryPolicy – The policy * that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    *
  • FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic.

  • * FilterPolicyScope – This attribute lets you choose the filtering * scope by using one of the following string value types:

    • * MessageAttributes (default) – The filter is applied on the message * attributes.

    • MessageBody – The filter is applied * on the message body.

  • * RawMessageDelivery – When set to true, enables raw * message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for * the endpoints to process JSON formatting, which is otherwise created for Amazon * SNS metadata.

  • RedrivePolicy – When specified, * sends undeliverable messages to the specified Amazon SQS dead-letter queue. * Messages that can't be delivered due to client errors (for example, when the * subscribed endpoint is unreachable) or server errors (for example, when the * service that powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing.

The * following attribute applies only to Amazon Kinesis Data Firehose delivery stream * subscriptions:

  • SubscriptionRoleArn – The ARN of * the IAM role that has the following:

    • Permission to write to the * Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a * trusted entity

    Specifying a valid ARN for this attribute is * required for Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

*/ 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 * this action uses:

  • DeliveryPolicy – The policy * that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    *
  • FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic.

  • * FilterPolicyScope – This attribute lets you choose the filtering * scope by using one of the following string value types:

    • * MessageAttributes (default) – The filter is applied on the message * attributes.

    • MessageBody – The filter is applied * on the message body.

  • * RawMessageDelivery – When set to true, enables raw * message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for * the endpoints to process JSON formatting, which is otherwise created for Amazon * SNS metadata.

  • RedrivePolicy – When specified, * sends undeliverable messages to the specified Amazon SQS dead-letter queue. * Messages that can't be delivered due to client errors (for example, when the * subscribed endpoint is unreachable) or server errors (for example, when the * service that powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing.

The * following attribute applies only to Amazon Kinesis Data Firehose delivery stream * subscriptions:

  • SubscriptionRoleArn – The ARN of * the IAM role that has the following:

    • Permission to write to the * Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a * trusted entity

    Specifying a valid ARN for this attribute is * required for Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

*/ inline SetSubscriptionAttributesRequest& 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 * this action uses:

  • DeliveryPolicy – The policy * that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    *
  • FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic.

  • * FilterPolicyScope – This attribute lets you choose the filtering * scope by using one of the following string value types:

    • * MessageAttributes (default) – The filter is applied on the message * attributes.

    • MessageBody – The filter is applied * on the message body.

  • * RawMessageDelivery – When set to true, enables raw * message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for * the endpoints to process JSON formatting, which is otherwise created for Amazon * SNS metadata.

  • RedrivePolicy – When specified, * sends undeliverable messages to the specified Amazon SQS dead-letter queue. * Messages that can't be delivered due to client errors (for example, when the * subscribed endpoint is unreachable) or server errors (for example, when the * service that powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing.

The * following attribute applies only to Amazon Kinesis Data Firehose delivery stream * subscriptions:

  • SubscriptionRoleArn – The ARN of * the IAM role that has the following:

    • Permission to write to the * Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a * trusted entity

    Specifying a valid ARN for this attribute is * required for Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

*/ inline SetSubscriptionAttributesRequest& 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 * this action uses:

  • DeliveryPolicy – The policy * that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    *
  • FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic.

  • * FilterPolicyScope – This attribute lets you choose the filtering * scope by using one of the following string value types:

    • * MessageAttributes (default) – The filter is applied on the message * attributes.

    • MessageBody – The filter is applied * on the message body.

  • * RawMessageDelivery – When set to true, enables raw * message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for * the endpoints to process JSON formatting, which is otherwise created for Amazon * SNS metadata.

  • RedrivePolicy – When specified, * sends undeliverable messages to the specified Amazon SQS dead-letter queue. * Messages that can't be delivered due to client errors (for example, when the * subscribed endpoint is unreachable) or server errors (for example, when the * service that powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing.

The * following attribute applies only to Amazon Kinesis Data Firehose delivery stream * subscriptions:

  • SubscriptionRoleArn – The ARN of * the IAM role that has the following:

    • Permission to write to the * Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a * trusted entity

    Specifying a valid ARN for this attribute is * required for Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

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

The new value for the attribute in JSON format.

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

The new value for the attribute in JSON format.

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

The new value for the attribute in JSON format.

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

The new value for the attribute in JSON format.

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

The new value for the attribute in JSON format.

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

The new value for the attribute in JSON format.

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

The new value for the attribute in JSON format.

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

The new value for the attribute in JSON format.

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