@Generated(value="software.amazon.awssdk:codegen") public final class SetTopicAttributesRequest extends SnsRequest implements ToCopyableBuilder<SetTopicAttributesRequest.Builder,SetTopicAttributesRequest>
Input for SetTopicAttributes action.
| Modifier and Type | Class and Description |
|---|---|
static interface |
SetTopicAttributesRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
attributeName()
A map of attributes with their corresponding values.
|
String |
attributeValue()
The new value for the attribute.
|
static SetTopicAttributesRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends SetTopicAttributesRequest.Builder> |
serializableBuilderClass() |
SetTopicAttributesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
topicArn()
The ARN of the topic to modify.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String topicArn()
The ARN of the topic to modify.
public final 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 Amazon Web Services 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 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 MessageDeduplicationId
parameter for the Publish action.
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 Amazon Web Services 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 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
MessageDeduplicationId parameter for the Publish action.
public final String attributeValue()
The new value for the attribute.
public SetTopicAttributesRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<SetTopicAttributesRequest.Builder,SetTopicAttributesRequest>toBuilder in class SnsRequestpublic static SetTopicAttributesRequest.Builder builder()
public static Class<? extends SetTopicAttributesRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.