Package software.amazon.awssdk.services.sns.model

Class SetSubscriptionAttributesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sns.model.SnsRequest
software.amazon.awssdk.services.sns.model.SetSubscriptionAttributesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SetSubscriptionAttributesRequest.Builder,SetSubscriptionAttributesRequest>
@Generated("software.amazon.awssdk:codegen") public final class SetSubscriptionAttributesRequest extends SnsRequest implements ToCopyableBuilder<SetSubscriptionAttributesRequest.Builder,SetSubscriptionAttributesRequest>

Input for SetSubscriptionAttributes action.

  • Method Details

    • subscriptionArn

      public final String subscriptionArn()

      The ARN of the subscription to modify.

      Returns:
      The ARN of the subscription to modify.

    • attributeName

      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 this action uses:

      • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

      • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

      • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:

        • MessageAttributes (default) – The filter is applied on the message attributes.

        • MessageBody – The filter is applied on the message body.

      • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

      • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

      The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

      • SubscriptionRoleArn – The ARN of the IAM role that has the following:

        • Permission to write to the Kinesis Data Firehose delivery stream

        • Amazon SNS listed as a trusted entity

        Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

      Returns:
      A map of attributes with their corresponding values.

      The following lists the names, descriptions, and values of the special request parameters that this action uses:

      • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

      • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

      • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:

        • MessageAttributes (default) – The filter is applied on the message attributes.

        • MessageBody – The filter is applied on the message body.

      • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

      • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

      The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

      • SubscriptionRoleArn – The ARN of the IAM role that has the following:

        • Permission to write to the Kinesis Data Firehose delivery stream

        • Amazon SNS listed as a trusted entity

        Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

    • attributeValue

      public final String attributeValue()

      The new value for the attribute in JSON format.

      Returns:
      The new value for the attribute in JSON format.

    • toBuilder

      public SetSubscriptionAttributesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SetSubscriptionAttributesRequest.Builder,SetSubscriptionAttributesRequest>
      Specified by:
      toBuilder in class SnsRequest
      Returns:
      a builder for type T

    • builder

      public static SetSubscriptionAttributesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SetSubscriptionAttributesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.