@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SubscribeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input for Subscribe action.
NOOP
Constructor and Description |
---|
SubscribeRequest()
Default constructor for SubscribeRequest object.
|
SubscribeRequest(String topicArn,
String protocol,
String endpoint)
Constructs a new SubscribeRequest object.
|
Modifier and Type | Method and Description |
---|---|
SubscribeRequest |
addAttributesEntry(String key,
String value)
Add a single Attributes entry
|
SubscribeRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
SubscribeRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
A map of attributes with their corresponding values.
|
String |
getEndpoint()
The endpoint that you want to receive notifications.
|
String |
getProtocol()
The protocol that you want to use.
|
Boolean |
getReturnSubscriptionArn()
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
String |
getTopicArn()
The ARN of the topic you want to subscribe to.
|
int |
hashCode() |
Boolean |
isReturnSubscriptionArn()
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
void |
setAttributes(Map<String,String> attributes)
A map of attributes with their corresponding values.
|
void |
setEndpoint(String endpoint)
The endpoint that you want to receive notifications.
|
void |
setProtocol(String protocol)
The protocol that you want to use.
|
void |
setReturnSubscriptionArn(Boolean returnSubscriptionArn)
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
void |
setTopicArn(String topicArn)
The ARN of the topic you want to subscribe to.
|
String |
toString()
Returns a string representation of this object.
|
SubscribeRequest |
withAttributes(Map<String,String> attributes)
A map of attributes with their corresponding values.
|
SubscribeRequest |
withEndpoint(String endpoint)
The endpoint that you want to receive notifications.
|
SubscribeRequest |
withProtocol(String protocol)
The protocol that you want to use.
|
SubscribeRequest |
withReturnSubscriptionArn(Boolean returnSubscriptionArn)
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
SubscribeRequest |
withTopicArn(String topicArn)
The ARN of the topic you want to subscribe to.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public SubscribeRequest()
public SubscribeRequest(String topicArn, String protocol, String endpoint)
topicArn
- The ARN of the topic you want to subscribe to.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.
endpoint
- The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http
protocol, the (public) endpoint is a URL beginning with http://
.
For the https
protocol, the (public) endpoint is a URL beginning with https://
.
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.
public void setTopicArn(String topicArn)
The ARN of the topic you want to subscribe to.
topicArn
- The ARN of the topic you want to subscribe to.public String getTopicArn()
The ARN of the topic you want to subscribe to.
public SubscribeRequest withTopicArn(String topicArn)
The ARN of the topic you want to subscribe to.
topicArn
- The ARN of the topic you want to subscribe to.public void setProtocol(String 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.
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.
public String getProtocol()
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.
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.
public SubscribeRequest withProtocol(String 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.
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.
public void setEndpoint(String endpoint)
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http
protocol, the (public) endpoint is a URL beginning with http://
.
For the https
protocol, the (public) endpoint is a URL beginning with https://
.
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.
endpoint
- The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http
protocol, the (public) endpoint is a URL beginning with http://
.
For the https
protocol, the (public) endpoint is a URL beginning with https://
.
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.
public String getEndpoint()
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http
protocol, the (public) endpoint is a URL beginning with http://
.
For the https
protocol, the (public) endpoint is a URL beginning with https://
.
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.
For the http
protocol, the (public) endpoint is a URL beginning with http://
.
For the https
protocol, the (public) endpoint is a URL beginning with https://
.
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.
public SubscribeRequest withEndpoint(String endpoint)
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http
protocol, the (public) endpoint is a URL beginning with http://
.
For the https
protocol, the (public) endpoint is a URL beginning with https://
.
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.
endpoint
- The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http
protocol, the (public) endpoint is a URL beginning with http://
.
For the https
protocol, the (public) endpoint is a URL beginning with https://
.
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.
public Map<String,String> getAttributes()
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 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 Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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 the ReplayPolicy
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.
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 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 Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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 the ReplayPolicy
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.
public void setAttributes(Map<String,String> 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 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 Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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 the ReplayPolicy
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.
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 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 Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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 the ReplayPolicy
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.
public SubscribeRequest withAttributes(Map<String,String> 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 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 Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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 the ReplayPolicy
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.
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 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 Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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 the ReplayPolicy
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.
public SubscribeRequest addAttributesEntry(String key, String value)
public SubscribeRequest clearAttributesEntries()
public void setReturnSubscriptionArn(Boolean 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
the pending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
The default value is false
.
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 the pending subscription
ARN value for subscriptions that aren't yet confirmed. A
subscription becomes confirmed when the subscriber calls the ConfirmSubscription
action with
a confirmation token.
The default value is false
.
public Boolean getReturnSubscriptionArn()
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
the pending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
The default value is false
.
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 the pending subscription
ARN value for subscriptions that aren't yet confirmed. A
subscription becomes confirmed when the subscriber calls the ConfirmSubscription
action with
a confirmation token.
The default value is false
.
public SubscribeRequest withReturnSubscriptionArn(Boolean 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
the pending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
The default value is false
.
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 the pending subscription
ARN value for subscriptions that aren't yet confirmed. A
subscription becomes confirmed when the subscriber calls the ConfirmSubscription
action with
a confirmation token.
The default value is false
.
public Boolean isReturnSubscriptionArn()
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
the pending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
The default value is false
.
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 the pending subscription
ARN value for subscriptions that aren't yet confirmed. A
subscription becomes confirmed when the subscriber calls the ConfirmSubscription
action with
a confirmation token.
The default value is false
.
public String toString()
toString
in class Object
Object.toString()
public SubscribeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()