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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateProtectionGroupInput {
/// <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.</p>
pub protection_group_id: ::std::option::Option<::std::string::String>,
/// <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
/// <ul>
/// <li>
/// <p>Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.</p></li>
/// <li>
/// <p>Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.</p></li>
/// <li>
/// <p>Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.</p></li>
/// </ul>
pub aggregation: ::std::option::Option<crate::types::ProtectionGroupAggregation>,
/// <p>The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.</p>
pub pattern: ::std::option::Option<crate::types::ProtectionGroupPattern>,
/// <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub resource_type: ::std::option::Option<crate::types::ProtectedResourceType>,
/// <p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub members: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>One or more tag key-value pairs for the protection group.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateProtectionGroupInput {
/// <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.</p>
pub fn protection_group_id(&self) -> ::std::option::Option<&str> {
self.protection_group_id.as_deref()
}
/// <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
/// <ul>
/// <li>
/// <p>Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.</p></li>
/// <li>
/// <p>Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.</p></li>
/// <li>
/// <p>Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.</p></li>
/// </ul>
pub fn aggregation(&self) -> ::std::option::Option<&crate::types::ProtectionGroupAggregation> {
self.aggregation.as_ref()
}
/// <p>The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.</p>
pub fn pattern(&self) -> ::std::option::Option<&crate::types::ProtectionGroupPattern> {
self.pattern.as_ref()
}
/// <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub fn resource_type(&self) -> ::std::option::Option<&crate::types::ProtectedResourceType> {
self.resource_type.as_ref()
}
/// <p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.members.is_none()`.
pub fn members(&self) -> &[::std::string::String] {
self.members.as_deref().unwrap_or_default()
}
/// <p>One or more tag key-value pairs for the protection group.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
}
impl CreateProtectionGroupInput {
/// Creates a new builder-style object to manufacture [`CreateProtectionGroupInput`](crate::operation::create_protection_group::CreateProtectionGroupInput).
pub fn builder() -> crate::operation::create_protection_group::builders::CreateProtectionGroupInputBuilder {
crate::operation::create_protection_group::builders::CreateProtectionGroupInputBuilder::default()
}
}
/// A builder for [`CreateProtectionGroupInput`](crate::operation::create_protection_group::CreateProtectionGroupInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateProtectionGroupInputBuilder {
pub(crate) protection_group_id: ::std::option::Option<::std::string::String>,
pub(crate) aggregation: ::std::option::Option<crate::types::ProtectionGroupAggregation>,
pub(crate) pattern: ::std::option::Option<crate::types::ProtectionGroupPattern>,
pub(crate) resource_type: ::std::option::Option<crate::types::ProtectedResourceType>,
pub(crate) members: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateProtectionGroupInputBuilder {
/// <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.</p>
/// This field is required.
pub fn protection_group_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.protection_group_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.</p>
pub fn set_protection_group_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.protection_group_id = input;
self
}
/// <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.</p>
pub fn get_protection_group_id(&self) -> &::std::option::Option<::std::string::String> {
&self.protection_group_id
}
/// <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
/// <ul>
/// <li>
/// <p>Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.</p></li>
/// <li>
/// <p>Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.</p></li>
/// <li>
/// <p>Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.</p></li>
/// </ul>
/// This field is required.
pub fn aggregation(mut self, input: crate::types::ProtectionGroupAggregation) -> Self {
self.aggregation = ::std::option::Option::Some(input);
self
}
/// <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
/// <ul>
/// <li>
/// <p>Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.</p></li>
/// <li>
/// <p>Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.</p></li>
/// <li>
/// <p>Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.</p></li>
/// </ul>
pub fn set_aggregation(mut self, input: ::std::option::Option<crate::types::ProtectionGroupAggregation>) -> Self {
self.aggregation = input;
self
}
/// <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
/// <ul>
/// <li>
/// <p>Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.</p></li>
/// <li>
/// <p>Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.</p></li>
/// <li>
/// <p>Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.</p></li>
/// </ul>
pub fn get_aggregation(&self) -> &::std::option::Option<crate::types::ProtectionGroupAggregation> {
&self.aggregation
}
/// <p>The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.</p>
/// This field is required.
pub fn pattern(mut self, input: crate::types::ProtectionGroupPattern) -> Self {
self.pattern = ::std::option::Option::Some(input);
self
}
/// <p>The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.</p>
pub fn set_pattern(mut self, input: ::std::option::Option<crate::types::ProtectionGroupPattern>) -> Self {
self.pattern = input;
self
}
/// <p>The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.</p>
pub fn get_pattern(&self) -> &::std::option::Option<crate::types::ProtectionGroupPattern> {
&self.pattern
}
/// <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub fn resource_type(mut self, input: crate::types::ProtectedResourceType) -> Self {
self.resource_type = ::std::option::Option::Some(input);
self
}
/// <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub fn set_resource_type(mut self, input: ::std::option::Option<crate::types::ProtectedResourceType>) -> Self {
self.resource_type = input;
self
}
/// <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub fn get_resource_type(&self) -> &::std::option::Option<crate::types::ProtectedResourceType> {
&self.resource_type
}
/// Appends an item to `members`.
///
/// To override the contents of this collection use [`set_members`](Self::set_members).
///
/// <p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub fn members(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.members.unwrap_or_default();
v.push(input.into());
self.members = ::std::option::Option::Some(v);
self
}
/// <p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub fn set_members(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.members = input;
self
}
/// <p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting.</p>
pub fn get_members(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.members
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>One or more tag key-value pairs for the protection group.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>One or more tag key-value pairs for the protection group.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>One or more tag key-value pairs for the protection group.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// Consumes the builder and constructs a [`CreateProtectionGroupInput`](crate::operation::create_protection_group::CreateProtectionGroupInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_protection_group::CreateProtectionGroupInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::create_protection_group::CreateProtectionGroupInput {
protection_group_id: self.protection_group_id,
aggregation: self.aggregation,
pattern: self.pattern,
resource_type: self.resource_type,
members: self.members,
tags: self.tags,
})
}
}