com.amazonaws.services.sns.model

Class SetTopicAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.SetTopicAttributesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SetTopicAttributesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Allows a topic owner to set an attribute of the topic to a new value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetTopicAttributesRequest() Default constructor for SetTopicAttributesRequest object.
SetTopicAttributesRequest(java.lang.String topicArn, java.lang.String attributeName, java.lang.String attributeValue) Constructs a new SetTopicAttributesRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAttributeName() A map of attributes with their corresponding values.
java.lang.String	getAttributeValue() The new value for the attribute.
java.lang.String	getTopicArn() The ARN of the topic to modify.
int	hashCode()
void	setAttributeName(java.lang.String attributeName) A map of attributes with their corresponding values.
void	setAttributeValue(java.lang.String attributeValue) The new value for the attribute.
void	setTopicArn(java.lang.String topicArn) The ARN of the topic to modify.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SetTopicAttributesRequest	withAttributeName(java.lang.String attributeName) A map of attributes with their corresponding values.
SetTopicAttributesRequest	withAttributeValue(java.lang.String attributeValue) The new value for the attribute.
SetTopicAttributesRequest	withTopicArn(java.lang.String topicArn) The ARN of the topic to modify.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetTopicAttributesRequest

public SetTopicAttributesRequest()

Default constructor for SetTopicAttributesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

SetTopicAttributesRequest

public SetTopicAttributesRequest(java.lang.String topicArn,
                                 java.lang.String attributeName,
                                 java.lang.String attributeValue)

Constructs a new SetTopicAttributesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

topicArn -

The ARN of the topic to modify.

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.

attributeValue -

The new value for the attribute.

Method Detail

getTopicArn

public java.lang.String getTopicArn()

The ARN of the topic to modify.

Returns:

The ARN of the topic to modify.

setTopicArn

public void setTopicArn(java.lang.String topicArn)

The ARN of the topic to modify.

Parameters:

topicArn -

The ARN of the topic to modify.

withTopicArn

public SetTopicAttributesRequest withTopicArn(java.lang.String topicArn)

The ARN of the topic to modify.

Returns a reference to this object so that method calls can be chained together.

Parameters:

topicArn -

The ARN of the topic to modify.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributeName

public java.lang.String getAttributeName()

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:

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.

setAttributeName

public void setAttributeName(java.lang.String 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.

Parameters:

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.

withAttributeName

public SetTopicAttributesRequest withAttributeName(java.lang.String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributeValue

public java.lang.String getAttributeValue()

The new value for the attribute.

Returns:

The new value for the attribute.

setAttributeValue

public void setAttributeValue(java.lang.String attributeValue)

The new value for the attribute.

Parameters:

attributeValue -

The new value for the attribute.

withAttributeValue

public SetTopicAttributesRequest withAttributeValue(java.lang.String attributeValue)

The new value for the attribute.

Returns a reference to this object so that method calls can be chained together.

Parameters:

attributeValue -

The new value for the attribute.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object