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

Inherits:

Struct

• Object
• Struct
• Aws::SNS::Types::SetSubscriptionAttributesInput

Defined in:

gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb

Overview

Note:

When making an API call, you may pass SetSubscriptionAttributesInput data as a hash:

{
  subscription_arn: "subscriptionARN", # required
  attribute_name: "attributeName", # required
  attribute_value: "attributeValue",
}

Input for SetSubscriptionAttributes action.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attribute_name ⇒ String

  A map of attributes with their corresponding values.

• #attribute_value ⇒ String

  The new value for the attribute in JSON format.

• #subscription_arn ⇒ String

  The ARN of the subscription to modify.

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.

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

Returns:

• (String)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2617

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)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2617

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)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2617

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