AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::NetworkFirewall::Types::CreateFirewallPolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateFirewallPolicyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  firewall_policy_name: "ResourceName", # required
  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",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the firewall policy.

Returns:

  • (String)

    A description of the firewall policy.

#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)

    Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

#firewall_policyTypes::FirewallPolicy

The rule groups and policy actions to use in the firewall policy.

Returns:

#firewall_policy_nameString

The descriptive name of the firewall policy. You can\'t change the name of a firewall policy after you create it.

Returns:

  • (String)

    The descriptive name of the firewall policy.

#tagsArray<Types::Tag>

The key:value pairs to associate with the resource.

Returns:

  • (Array<Types::Tag>)

    The key:value pairs to associate with the resource.