Class: Aws::NetworkFirewall::Types::RuleGroupResponse

Inherits:

Struct

• Object
• Struct
• Aws::NetworkFirewall::Types::RuleGroupResponse

Includes:

Structure

Defined in:

lib/aws-sdk-networkfirewall/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #analysis_results ⇒ Array<Types::AnalysisResult>

  The list of analysis results for ‘AnalyzeRuleGroup`.

• #capacity ⇒ Integer

  The maximum operating resources that this rule group can use.

• #consumed_capacity ⇒ Integer

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

• #description ⇒ String

  A description of the rule group.

• #encryption_configuration ⇒ Types::EncryptionConfiguration

  A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.

• #last_modified_time ⇒ Time

  The last time that the rule group was changed.

• #number_of_associations ⇒ Integer

  The number of firewall policies that use this rule group.

• #rule_group_arn ⇒ String

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

• #rule_group_id ⇒ String

  The unique identifier for the rule group.

• #rule_group_name ⇒ String

  The descriptive name of the rule group.

• #rule_group_status ⇒ String

  Detailed information about the current status of a rule group.

• #sns_topic ⇒ String

  The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that’s used to record changes to the managed rule group.

• #source_metadata ⇒ Types::SourceMetadata

  A complex type that contains metadata about the rule group that your own rule group is copied from.

• #tags ⇒ Array<Types::Tag>

  The key:value pairs to associate with the resource.

• #type ⇒ String

  Indicates whether the rule group is stateless or stateful.

Instance Attribute Details

#analysis_results ⇒ Array<Types::AnalysisResult>

The list of analysis results for ‘AnalyzeRuleGroup`. If you set `AnalyzeRuleGroup` to `TRUE` in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall’s functionality. For example, if Network Firewall detects a rule that’s routing traffic asymmetrically, which impacts the service’s ability to properly process traffic, the service includes the rule in the list of analysis results.

Returns:

• (Array<Types::AnalysisResult>)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#capacity ⇒ Integer

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`.

Returns:

• (Integer)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_capacity ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the rule group.

Returns:

• (String)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.

Returns:

• (Types::EncryptionConfiguration)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The last time that the rule group was changed.

Returns:

• (Time)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_associations ⇒ Integer

The number of firewall policies that use this rule group.

Returns:

• (Integer)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_arn ⇒ String

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

<note markdown=“1”> 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.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_id ⇒ String

The unique identifier for the rule group.

Returns:

• (String)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_status ⇒ String

Detailed information about the current status of a rule group.

Returns:

• (String)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic ⇒ String

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that’s used to record 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 [Amazon Simple Notification Service Developer Guide.].

[1]: docs.aws.amazon.com/sns/latest/dg/welcome.html

Returns:

• (String)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#source_metadata ⇒ Types::SourceMetadata

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.

Returns:

• (Types::SourceMetadata)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The key:value pairs to associate with the resource.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 3303

class RuleGroupResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :rule_group_id,
  :description,
  :type,
  :capacity,
  :rule_group_status,
  :tags,
  :consumed_capacity,
  :number_of_associations,
  :encryption_configuration,
  :source_metadata,
  :sns_topic,
  :last_modified_time,
  :analysis_results)
  SENSITIVE = []
  include Aws::Structure
end