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 257 258 259 260 261 262 263 264 265 266 267
// 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 DescribeManagedRuleGroupOutput {
/// <p>The managed rule group's version. </p>
pub version_name: ::std::option::Option<::std::string::String>,
/// <p>The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon Simple Notification Service Developer Guide</a>.</p>
pub sns_topic_arn: ::std::option::Option<::std::string::String>,
/// <p>The web ACL capacity units (WCUs) required for this rule group.</p>
/// <p>WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>. </p>
pub capacity: ::std::option::Option<i64>,
/// <p></p>
pub rules: ::std::option::Option<::std::vec::Vec<crate::types::RuleSummary>>,
/// <p>The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. </p>
/// <ul>
/// <li> <p>The syntax for the label namespace prefix for a managed rule group is the following: </p> <p> <code>awswaf:managed:
/// <vendor>
/// :
/// <rule group name></rule>
/// </vendor></code>:</p> </li>
/// <li> <p>When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: </p> <p> <code><label namespace>:<label from rule></label></label></code> </p> </li>
/// </ul>
pub label_namespace: ::std::option::Option<::std::string::String>,
/// <p>The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the <code>RuleLabels</code> for a <code>Rule</code>.</p>
pub available_labels: ::std::option::Option<::std::vec::Vec<crate::types::LabelSummary>>,
/// <p>The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a <code>LabelMatchStatement</code> specification, in the <code>Statement</code> definition of a rule. </p>
pub consumed_labels: ::std::option::Option<::std::vec::Vec<crate::types::LabelSummary>>,
_request_id: Option<String>,
}
impl DescribeManagedRuleGroupOutput {
/// <p>The managed rule group's version. </p>
pub fn version_name(&self) -> ::std::option::Option<&str> {
self.version_name.as_deref()
}
/// <p>The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon Simple Notification Service Developer Guide</a>.</p>
pub fn sns_topic_arn(&self) -> ::std::option::Option<&str> {
self.sns_topic_arn.as_deref()
}
/// <p>The web ACL capacity units (WCUs) required for this rule group.</p>
/// <p>WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>. </p>
pub fn capacity(&self) -> ::std::option::Option<i64> {
self.capacity
}
/// <p></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 `.rules.is_none()`.
pub fn rules(&self) -> &[crate::types::RuleSummary] {
self.rules.as_deref().unwrap_or_default()
}
/// <p>The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. </p>
/// <ul>
/// <li> <p>The syntax for the label namespace prefix for a managed rule group is the following: </p> <p> <code>awswaf:managed:
/// <vendor>
/// :
/// <rule group name></rule>
/// </vendor></code>:</p> </li>
/// <li> <p>When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: </p> <p> <code><label namespace>:<label from rule></label></label></code> </p> </li>
/// </ul>
pub fn label_namespace(&self) -> ::std::option::Option<&str> {
self.label_namespace.as_deref()
}
/// <p>The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the <code>RuleLabels</code> for a <code>Rule</code>.</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 `.available_labels.is_none()`.
pub fn available_labels(&self) -> &[crate::types::LabelSummary] {
self.available_labels.as_deref().unwrap_or_default()
}
/// <p>The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a <code>LabelMatchStatement</code> specification, in the <code>Statement</code> definition of a rule. </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 `.consumed_labels.is_none()`.
pub fn consumed_labels(&self) -> &[crate::types::LabelSummary] {
self.consumed_labels.as_deref().unwrap_or_default()
}
}
impl ::aws_types::request_id::RequestId for DescribeManagedRuleGroupOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeManagedRuleGroupOutput {
/// Creates a new builder-style object to manufacture [`DescribeManagedRuleGroupOutput`](crate::operation::describe_managed_rule_group::DescribeManagedRuleGroupOutput).
pub fn builder() -> crate::operation::describe_managed_rule_group::builders::DescribeManagedRuleGroupOutputBuilder {
crate::operation::describe_managed_rule_group::builders::DescribeManagedRuleGroupOutputBuilder::default()
}
}
/// A builder for [`DescribeManagedRuleGroupOutput`](crate::operation::describe_managed_rule_group::DescribeManagedRuleGroupOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeManagedRuleGroupOutputBuilder {
pub(crate) version_name: ::std::option::Option<::std::string::String>,
pub(crate) sns_topic_arn: ::std::option::Option<::std::string::String>,
pub(crate) capacity: ::std::option::Option<i64>,
pub(crate) rules: ::std::option::Option<::std::vec::Vec<crate::types::RuleSummary>>,
pub(crate) label_namespace: ::std::option::Option<::std::string::String>,
pub(crate) available_labels: ::std::option::Option<::std::vec::Vec<crate::types::LabelSummary>>,
pub(crate) consumed_labels: ::std::option::Option<::std::vec::Vec<crate::types::LabelSummary>>,
_request_id: Option<String>,
}
impl DescribeManagedRuleGroupOutputBuilder {
/// <p>The managed rule group's version. </p>
pub fn version_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.version_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The managed rule group's version. </p>
pub fn set_version_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_name = input;
self
}
/// <p>The managed rule group's version. </p>
pub fn get_version_name(&self) -> &::std::option::Option<::std::string::String> {
&self.version_name
}
/// <p>The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon Simple Notification Service Developer Guide</a>.</p>
pub fn sns_topic_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.sns_topic_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon Simple Notification Service Developer Guide</a>.</p>
pub fn set_sns_topic_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.sns_topic_arn = input;
self
}
/// <p>The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon Simple Notification Service Developer Guide</a>.</p>
pub fn get_sns_topic_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.sns_topic_arn
}
/// <p>The web ACL capacity units (WCUs) required for this rule group.</p>
/// <p>WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>. </p>
pub fn capacity(mut self, input: i64) -> Self {
self.capacity = ::std::option::Option::Some(input);
self
}
/// <p>The web ACL capacity units (WCUs) required for this rule group.</p>
/// <p>WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>. </p>
pub fn set_capacity(mut self, input: ::std::option::Option<i64>) -> Self {
self.capacity = input;
self
}
/// <p>The web ACL capacity units (WCUs) required for this rule group.</p>
/// <p>WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>. </p>
pub fn get_capacity(&self) -> &::std::option::Option<i64> {
&self.capacity
}
/// Appends an item to `rules`.
///
/// To override the contents of this collection use [`set_rules`](Self::set_rules).
///
/// <p></p>
pub fn rules(mut self, input: crate::types::RuleSummary) -> Self {
let mut v = self.rules.unwrap_or_default();
v.push(input);
self.rules = ::std::option::Option::Some(v);
self
}
/// <p></p>
pub fn set_rules(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RuleSummary>>) -> Self {
self.rules = input;
self
}
/// <p></p>
pub fn get_rules(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RuleSummary>> {
&self.rules
}
/// <p>The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. </p>
/// <ul>
/// <li> <p>The syntax for the label namespace prefix for a managed rule group is the following: </p> <p> <code>awswaf:managed:
/// <vendor>
/// :
/// <rule group name></rule>
/// </vendor></code>:</p> </li>
/// <li> <p>When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: </p> <p> <code><label namespace>:<label from rule></label></label></code> </p> </li>
/// </ul>
pub fn label_namespace(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.label_namespace = ::std::option::Option::Some(input.into());
self
}
/// <p>The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. </p>
/// <ul>
/// <li> <p>The syntax for the label namespace prefix for a managed rule group is the following: </p> <p> <code>awswaf:managed:
/// <vendor>
/// :
/// <rule group name></rule>
/// </vendor></code>:</p> </li>
/// <li> <p>When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: </p> <p> <code><label namespace>:<label from rule></label></label></code> </p> </li>
/// </ul>
pub fn set_label_namespace(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.label_namespace = input;
self
}
/// <p>The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. </p>
/// <ul>
/// <li> <p>The syntax for the label namespace prefix for a managed rule group is the following: </p> <p> <code>awswaf:managed:
/// <vendor>
/// :
/// <rule group name></rule>
/// </vendor></code>:</p> </li>
/// <li> <p>When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: </p> <p> <code><label namespace>:<label from rule></label></label></code> </p> </li>
/// </ul>
pub fn get_label_namespace(&self) -> &::std::option::Option<::std::string::String> {
&self.label_namespace
}
/// Appends an item to `available_labels`.
///
/// To override the contents of this collection use [`set_available_labels`](Self::set_available_labels).
///
/// <p>The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the <code>RuleLabels</code> for a <code>Rule</code>.</p>
pub fn available_labels(mut self, input: crate::types::LabelSummary) -> Self {
let mut v = self.available_labels.unwrap_or_default();
v.push(input);
self.available_labels = ::std::option::Option::Some(v);
self
}
/// <p>The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the <code>RuleLabels</code> for a <code>Rule</code>.</p>
pub fn set_available_labels(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::LabelSummary>>) -> Self {
self.available_labels = input;
self
}
/// <p>The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the <code>RuleLabels</code> for a <code>Rule</code>.</p>
pub fn get_available_labels(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::LabelSummary>> {
&self.available_labels
}
/// Appends an item to `consumed_labels`.
///
/// To override the contents of this collection use [`set_consumed_labels`](Self::set_consumed_labels).
///
/// <p>The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a <code>LabelMatchStatement</code> specification, in the <code>Statement</code> definition of a rule. </p>
pub fn consumed_labels(mut self, input: crate::types::LabelSummary) -> Self {
let mut v = self.consumed_labels.unwrap_or_default();
v.push(input);
self.consumed_labels = ::std::option::Option::Some(v);
self
}
/// <p>The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a <code>LabelMatchStatement</code> specification, in the <code>Statement</code> definition of a rule. </p>
pub fn set_consumed_labels(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::LabelSummary>>) -> Self {
self.consumed_labels = input;
self
}
/// <p>The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a <code>LabelMatchStatement</code> specification, in the <code>Statement</code> definition of a rule. </p>
pub fn get_consumed_labels(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::LabelSummary>> {
&self.consumed_labels
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeManagedRuleGroupOutput`](crate::operation::describe_managed_rule_group::DescribeManagedRuleGroupOutput).
pub fn build(self) -> crate::operation::describe_managed_rule_group::DescribeManagedRuleGroupOutput {
crate::operation::describe_managed_rule_group::DescribeManagedRuleGroupOutput {
version_name: self.version_name,
sns_topic_arn: self.sns_topic_arn,
capacity: self.capacity,
rules: self.rules,
label_namespace: self.label_namespace,
available_labels: self.available_labels,
consumed_labels: self.consumed_labels,
_request_id: self._request_id,
}
}
}