Skip to content

RemediationGuidance

Source code in docs_src/capo_securityhub/types/remediation_guidance.py
class RemediationGuidance(TypedDict, closed=True):
    target_type_name: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the remediation target type.</p>"""
    pattern: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The remediation pattern of the remediation target.</p>"""
    version: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The guidance version.</p>"""
    context: NotRequired[
        "capo_securityhub.types.remediation_guidance_context.RemediationGuidanceContext"
    ]
    """<p>The context behind the remediation target's existence and guidance.</p>"""
    specification: NotRequired[
        "capo_securityhub.types.remediation_guidance_specification.RemediationGuidanceSpecification"
    ]
    """<p>The specification of the remediation target guidance. This outlines required resource parameters and permissions, remediation steps, and the end state.</p>"""
    examples: NotRequired[
        "capo_securityhub.types.remediation_guidance_examples.RemediationGuidanceExamples"
    ]
    """<p>Provided remediation guidance examples in different formats that can be run for remediating the target.</p>"""
    metadata: NotRequired[
        "capo_securityhub.types.remediation_guidance_metadata.RemediationGuidanceMetadata"
    ]
    """<p>The metadata of the remediation guidance.</p>"""

context instance-attribute

context: NotRequired[RemediationGuidanceContext]

The context behind the remediation target's existence and guidance.

examples instance-attribute

examples: NotRequired[RemediationGuidanceExamples]

Provided remediation guidance examples in different formats that can be run for remediating the target.

metadata instance-attribute

metadata: NotRequired[RemediationGuidanceMetadata]

The metadata of the remediation guidance.

pattern instance-attribute

pattern: NotRequired[NonEmptyString]

The remediation pattern of the remediation target.

specification instance-attribute

specification: NotRequired[RemediationGuidanceSpecification]

The specification of the remediation target guidance. This outlines required resource parameters and permissions, remediation steps, and the end state.

target_type_name instance-attribute

target_type_name: NotRequired[NonEmptyString]

The name of the remediation target type.

version instance-attribute

version: NotRequired[NonEmptyString]

The guidance version.