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

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 CreateFirewallPolicyRequest data as a 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
        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",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  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)


472
473
474
475
476
477
478
479
480
481
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 472

class CreateFirewallPolicyRequest < Struct.new(
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :tags,
  :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)


472
473
474
475
476
477
478
479
480
481
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 472

class CreateFirewallPolicyRequest < Struct.new(
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :tags,
  :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.



472
473
474
475
476
477
478
479
480
481
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 472

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

#firewall_policyTypes::FirewallPolicy

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



472
473
474
475
476
477
478
479
480
481
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 472

class CreateFirewallPolicyRequest < Struct.new(
  :firewall_policy_name,
  :firewall_policy,
  :description,
  :tags,
  :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.

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 472

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

#tagsArray<Types::Tag>

The key:value pairs to associate with the resource.

Returns:



472
473
474
475
476
477
478
479
480
481
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 472

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