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. Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

  • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

Returns:

  • (String)


1994
1995
1996
1997
1998
1999
2000
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1994

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)


1994
1995
1996
1997
1998
1999
2000
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1994

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)


1994
1995
1996
1997
1998
1999
2000
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 1994

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