Class SetTopicAttributesRequest

Namespace

Amazon.SimpleNotificationService.Model

Assembly

AWSSDK.SimpleNotificationService.dll

Container for the parameters to the SetTopicAttributes operation. Allows a topic owner to set an attribute of the topic to a new value.

public class SetTopicAttributesRequest : AmazonSimpleNotificationServiceRequest

Inheritance

object

AmazonSimpleNotificationServiceRequest

SetTopicAttributesRequest

Constructors

SetTopicAttributesRequest()

Empty constructor used to set properties independently even when a simple constructor is available

public SetTopicAttributesRequest()

SetTopicAttributesRequest(string, string, string)

Instantiates SetTopicAttributesRequest with the parameterized properties

public SetTopicAttributesRequest(string topicArn, string attributeName, string attributeValue)

Parameters

topicArn string

The ARN of the topic to modify.

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

attributeValue string

The new value for the attribute.

Properties

AttributeName

Gets and sets the property AttributeName.

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.

public string AttributeName { get; set; }

Property Value

string

AttributeValue

Gets and sets the property AttributeValue.

The new value for the attribute.

public string AttributeValue { get; set; }

Property Value

string

TopicArn

Gets and sets the property TopicArn.

The ARN of the topic to modify.

public string TopicArn { get; set; }

Property Value

string