SecurityControlDefinition ¶

class SecurityControlDefinition(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 (for example, APIGateway.3). This parameter differs from <code>SecurityControlArn</code>, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3). </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>"""
    current_region_availability: NotRequired[
        "capo_securityhub.types.region_availability_status.RegionAvailabilityStatus"
    ]
    """<p> Specifies whether a security control is available in the current Amazon Web Services Region. </p>"""
    customizable_properties: NotRequired[
        "capo_securityhub.types.customizable_properties.CustomizableProperties"
    ]
    """<p> Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties. </p>"""
    parameter_definitions: NotRequired[
        "capo_securityhub.types.parameter_definitions.ParameterDefinitions"
    ]
    """<p> An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters. </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>"""