Amazon Config · JSON Structure

Config Put Organization Config Rule Request Structure

PutOrganizationConfigRuleRequest schema

Type: object Properties: 5 Required: 1
AuditingComplianceConfiguration ManagementGovernanceSecurity

PutOrganizationConfigRuleRequest is a JSON Structure definition published by Amazon Config, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

OrganizationConfigRuleName OrganizationManagedRuleMetadata OrganizationCustomRuleMetadata ExcludedAccounts OrganizationCustomPolicyRuleMetadata

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-config/refs/heads/main/json-structure/config-put-organization-config-rule-request-structure.json",
  "name": "PutOrganizationConfigRuleRequest",
  "description": "PutOrganizationConfigRuleRequest schema",
  "type": "object",
  "properties": {
    "OrganizationConfigRuleName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationConfigRuleName"
        },
        {
          "description": "The name that you assign to an organization Config rule."
        }
      ]
    },
    "OrganizationManagedRuleMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationManagedRuleMetadata"
        },
        {
          "description": "An <code>OrganizationManagedRuleMetadata</code> object. This object specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic."
        }
      ]
    },
    "OrganizationCustomRuleMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationCustomRuleMetadata"
        },
        {
          "description": "An <code>OrganizationCustomRuleMetadata</code> object. This object specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic."
        }
      ]
    },
    "ExcludedAccounts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExcludedAccounts"
        },
        {
          "description": "A comma-separated list of accounts that you want to exclude from an organization Config rule."
        }
      ]
    },
    "OrganizationCustomPolicyRuleMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationCustomPolicyRuleMetadata"
        },
        {
          "description": "An <code>OrganizationCustomPolicyRuleMetadata</code> object. This object specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule."
        }
      ]
    }
  },
  "required": [
    "OrganizationConfigRuleName"
  ]
}