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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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.

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 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][3

    in the *AWS Key

    Management Service API Reference*.

^

[1]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms [3]: docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters

Returns:

  • (String) 


1914
1915
1916
1917
1918
1919
1920
 
# File 'lib/aws-sdk-sns/types.rb', line 1914

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

#attribute_value ⇒ String

The new value for the attribute.

Returns:

  • (String) 


1914
1915
1916
1917
1918
1919
1920
 
# File 'lib/aws-sdk-sns/types.rb', line 1914

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.

Returns:

  • (String) 


1914
1915
1916
1917
1918
1919
1920
 
# File 'lib/aws-sdk-sns/types.rb', line 1914

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