Class: Aws::SNS::Types::SetSubscriptionAttributesInput

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sns/types.rb

Overview

Input for SetSubscriptionAttributes action.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_name ⇒ String

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*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html

Returns:

  • (String) 


2465
2466
2467
2468
2469
2470
2471
 
# File 'lib/aws-sdk-sns/types.rb', line 2465

class SetSubscriptionAttributesInput < Struct.new(
  :subscription_arn,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_value ⇒ String

The new value for the attribute in JSON format.

Returns:

  • (String) 


2465
2466
2467
2468
2469
2470
2471
 
# File 'lib/aws-sdk-sns/types.rb', line 2465

class SetSubscriptionAttributesInput < Struct.new(
  :subscription_arn,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_arn ⇒ String

The ARN of the subscription to modify.

Returns:

  • (String) 


2465
2466
2467
2468
2469
2470
2471
 
# File 'lib/aws-sdk-sns/types.rb', line 2465

class SetSubscriptionAttributesInput < Struct.new(
  :subscription_arn,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end