Class: Aws::FMS::Types::PolicySummary

Inherits:

Struct

• Object
• Struct
• Aws::FMS::Types::PolicySummary

Includes:

Structure

Defined in:

lib/aws-sdk-fms/types.rb

Overview

Details of the Firewall Manager policy.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #delete_unused_fm_managed_resources ⇒ Boolean

  Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope.

• #policy_arn ⇒ String

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

• #policy_id ⇒ String

  The ID of the specified policy.

• #policy_name ⇒ String

  The name of the specified policy.

• #policy_status ⇒ String

  Indicates whether the policy is in or out of an admin’s policy or Region scope.

• #remediation_enabled ⇒ Boolean

  Indicates if the policy should be automatically applied to new resources.

• #resource_type ⇒ String

  The type of resource protected by or in scope of the policy.

• #security_service_type ⇒ String

  The service that the policy is using to protect the resources.

Instance Attribute Details

#delete_unused_fm_managed_resources ⇒ Boolean

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn’t remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

Returns:

• (Boolean)

# File 'lib/aws-sdk-fms/types.rb', line 3769

class PolicySummary < Struct.new(
  :policy_arn,
  :policy_id,
  :policy_name,
  :resource_type,
  :security_service_type,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-fms/types.rb', line 3769

class PolicySummary < Struct.new(
  :policy_arn,
  :policy_id,
  :policy_name,
  :resource_type,
  :security_service_type,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_id ⇒ String

The ID of the specified policy.

Returns:

• (String)

# File 'lib/aws-sdk-fms/types.rb', line 3769

class PolicySummary < Struct.new(
  :policy_arn,
  :policy_id,
  :policy_name,
  :resource_type,
  :security_service_type,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_name ⇒ String

The name of the specified policy.

Returns:

• (String)

# File 'lib/aws-sdk-fms/types.rb', line 3769

class PolicySummary < Struct.new(
  :policy_arn,
  :policy_id,
  :policy_name,
  :resource_type,
  :security_service_type,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_status ⇒ String

Indicates whether the policy is in or out of an admin’s policy or Region scope.

• ‘ACTIVE` - The administrator can manage and delete the policy.

• ‘OUT_OF_ADMIN_SCOPE` - The administrator can view the policy, but they can’t edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won’t be protected.

Returns:

• (String)

# File 'lib/aws-sdk-fms/types.rb', line 3769

class PolicySummary < Struct.new(
  :policy_arn,
  :policy_id,
  :policy_name,
  :resource_type,
  :security_service_type,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#remediation_enabled ⇒ Boolean

Indicates if the policy should be automatically applied to new resources.

Returns:

• (Boolean)

# File 'lib/aws-sdk-fms/types.rb', line 3769

class PolicySummary < Struct.new(
  :policy_arn,
  :policy_id,
  :policy_name,
  :resource_type,
  :security_service_type,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of resource protected by or in scope of the policy. This is in the format shown in the [Amazon Web Services Resource Types Reference].

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

• (String)

# File 'lib/aws-sdk-fms/types.rb', line 3769

class PolicySummary < Struct.new(
  :policy_arn,
  :policy_id,
  :policy_name,
  :resource_type,
  :security_service_type,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#security_service_type ⇒ String

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.

Returns:

• (String)

# File 'lib/aws-sdk-fms/types.rb', line 3769

class PolicySummary < Struct.new(
  :policy_arn,
  :policy_id,
  :policy_name,
  :resource_type,
  :security_service_type,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end