Resource

resource

The resource object describes a managed resource.

Deprecated since 1.1.0: Deprecated in upgrade from ocsf-0.31.1 to qdm-1.1.0

Contents

Attributes

Caption Name Type Is Array Default Description
Account UID account_uid String The unique identifier of the resource owning account(e.g. AWS Account ID).
Cloud Partition cloud_partition String The canonical cloud partition name to which the region is assigned (e.g. AWS Partitions: aws, aws-cn, aws-us-gov).
Criticality criticality String The criticality of the resource.
Details details String The details pertaining to the resource.
Group Name group_name String The name of the group that the resource belongs to.

Deprecated since 1.1.0: Use the group.name attribute instead.
Labels labels String The list of labels attached to an event, object, or attribute.
Name name String The name of the resource.
Owner owner String The identity of the service or user account that owns the resource
Raw Data raw_data JSON The event data as received from the event source.
Record ID record_id String Unique identifier for the object
Region region String The region of the resource.
Type type String The type of the resource.
Unique ID uid String The unique identifier of the resource.

References

Referenced By

Context

Resource

JSON

            
{
  "description": "The resource object describes a managed resource.",
  "caption": "Resource",
  "name": "resource",
  "attributes": {
    "account_uid": {
      "description": "The unique identifier of the resource owning account(e.g. AWS Account ID).",
      "requirement": "optional",
      "caption": "Account UID",
      "type": "string_t"
    },
    "cloud_partition": {
      "requirement": "optional",
      "caption": "Cloud Partition",
      "description": "The canonical cloud partition name to which the region is assigned (e.g. AWS Partitions: aws, aws-cn, aws-us-gov).",
      "type": "string_t"
    },
    "criticality": {
      "description": "The criticality of the resource.",
      "requirement": "optional",
      "caption": "Criticality",
      "type": "string_t"
    },
    "details": {
      "description": "The details pertaining to the resource.",
      "requirement": "optional",
      "caption": "Details",
      "type": "string_t"
    },
    "group_name": {
      "requirement": "recommended",
      "caption": "Group Name",
      "description": "The name of the group that the resource belongs to.",
      "type": "string_t",
      "@deprecated": {
        "message": "Use the <code> group.name </code> attribute instead.",
        "since": "1.1.0"
      }
    },
    "labels": {
      "requirement": "optional",
      "caption": "Labels",
      "description": "The list of labels attached to an event, object, or attribute.",
      "is_array": true,
      "type": "string_t"
    },
    "name": {
      "description": "The name of the resource.",
      "requirement": "recommended",
      "caption": "Name",
      "type": "string_t"
    },
    "owner": {
      "description": "The identity of the service or user account that owns the resource",
      "requirement": "recommended",
      "caption": "Owner",
      "type": "string_t"
    },
    "region": {
      "description": "The region of the resource.",
      "requirement": "optional",
      "caption": "Region",
      "type": "string_t"
    },
    "type": {
      "description": "The type of the resource.",
      "requirement": "optional",
      "caption": "Type",
      "type": "string_t"
    },
    "uid": {
      "description": "The unique identifier of the resource.",
      "requirement": "recommended",
      "caption": "Unique ID",
      "type": "string_t"
    },
    "raw_data": {
      "group": "context",
      "caption": "Raw Data",
      "description": "The event data as received from the event source.",
      "type": "json_t"
    },
    "record_id": {
      "description": "Unique identifier for the object",
      "group": "primary",
      "requirement": "required",
      "caption": "Record ID",
      "type": "string_t"
    }
  },
  "@deprecated": {
    "since": "1.1.0",
    "message": "Deprecated in upgrade from ocsf-0.31.1 to qdm-1.1.0"
  },
  "extension": "archive"
}