Class: Aws::NetworkFirewall::Types::UpdateRuleGroupRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::NetworkFirewall::Types::UpdateRuleGroupRequest
- Defined in:
- gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#analyze_rule_group ⇒ Boolean
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing.
-
#description ⇒ String
A description of the rule group.
-
#dry_run ⇒ Boolean
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
-
#encryption_configuration ⇒ Types::EncryptionConfiguration
A complex type that contains settings for encryption of your rule group resources.
-
#rule_group ⇒ Types::RuleGroup
An object that defines the rule group rules.
-
#rule_group_arn ⇒ String
The Amazon Resource Name (ARN) of the rule group.
-
#rule_group_name ⇒ String
The descriptive name of the rule group.
-
#rules ⇒ String
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line.
-
#source_metadata ⇒ Types::SourceMetadata
A complex type that contains metadata about the rule group that your own rule group is copied from.
-
#type ⇒ String
Indicates whether the rule group is stateless or stateful.
-
#update_token ⇒ String
A token used for optimistic locking.
Instance Attribute Details
#analyze_rule_group ⇒ Boolean
Indicates whether you want Network Firewall to analyze the stateless
rules in the rule group for rule behavior such as asymmetric
routing. If set to TRUE
, Network Firewall runs the analysis and
then updates the rule group for you. To run the stateless rule group
analyzer without updating the rule group, set DryRun
to TRUE
.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the rule group.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) SENSITIVE = [] include Aws::Structure end |
#dry_run ⇒ Boolean
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE
, Network Firewall checks whether the request can
run successfully, but doesn't actually make the requested changes.
The call returns the value that the request would return if you ran
it with dry run set to FALSE
, but doesn't make additions or
changes to your resources. This option allows you to make sure that
you have the required permissions to run the request and that your
request parameters are valid.
If set to FALSE
, Network Firewall makes the requested changes to
your resources.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) SENSITIVE = [] include Aws::Structure end |
#encryption_configuration ⇒ Types::EncryptionConfiguration
A complex type that contains settings for encryption of your rule group resources.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) SENSITIVE = [] include Aws::Structure end |
#rule_group ⇒ Types::RuleGroup
An object that defines the rule group rules.
Rules
setting, but not both.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) SENSITIVE = [] include Aws::Structure end |
#rule_group_arn ⇒ String
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) 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.
You must specify the ARN or the name, and you can specify both.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) SENSITIVE = [] include Aws::Structure end |
#rules ⇒ String
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
RuleGroup
setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) 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 keep track of updates made to the originating rule group.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) 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.
RuleGroupARN
.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) SENSITIVE = [] include Aws::Structure end |
#update_token ⇒ String
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your
request. Network Firewall uses the token to ensure that the rule
group hasn't changed since you last retrieved it. If it has
changed, the operation fails with an InvalidTokenException
. If
this happens, retrieve the rule group again to get a current copy of
it with a current token. Reapply your changes as needed, then try
the operation again using the new token.
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4923 class UpdateRuleGroupRequest < Struct.new( :update_token, :rule_group_arn, :rule_group_name, :rule_group, :rules, :type, :description, :dry_run, :encryption_configuration, :source_metadata, :analyze_rule_group) SENSITIVE = [] include Aws::Structure end |