Skip to content

Resource

Source code in docs_src/capo_securityhub/types/resource.py
class Resource(TypedDict, closed=True):
    type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The type of the resource that details are provided for. If possible, set <code>Type</code> to one of the supported resource types. For example, if the resource is an EC2 instance, then set <code>Type</code> to <code>AwsEc2Instance</code>.</p> <p>If the resource does not match any of the provided types, then set <code>Type</code> to <code>Other</code>. </p> <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>"""
    id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The canonical identifier for the given resource type.</p>"""
    partition: NotRequired["capo_securityhub.types.partition.Partition"]
    """<p>The canonical Amazon Web Services partition name that the Region is assigned to.</p>"""
    region: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The canonical Amazon Web Services external Region name where this resource is located.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 16.</p>"""
    provider: NotRequired[
        "capo_securityhub.types.cloud_provider_name.CloudProviderName"
    ]
    """<p>The cloud provider that the resource belongs to. Valid values are <code>AWS</code> and <code>Azure</code>.</p>"""
    owner: NotRequired["capo_securityhub.types.resource_owner.ResourceOwner"]
    """<p>Information about the account and organization that own the resource.</p>"""
    resource_role: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,</p>"""
    tags: NotRequired["capo_securityhub.types.field_map.FieldMap"]
    """<p>A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Tags must follow <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions">Amazon Web Services tag naming limits and requirements</a>.</p>"""
    data_classification: NotRequired[
        "capo_securityhub.types.data_classification_details.DataClassificationDetails"
    ]
    """<p>Contains information about sensitive data that was detected on the resource.</p>"""
    details: NotRequired["capo_securityhub.types.resource_details.ResourceDetails"]
    """<p>Additional details about the resource related to a finding.</p>"""
    application_name: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p> The name of the application that is related to a finding. </p>"""
    application_arn: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p> The Amazon Resource Name (ARN) of the application that is related to a finding. </p>"""

application_arn instance-attribute

application_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the application that is related to a finding.

application_name instance-attribute

application_name: NotRequired[NonEmptyString]

The name of the application that is related to a finding.

data_classification instance-attribute

data_classification: NotRequired[DataClassificationDetails]

Contains information about sensitive data that was detected on the resource.

details instance-attribute

details: NotRequired[ResourceDetails]

Additional details about the resource related to a finding.

id instance-attribute

id: NotRequired[NonEmptyString]

The canonical identifier for the given resource type.

owner instance-attribute

owner: NotRequired[ResourceOwner]

Information about the account and organization that own the resource.

partition instance-attribute

partition: NotRequired[Partition]

The canonical Amazon Web Services partition name that the Region is assigned to.

provider instance-attribute

provider: NotRequired[CloudProviderName]

The cloud provider that the resource belongs to. Valid values are AWS and Azure.

region instance-attribute

region: NotRequired[NonEmptyString]

The canonical Amazon Web Services external Region name where this resource is located.

Length Constraints: Minimum length of 1. Maximum length of 16.

resource_role instance-attribute

resource_role: NotRequired[NonEmptyString]

Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,

tags instance-attribute

tags: NotRequired[FieldMap]

A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Tags must follow Amazon Web Services tag naming limits and requirements.

type instance-attribute

type: NotRequired[NonEmptyString]

The type of the resource that details are provided for. If possible, set Type to one of the supported resource types. For example, if the resource is an EC2 instance, then set Type to AwsEc2Instance.

If the resource does not match any of the provided types, then set Type to Other.

Length Constraints: Minimum length of 1. Maximum length of 256.