Class: Aws::NetworkFirewall::Types::FirewallPolicyResponse

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

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#consumed_stateful_rule_capacityInteger

The number of capacity units currently consumed by the policy's stateful rules.

Returns:

  • (Integer)


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_stateless_rule_capacityInteger

The number of capacity units currently consumed by the policy's stateless rules.

Returns:

  • (Integer)


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the firewall policy.

Returns:

  • (String)


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  SENSITIVE = []
  include Aws::Structure
end

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


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_policy_idString

The unique identifier for the firewall policy.

Returns:

  • (String)


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  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)


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_associationsInteger

The number of firewalls that are associated with this firewall policy.

Returns:

  • (Integer)


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The key:value pairs to associate with the resource.

Returns:



1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1959

class FirewallPolicyResponse < Struct.new(
  :firewall_policy_name,
  :firewall_policy_arn,
  :firewall_policy_id,
  :description,
  :firewall_policy_status,
  :tags,
  :consumed_stateless_rule_capacity,
  :consumed_stateful_rule_capacity,
  :number_of_associations)
  SENSITIVE = []
  include Aws::Structure
end