Amazon Config · Schema

ResourceDetails

Returns information about the resource being evaluated.

AuditingComplianceConfiguration ManagementGovernanceSecurity

Properties

Name Type Description
ResourceId object
ResourceType object
ResourceConfiguration object
ResourceConfigurationSchemaType object
View JSON Schema on GitHub

JSON Schema

config-resource-details-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-config/refs/heads/main/json-schema/config-resource-details-schema.json",
  "title": "ResourceDetails",
  "description": "Returns information about the resource being evaluated.",
  "type": "object",
  "properties": {
    "ResourceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BaseResourceId"
        },
        {
          "description": "A unique resource ID for an evaluation."
        }
      ]
    },
    "ResourceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringWithCharLimit256"
        },
        {
          "description": "The type of resource being evaluated."
        }
      ]
    },
    "ResourceConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceConfiguration"
        },
        {
          "description": "The resource definition to be evaluated as per the resource configuration schema type."
        }
      ]
    },
    "ResourceConfigurationSchemaType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceConfigurationSchemaType"
        },
        {
          "description": "<p>The schema type of the resource configuration.</p> <note> <p>You can find the <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html\">Resource type schema</a>, or <code>CFN_RESOURCE_SCHEMA</code>, in \"<i>Amazon Web Services public extensions</i>\" within the CloudFormation registry or with the following CLI commmand: <code>aws cloudformation describe-type --type-name \"AWS::S3::Bucket\" --type RESOURCE</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view\">Managing extensions through the CloudFormation registry</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services resource and property types reference</a> in the CloudFormation User Guide.</p> </note>"
        }
      ]
    }
  },
  "required": [
    "ResourceId",
    "ResourceType",
    "ResourceConfiguration"
  ]
}