Skip to content

SecurityControl

Source code in docs_src/capo_securityhub/types/security_control.py
class SecurityControl(TypedDict, closed=True):
    security_control_id: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p> The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number, such as APIGateway.3. </p>"""
    security_control_arn: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p> The Amazon Resource Name (ARN) for a security control across standards, such as <code>arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1</code>. This parameter doesn't mention a specific standard. </p>"""
    title: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The title of a security control. </p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The description of a security control across standards. This typically summarizes how Security Hub CSPM evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard. </p>"""
    remediation_url: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p> A link to Security Hub CSPM documentation that explains how to remediate a failed finding for a security control. </p>"""
    severity_rating: NotRequired[
        "capo_securityhub.types.severity_rating.SeverityRating"
    ]
    """<p> The severity of a security control. For more information about how Security Hub CSPM determines control severity, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity">Assigning severity to control findings</a> in the <i>Security Hub CSPM User Guide</i>. </p>"""
    security_control_status: NotRequired[
        "capo_securityhub.types.control_status.ControlStatus"
    ]
    """<p> The enablement status of a security control in a specific standard. </p>"""
    update_status: NotRequired["capo_securityhub.types.update_status.UpdateStatus"]
    """<p> Identifies whether customizable properties of a security control are reflected in Security Hub CSPM findings. A status of <code>READY</code> indicates that Security Hub CSPM uses the current control parameter values when running security checks of the control. A status of <code>UPDATING</code> indicates that all security checks might not use the current parameter values. </p>"""
    parameters: NotRequired["capo_securityhub.types.parameters.Parameters"]
    """<p> An object that identifies the name of a control parameter, its current value, and whether it has been customized. </p>"""
    last_update_reason: NotRequired[
        "capo_securityhub.types.alpha_numeric_non_empty_string.AlphaNumericNonEmptyString"
    ]
    """<p> The most recent reason for updating the customizable properties of a security control. This differs from the <code>UpdateReason</code> field of the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html"> <code>BatchUpdateStandardsControlAssociations</code> </a> API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores. </p>"""
    provider: NotRequired[
        "capo_securityhub.types.security_controls_provider.SecurityControlsProvider"
    ]
    """<p>The cloud provider whose resources the security control evaluates. For example, <code>AWS</code> or <code>Azure</code>.</p>"""

description instance-attribute

description: NotRequired[NonEmptyString]

The description of a security control across standards. This typically summarizes how Security Hub CSPM evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

last_update_reason instance-attribute

last_update_reason: NotRequired[AlphaNumericNonEmptyString]

The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.

parameters instance-attribute

parameters: NotRequired[Parameters]

An object that identifies the name of a control parameter, its current value, and whether it has been customized.

provider instance-attribute

provider: NotRequired[SecurityControlsProvider]

The cloud provider whose resources the security control evaluates. For example, AWS or Azure.

remediation_url instance-attribute

remediation_url: NotRequired[NonEmptyString]

A link to Security Hub CSPM documentation that explains how to remediate a failed finding for a security control.

security_control_arn instance-attribute

security_control_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.

security_control_id instance-attribute

security_control_id: NotRequired[NonEmptyString]

The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number, such as APIGateway.3.

security_control_status instance-attribute

security_control_status: NotRequired[ControlStatus]

The enablement status of a security control in a specific standard.

severity_rating instance-attribute

severity_rating: NotRequired[SeverityRating]

The severity of a security control. For more information about how Security Hub CSPM determines control severity, see Assigning severity to control findings in the Security Hub CSPM User Guide.

title instance-attribute

title: NotRequired[NonEmptyString]

The title of a security control.

update_status instance-attribute

update_status: NotRequired[UpdateStatus]

Identifies whether customizable properties of a security control are reflected in Security Hub CSPM findings. A status of READY indicates that Security Hub CSPM uses the current control parameter values when running security checks of the control. A status of UPDATING indicates that all security checks might not use the current parameter values.