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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fms/types.rb

Overview

Details of the Firewall Manager policy.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delete_unused_fm_managed_resourcesBoolean

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)


3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
# 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_arnString

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

Returns:

  • (String)


3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
# 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_idString

The ID of the specified policy.

Returns:

  • (String)


3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
# 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_nameString

The name of the specified policy.

Returns:

  • (String)


3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
# 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_statusString

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)


3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
# 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_enabledBoolean

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

Returns:

  • (Boolean)


3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
# 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_typeString

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)


3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
# 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_typeString

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)


3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
# 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