Interface SetSubscriptionAttributesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SetSubscriptionAttributesRequest.Builder,SetSubscriptionAttributesRequest>
,SdkBuilder<SetSubscriptionAttributesRequest.Builder,SetSubscriptionAttributesRequest>
,SdkPojo
,SdkRequest.Builder
,SnsRequest.Builder
- Enclosing class:
- SetSubscriptionAttributesRequest
public static interface SetSubscriptionAttributesRequest.Builder extends SnsRequest.Builder, SdkPojo, CopyableBuilder<SetSubscriptionAttributesRequest.Builder,SetSubscriptionAttributesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SetSubscriptionAttributesRequest.Builder
attributeName(String attributeName)
A map of attributes with their corresponding values.SetSubscriptionAttributesRequest.Builder
attributeValue(String attributeValue)
The new value for the attribute in JSON format.SetSubscriptionAttributesRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SetSubscriptionAttributesRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SetSubscriptionAttributesRequest.Builder
subscriptionArn(String subscriptionArn)
The ARN of the subscription to modify.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.services.sns.model.SnsRequest.Builder
build
-
-
-
-
Method Detail
-
subscriptionArn
SetSubscriptionAttributesRequest.Builder subscriptionArn(String subscriptionArn)
The ARN of the subscription to modify.
- Parameters:
subscriptionArn
- The ARN of the subscription to modify.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeName
SetSubscriptionAttributesRequest.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 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 totrue
, 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.
-
- Parameters:
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 totrue
, 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
attributeValue
SetSubscriptionAttributesRequest.Builder attributeValue(String attributeValue)
The new value for the attribute in JSON format.
- Parameters:
attributeValue
- The new value for the attribute in JSON format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SetSubscriptionAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
SetSubscriptionAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-