You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::NetworkFirewall::Types::UpdateFirewallPolicyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::NetworkFirewall::Types::UpdateFirewallPolicyRequest
- Defined in:
- (unknown)
Overview
When passing UpdateFirewallPolicyRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
update_token: "UpdateToken", # required
firewall_policy_arn: "ResourceArn",
firewall_policy_name: "ResourceName",
firewall_policy: { # required
stateless_rule_group_references: [
{
resource_arn: "ResourceArn", # required
priority: 1, # required
},
],
stateless_default_actions: ["CollectionMember_String"], # required
stateless_fragment_default_actions: ["CollectionMember_String"], # required
stateless_custom_actions: [
{
action_name: "ActionName", # required
action_definition: { # required
publish_metric_action: {
dimensions: [ # required
{
value: "DimensionValue", # required
},
],
},
},
},
],
stateful_rule_group_references: [
{
resource_arn: "ResourceArn", # required
},
],
},
description: "Description",
dry_run: false,
}
Instance Attribute Summary collapse
-
#description ⇒ String
A description of the firewall policy.
-
#dry_run ⇒ Boolean
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
-
#firewall_policy ⇒ Types::FirewallPolicy
The updated firewall policy to use for the firewall.
-
#firewall_policy_arn ⇒ String
The Amazon Resource Name (ARN) of the firewall policy.
-
#firewall_policy_name ⇒ String
The descriptive name of the firewall policy.
-
#update_token ⇒ String
A token used for optimistic locking.
Instance Attribute Details
#description ⇒ String
A description of the firewall policy.
#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.
#firewall_policy ⇒ Types::FirewallPolicy
The updated firewall policy to use for the firewall.
#firewall_policy_arn ⇒ String
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
#firewall_policy_name ⇒ String
The descriptive name of the firewall policy. You can\'t change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
#update_token ⇒ String
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request.
Network Firewall uses the token to ensure that the policy hasn\'t
changed since you last retrieved it. If it has changed, the operation
fails with an InvalidTokenException
. If this happens, retrieve the
firewall policy again to get a current copy of it with current token.
Reapply your changes as needed, then try the operation again using the
new token.