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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-networkfirewall/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacityInteger

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)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_capacityInteger

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

Returns:

  • (Integer)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the rule group.

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configurationTypes::EncryptionConfiguration

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



3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timeTime

The last time that the rule group was changed.

Returns:

  • (Time)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_associationsInteger

The number of firewall policies that use this rule group.

Returns:

  • (Integer)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_arnString

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.

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_idString

The unique identifier for the rule group.

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_nameString

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

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_statusString

Detailed information about the current status of a rule group.

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topicString

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

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#source_metadataTypes::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.



3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The key:value pairs to associate with the resource.

Returns:



3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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)


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3519

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)
  SENSITIVE = []
  include Aws::Structure
end