Class: Aws::NetworkFirewall::Types::UpdateFirewallPolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

Overview

Note:

When making an API call, you may pass UpdateFirewallPolicyRequest data as a 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
        priority: 1,
        override: {
          action: "DROP_TO_ALERT", # accepts DROP_TO_ALERT
        },
      },
    ],
    stateful_default_actions: ["CollectionMember_String"],
    stateful_engine_options: {
      rule_order: "DEFAULT_ACTION_ORDER", # accepts DEFAULT_ACTION_ORDER, STRICT_ORDER
    },
  },
  description: "Description",
  dry_run: false,
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the firewall policy.

Returns:

  • (String)


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5024

class UpdateFirewallPolicyRequest < Struct.new(
  :update_token,
  :firewall_policy_arn,
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :dry_run,
  :encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5024

class UpdateFirewallPolicyRequest < Struct.new(
  :update_token,
  :firewall_policy_arn,
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :dry_run,
  :encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configurationTypes::EncryptionConfiguration

A complex type that contains settings for encryption of your firewall policy resources.



5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5024

class UpdateFirewallPolicyRequest < Struct.new(
  :update_token,
  :firewall_policy_arn,
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :dry_run,
  :encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_policyTypes::FirewallPolicy

The updated firewall policy to use for the firewall.



5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5024

class UpdateFirewallPolicyRequest < Struct.new(
  :update_token,
  :firewall_policy_arn,
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :dry_run,
  :encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_policy_arnString

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

Returns:

  • (String)


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5024

class UpdateFirewallPolicyRequest < Struct.new(
  :update_token,
  :firewall_policy_arn,
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :dry_run,
  :encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_policy_nameString

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.

Returns:

  • (String)


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5024

class UpdateFirewallPolicyRequest < Struct.new(
  :update_token,
  :firewall_policy_arn,
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :dry_run,
  :encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#update_tokenString

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.

Returns:

  • (String)


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5024

class UpdateFirewallPolicyRequest < Struct.new(
  :update_token,
  :firewall_policy_arn,
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :dry_run,
  :encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end