Skip to content

PolicySummary

Source code in docs_src/capo_fms/types/policy_summary.py
class PolicySummary(TypedDict, closed=True):
    policy_arn: NotRequired["capo_fms.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the specified policy.</p>"""
    policy_id: NotRequired["capo_fms.types.policy_id.PolicyId"]
    """<p>The ID of the specified policy.</p>"""
    policy_name: NotRequired["capo_fms.types.resource_name.ResourceName"]
    """<p>The name of the specified policy.</p>"""
    resource_type: NotRequired["capo_fms.types.resource_type.ResourceType"]
    """<p>The type of resource protected by or in scope of the policy. This is in the format shown in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services Resource Types Reference</a>. </p>"""
    security_service_type: NotRequired[
        "capo_fms.types.security_service_type.SecurityServiceType"
    ]
    """<p>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.</p>"""
    remediation_enabled: "capo_fms.types.boolean.Boolean"
    """<p>Indicates if the policy should be automatically applied to new resources.</p>"""
    delete_unused_fm_managed_resources: "capo_fms.types.boolean.Boolean"
    """<p>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. </p> <p>By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources. </p> <p>This option is not available for Shield Advanced or WAF Classic policies.</p>"""
    policy_status: NotRequired[
        "capo_fms.types.customer_policy_status.CustomerPolicyStatus"
    ]
    """<p>Indicates whether the policy is in or out of an admin's policy or Region scope.</p> <ul> <li> <p> <code>ACTIVE</code> - The administrator can manage and delete the policy.</p> </li> <li> <p> <code>OUT_OF_ADMIN_SCOPE</code> - 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.</p> </li> </ul>"""

delete_unused_fm_managed_resources instance-attribute

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.

policy_arn instance-attribute

policy_arn: NotRequired[ResourceArn]

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

policy_id instance-attribute

policy_id: NotRequired[PolicyId]

The ID of the specified policy.

policy_name instance-attribute

policy_name: NotRequired[ResourceName]

The name of the specified policy.

policy_status instance-attribute

policy_status: NotRequired[CustomerPolicyStatus]

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.

remediation_enabled instance-attribute

remediation_enabled: Boolean

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

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

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.

security_service_type instance-attribute

security_service_type: NotRequired[SecurityServiceType]

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.