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::FirewallPolicyResponse

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

Overview

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the firewall policy.

Returns:

  • (String)

    A description of the firewall policy.

#firewall_policy_arnString

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

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn\'t attached to a valid resource.

Returns:

  • (String)

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

#firewall_policy_idString

The unique identifier for the firewall policy.

Returns:

  • (String)

    The unique identifier for the firewall policy.

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

#firewall_policy_statusString

The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy\'s name or ARN.

Possible values:

  • ACTIVE
  • DELETING

Returns:

  • (String)

    The current status 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.