software.amazon.awssdk.services.sns.model

Interface SetTopicAttributesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SetTopicAttributesRequest.Builder,SetTopicAttributesRequest>, SdkBuilder<SetTopicAttributesRequest.Builder,SetTopicAttributesRequest>, SdkPojo, SdkRequest.Builder, SnsRequest.Builder

Enclosing class:

SetTopicAttributesRequest

public static interface SetTopicAttributesRequest.Builder
extends SnsRequest.Builder, SdkPojo, CopyableBuilder<SetTopicAttributesRequest.Builder,SetTopicAttributesRequest>

Method Summary

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.

Methods inherited from interface software.amazon.awssdk.services.sns.model.SnsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

topicArn

SetTopicAttributesRequest.Builder topicArn(String topicArn)

The ARN of the topic to modify.

Parameters:

topicArn - The ARN of the topic to modify.

Returns:

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

attributeName

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.

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.

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

Returns:

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

attributeValue

SetTopicAttributesRequest.Builder attributeValue(String attributeValue)

The new value for the attribute.

Parameters:

attributeValue - The new value for the attribute.

Returns:

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

overrideConfiguration

SetTopicAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

SetTopicAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder