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

Inherits:

Struct

• Object
• Struct
• Aws::NetworkFirewall::Types::FirewallPolicyResponse

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #consumed_stateful_domain_capacity ⇒ Integer

  The total number of domain name specifications across all domain list rule groups in the firewall policy that use the stateful-domain-rulegroup resource type.

• #consumed_stateful_rule_capacity ⇒ Integer

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

• #consumed_stateless_rule_capacity ⇒ Integer

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

• #description ⇒ String

  A description of the firewall policy.

• #encryption_configuration ⇒ Types::EncryptionConfiguration

  A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

• #firewall_policy_arn ⇒ String

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

• #firewall_policy_id ⇒ String

  The unique identifier for the firewall policy.

• #firewall_policy_name ⇒ String

  The descriptive name of the firewall policy.

• #firewall_policy_status ⇒ String

  The current status of the firewall policy.

• #last_modified_time ⇒ Time

  The last time that the firewall policy was changed.

• #number_of_associations ⇒ Integer

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

• #tags ⇒ Array<Types::Tag>

  The key:value pairs to associate with the resource.

Instance Attribute Details

#consumed_stateful_domain_capacity ⇒ Integer

The total number of domain name specifications across all domain list rule groups in the firewall policy that use the stateful-domain-rulegroup resource type.

Returns:

• (Integer)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_stateful_rule_capacity ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_stateless_rule_capacity ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the firewall policy.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

Returns:

• (Types::EncryptionConfiguration)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_policy_arn ⇒ String

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)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_policy_id ⇒ String

The unique identifier for the firewall policy.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_policy_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_policy_status ⇒ String

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)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The last time that the firewall policy was changed.

Returns:

• (Time)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_associations ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The key:value pairs to associate with the resource.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4455

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,
  :consumed_stateful_domain_capacity,
  :number_of_associations,
  :encryption_configuration,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end