1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Input for SetSubscriptionAttributes action.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct SetSubscriptionAttributesInput {
/// <p>The ARN of the subscription to modify.</p>
pub subscription_arn: ::std::option::Option<::std::string::String>,
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that this action uses:</p>
/// <ul>
/// <li>
/// <p><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p></li>
/// <li>
/// <p><code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p></li>
/// <li>
/// <p><code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li>
/// <p><code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p></li>
/// <li>
/// <p><code>MessageBody</code> – The filter is applied on the message body.</p></li>
/// </ul></li>
/// <li>
/// <p><code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p></li>
/// <li>
/// <p><code>RedrivePolicy</code> – 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.</p></li>
/// </ul>
/// <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li>
/// <p><code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li>
/// <p>Permission to write to the Firehose delivery stream</p></li>
/// <li>
/// <p>Amazon SNS listed as a trusted entity</p></li>
/// </ul>
/// <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p></li>
/// </ul>
pub attribute_name: ::std::option::Option<::std::string::String>,
/// <p>The new value for the attribute in JSON format.</p>
pub attribute_value: ::std::option::Option<::std::string::String>,
}
impl SetSubscriptionAttributesInput {
/// <p>The ARN of the subscription to modify.</p>
pub fn subscription_arn(&self) -> ::std::option::Option<&str> {
self.subscription_arn.as_deref()
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that this action uses:</p>
/// <ul>
/// <li>
/// <p><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p></li>
/// <li>
/// <p><code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p></li>
/// <li>
/// <p><code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li>
/// <p><code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p></li>
/// <li>
/// <p><code>MessageBody</code> – The filter is applied on the message body.</p></li>
/// </ul></li>
/// <li>
/// <p><code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p></li>
/// <li>
/// <p><code>RedrivePolicy</code> – 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.</p></li>
/// </ul>
/// <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li>
/// <p><code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li>
/// <p>Permission to write to the Firehose delivery stream</p></li>
/// <li>
/// <p>Amazon SNS listed as a trusted entity</p></li>
/// </ul>
/// <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p></li>
/// </ul>
pub fn attribute_name(&self) -> ::std::option::Option<&str> {
self.attribute_name.as_deref()
}
/// <p>The new value for the attribute in JSON format.</p>
pub fn attribute_value(&self) -> ::std::option::Option<&str> {
self.attribute_value.as_deref()
}
}
impl SetSubscriptionAttributesInput {
/// Creates a new builder-style object to manufacture [`SetSubscriptionAttributesInput`](crate::operation::set_subscription_attributes::SetSubscriptionAttributesInput).
pub fn builder() -> crate::operation::set_subscription_attributes::builders::SetSubscriptionAttributesInputBuilder {
crate::operation::set_subscription_attributes::builders::SetSubscriptionAttributesInputBuilder::default()
}
}
/// A builder for [`SetSubscriptionAttributesInput`](crate::operation::set_subscription_attributes::SetSubscriptionAttributesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SetSubscriptionAttributesInputBuilder {
pub(crate) subscription_arn: ::std::option::Option<::std::string::String>,
pub(crate) attribute_name: ::std::option::Option<::std::string::String>,
pub(crate) attribute_value: ::std::option::Option<::std::string::String>,
}
impl SetSubscriptionAttributesInputBuilder {
/// <p>The ARN of the subscription to modify.</p>
/// This field is required.
pub fn subscription_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.subscription_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the subscription to modify.</p>
pub fn set_subscription_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.subscription_arn = input;
self
}
/// <p>The ARN of the subscription to modify.</p>
pub fn get_subscription_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.subscription_arn
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that this action uses:</p>
/// <ul>
/// <li>
/// <p><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p></li>
/// <li>
/// <p><code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p></li>
/// <li>
/// <p><code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li>
/// <p><code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p></li>
/// <li>
/// <p><code>MessageBody</code> – The filter is applied on the message body.</p></li>
/// </ul></li>
/// <li>
/// <p><code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p></li>
/// <li>
/// <p><code>RedrivePolicy</code> – 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.</p></li>
/// </ul>
/// <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li>
/// <p><code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li>
/// <p>Permission to write to the Firehose delivery stream</p></li>
/// <li>
/// <p>Amazon SNS listed as a trusted entity</p></li>
/// </ul>
/// <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p></li>
/// </ul>
/// This field is required.
pub fn attribute_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.attribute_name = ::std::option::Option::Some(input.into());
self
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that this action uses:</p>
/// <ul>
/// <li>
/// <p><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p></li>
/// <li>
/// <p><code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p></li>
/// <li>
/// <p><code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li>
/// <p><code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p></li>
/// <li>
/// <p><code>MessageBody</code> – The filter is applied on the message body.</p></li>
/// </ul></li>
/// <li>
/// <p><code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p></li>
/// <li>
/// <p><code>RedrivePolicy</code> – 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.</p></li>
/// </ul>
/// <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li>
/// <p><code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li>
/// <p>Permission to write to the Firehose delivery stream</p></li>
/// <li>
/// <p>Amazon SNS listed as a trusted entity</p></li>
/// </ul>
/// <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p></li>
/// </ul>
pub fn set_attribute_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.attribute_name = input;
self
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that this action uses:</p>
/// <ul>
/// <li>
/// <p><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p></li>
/// <li>
/// <p><code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p></li>
/// <li>
/// <p><code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li>
/// <p><code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p></li>
/// <li>
/// <p><code>MessageBody</code> – The filter is applied on the message body.</p></li>
/// </ul></li>
/// <li>
/// <p><code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p></li>
/// <li>
/// <p><code>RedrivePolicy</code> – 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.</p></li>
/// </ul>
/// <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li>
/// <p><code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li>
/// <p>Permission to write to the Firehose delivery stream</p></li>
/// <li>
/// <p>Amazon SNS listed as a trusted entity</p></li>
/// </ul>
/// <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p></li>
/// </ul>
pub fn get_attribute_name(&self) -> &::std::option::Option<::std::string::String> {
&self.attribute_name
}
/// <p>The new value for the attribute in JSON format.</p>
pub fn attribute_value(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.attribute_value = ::std::option::Option::Some(input.into());
self
}
/// <p>The new value for the attribute in JSON format.</p>
pub fn set_attribute_value(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.attribute_value = input;
self
}
/// <p>The new value for the attribute in JSON format.</p>
pub fn get_attribute_value(&self) -> &::std::option::Option<::std::string::String> {
&self.attribute_value
}
/// Consumes the builder and constructs a [`SetSubscriptionAttributesInput`](crate::operation::set_subscription_attributes::SetSubscriptionAttributesInput).
pub fn build(
self,
) -> ::std::result::Result<
crate::operation::set_subscription_attributes::SetSubscriptionAttributesInput,
::aws_smithy_types::error::operation::BuildError,
> {
::std::result::Result::Ok(crate::operation::set_subscription_attributes::SetSubscriptionAttributesInput {
subscription_arn: self.subscription_arn,
attribute_name: self.attribute_name,
attribute_value: self.attribute_value,
})
}
}