public static interface SetTopicAttributesRequest.Builder extends SnsRequest.Builder, SdkPojo, CopyableBuilder<SetTopicAttributesRequest.Builder,SetTopicAttributesRequest>
Modifier and Type | Method and Description |
---|---|
SetTopicAttributesRequest.Builder |
attributeName(String attributeName)
A map of attributes with their corresponding values.
|
SetTopicAttributesRequest.Builder |
attributeValue(String attributeValue)
The new value for the attribute.
|
SetTopicAttributesRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
SetTopicAttributesRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
SetTopicAttributesRequest.Builder |
topicArn(String topicArn)
The ARN of the topic to modify.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
SetTopicAttributesRequest.Builder topicArn(String topicArn)
The ARN of the topic to modify.
topicArn
- The ARN of the topic to modify.SetTopicAttributesRequest.Builder attributeName(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.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is
set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon
SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner
account if the sampled flag in the tracing header is true. This is only supported on standard topics.
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.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while
creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages
sent by Amazon SNS.
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.
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.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default
TracingConfig
is set to PassThrough
, and the topic passes through the
tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon
SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is
true. This is only supported on standard topics.
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.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while
creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation
messages sent by Amazon SNS.
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.
SetTopicAttributesRequest.Builder attributeValue(String attributeValue)
The new value for the attribute.
attributeValue
- The new value for the attribute.SetTopicAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
SetTopicAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2022. All rights reserved.