Struct aws_sdk_networkfirewall::model::RuleGroupResponse

#[non_exhaustive]
pub struct RuleGroupResponse {
    pub rule_group_arn: Option<String>,
    pub rule_group_name: Option<String>,
    pub rule_group_id: Option<String>,
    pub description: Option<String>,
    pub type: Option<RuleGroupType>,
    pub capacity: Option<i32>,
    pub rule_group_status: Option<ResourceStatus>,
    pub tags: Option<Vec<Tag>>,
    pub consumed_capacity: Option<i32>,
    pub number_of_associations: Option<i32>,
}

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rule_group_arn: Option<String>

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

rule_group_name: Option<String>

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

rule_group_id: Option<String>

The unique identifier for the rule group.

description: Option<String>

A description of the rule group.

type: Option<RuleGroupType>

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

capacity: Option<i32>

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

rule_group_status: Option<ResourceStatus>

Detailed information about the current status of a rule group.

tags: Option<Vec<Tag>>

The key:value pairs to associate with the resource.

consumed_capacity: Option<i32>

The number of capacity units currently consumed by the rule group rules.

number_of_associations: Option<i32>

The number of firewall policies that use this rule group.

Implementations

impl RuleGroupResponse

pub fn rule_group_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

pub fn rule_group_name(&self) -> Option<&str>

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

pub fn rule_group_id(&self) -> Option<&str>

The unique identifier for the rule group.

pub fn description(&self) -> Option<&str>

A description of the rule group.

pub fn type(&self) -> Option<&RuleGroupType>

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

pub fn capacity(&self) -> Option<i32>

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

pub fn rule_group_status(&self) -> Option<&ResourceStatus>

Detailed information about the current status of a rule group.

pub fn tags(&self) -> Option<&[Tag]>

The key:value pairs to associate with the resource.

pub fn consumed_capacity(&self) -> Option<i32>

The number of capacity units currently consumed by the rule group rules.

pub fn number_of_associations(&self) -> Option<i32>

The number of firewall policies that use this rule group.

impl RuleGroupResponse

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RuleGroupResponse

Trait Implementations

impl Clone for RuleGroupResponse

fn clone(&self) -> RuleGroupResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RuleGroupResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<RuleGroupResponse> for RuleGroupResponse

fn eq(&self, other: &RuleGroupResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RuleGroupResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for RuleGroupResponse