Class: Aws::SNS::Types::SetTopicAttributesInput

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

Overview

Note:

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

{
  topic_arn: "topicARN", # required
  attribute_name: "attributeName", # required
  attribute_value: "attributeValue",
}

Input for SetTopicAttributes action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

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:

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

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId – The ID of an AWS-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 AWS Key Management Service API Reference.

^

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 the MessageDeduplicationId parameter for the Publish action.

Returns:

  • (String)


2032
2033
2034
2035
2036
2037
2038
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2032

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

#attribute_valueString

The new value for the attribute.

Returns:

  • (String)


2032
2033
2034
2035
2036
2037
2038
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2032

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

#topic_arnString

The ARN of the topic to modify.

Returns:

  • (String)


2032
2033
2034
2035
2036
2037
2038
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2032

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