Interface SubscribeRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SubscribeRequest.Builder,
,SubscribeRequest> SdkBuilder<SubscribeRequest.Builder,
,SubscribeRequest> SdkPojo
,SdkRequest.Builder
,SnsRequest.Builder
- Enclosing class:
SubscribeRequest
-
Method Summary
Modifier and TypeMethodDescriptionattributes
(Map<String, String> attributes) A map of attributes with their corresponding values.The endpoint that you want to receive notifications.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The protocol that you want to use.returnSubscriptionArn
(Boolean returnSubscriptionArn) Sets whether the response from theSubscribe
request includes the subscription ARN, even if the subscription is not yet confirmed.The ARN of the topic you want to subscribe to.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 Details
-
topicArn
The ARN of the topic you want to subscribe to.
- Parameters:
topicArn
- The ARN of the topic you want to subscribe to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocol
The protocol that you want to use. Supported protocols include:
-
http
– delivery of JSON-encoded message via HTTP POST -
https
– delivery of JSON-encoded message via HTTPS POST -
email
– delivery of message via SMTP -
email-json
– delivery of JSON-encoded message via SMTP -
sms
– delivery of message via SMS -
sqs
– delivery of JSON-encoded message to an Amazon SQS queue -
application
– delivery of JSON-encoded message to an EndpointArn for a mobile app and device -
lambda
– delivery of JSON-encoded message to an Lambda function -
firehose
– delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
- Parameters:
protocol
- The protocol that you want to use. Supported protocols include:-
http
– delivery of JSON-encoded message via HTTP POST -
https
– delivery of JSON-encoded message via HTTPS POST -
email
– delivery of message via SMTP -
email-json
– delivery of JSON-encoded message via SMTP -
sms
– delivery of message via SMS -
sqs
– delivery of JSON-encoded message to an Amazon SQS queue -
application
– delivery of JSON-encoded message to an EndpointArn for a mobile app and device -
lambda
– delivery of JSON-encoded message to an Lambda function -
firehose
– delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
endpoint
The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the
http
protocol, the (public) endpoint is a URL beginning withhttp://
. -
For the
https
protocol, the (public) endpoint is a URL beginning withhttps://
. -
For the
email
protocol, the endpoint is an email address. -
For the
email-json
protocol, the endpoint is an email address. -
For the
sms
protocol, the endpoint is a phone number of an SMS-enabled device. -
For the
sqs
protocol, the endpoint is the ARN of an Amazon SQS queue. -
For the
application
protocol, the endpoint is the EndpointArn of a mobile app and device. -
For the
lambda
protocol, the endpoint is the ARN of an Lambda function. -
For the
firehose
protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
- Parameters:
endpoint
- The endpoint that you want to receive notifications. Endpoints vary by protocol:-
For the
http
protocol, the (public) endpoint is a URL beginning withhttp://
. -
For the
https
protocol, the (public) endpoint is a URL beginning withhttps://
. -
For the
email
protocol, the endpoint is an email address. -
For the
email-json
protocol, the endpoint is an email address. -
For the
sms
protocol, the endpoint is a phone number of an SMS-enabled device. -
For the
sqs
protocol, the endpoint is the ARN of an Amazon SQS queue. -
For the
application
protocol, the endpoint is the EndpointArn of a mobile app and device. -
For the
lambda
protocol, the endpoint is the ARN of an Lambda function. -
For the
firehose
protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
attributes
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
Subscribe
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.
-
The following attributes apply only to FIFO topics:
-
ReplayPolicy
– Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic. -
ReplayStatus
– Retrieves the status of the subscription message replay, which can be one of the following:-
Completed
– The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in theReplayPolicy
then the subscription will no longer receive newly published messages. -
In progress
– The replay is currently replaying the selected messages. -
Failed
– The replay was unable to complete. -
Pending
– The default state while the replay initiates.
-
- Parameters:
attributes
- A map of attributes with their corresponding values.The following lists the names, descriptions, and values of the special request parameters that the
Subscribe
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.
-
The following attributes apply only to FIFO topics:
-
ReplayPolicy
– Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic. -
ReplayStatus
– Retrieves the status of the subscription message replay, which can be one of the following:-
Completed
– The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in theReplayPolicy
then the subscription will no longer receive newly published messages. -
In progress
– The replay is currently replaying the selected messages. -
Failed
– The replay was unable to complete. -
Pending
– The default state while the replay initiates.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
returnSubscriptionArn
Sets whether the response from the
Subscribe
request includes the subscription ARN, even if the subscription is not yet confirmed.If you set this parameter to
true
, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes thepending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls theConfirmSubscription
action with a confirmation token.The default value is
false
.- Parameters:
returnSubscriptionArn
- Sets whether the response from theSubscribe
request includes the subscription ARN, even if the subscription is not yet confirmed.If you set this parameter to
true
, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes thepending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls theConfirmSubscription
action with a confirmation token.The default value is
false
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SubscribeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SubscribeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-