Class: Aws::SNS::Types::SetTopicAttributesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SNS::Types::SetTopicAttributesInput
- Defined in:
- gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb
Overview
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
-
#attribute_name ⇒ String
A map of attributes with their corresponding values.
-
#attribute_value ⇒ String
The new value for the attribute.
-
#topic_arn ⇒ String
The ARN of the topic 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 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 tofalse
. If you create a FIFO topic and this attribute isfalse
, you must specify a value for theMessageDeduplicationId
parameter for the Publish action.When you set
ContentBasedDeduplication
totrue
, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationId
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 thePublish
action.
2067 2068 2069 2070 2071 2072 2073 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2067 class SetTopicAttributesInput < Struct.new( :topic_arn, :attribute_name, :attribute_value) SENSITIVE = [] include Aws::Structure end |
#attribute_value ⇒ String
The new value for the attribute.
2067 2068 2069 2070 2071 2072 2073 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2067 class SetTopicAttributesInput < Struct.new( :topic_arn, :attribute_name, :attribute_value) SENSITIVE = [] include Aws::Structure end |
#topic_arn ⇒ String
The ARN of the topic to modify.
2067 2068 2069 2070 2071 2072 2073 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 2067 class SetTopicAttributesInput < Struct.new( :topic_arn, :attribute_name, :attribute_value) SENSITIVE = [] include Aws::Structure end |