Skip to main content

Config

See Template Schema Validation to learn how to validate templates automatically in your IDE.

Description​

A base model class that provides additional helper methods and configurations for other models used in IAMbic.

Properties​

  • template_type (string): Default: "NOQ::Core::Config".
  • template_schema_url (string): Default: "https://docs.iambic.org/reference/schemas/config".
  • owner (string)
  • notes (string)
  • iambic_managed: Controls the directionality of Iambic changes. Default: "undefined".
  • version (string): Do not change! The version of iambic this repo is compatible with.
  • plugins (array): The plugins used by your IAMbic template repo. Default: [{"type": "DIRECTORY_PATH", "location": "./iambic/plugins/v0_1_0/aws", "version": "v0.1.0"}, {"type": "DIRECTORY_PATH", "location": "./iambic/plugins/v0_1_0/google_workspace", "version": "v0.1.0"}, {"type": "DIRECTORY_PATH", "location": "./iambic/plugins/v0_1_0/okta", "version": "v0.1.0"}, {"type": "DIRECTORY_PATH", "location": "./iambic/plugins/v0_1_0/github", "version": "v0.1.0"}, {"type": "DIRECTORY_PATH", "location": "./iambic/plugins/v0_1_0/azure_ad", "version": "v0.1.0"}].
  • extends (array): Default: [].
  • secrets (object): Secrets should only be used in memory and never serialized out. Default: {}.
  • plugin_instances (array): A list of the plugin instances parsed as part of the plugin paths.
  • core: Core configuration options for iambic. Default: {"minimum_ulimit": 64000, "exception_reporting": null, "detection_messages": null}.

Definitions​

  • IambicManaged: An enumeration. Must be one of: ["undefined", "read_and_write", "import_only", "enforced", "disabled"].
  • PluginType: An enumeration. Must be one of: ["DIRECTORY_PATH"].
  • PluginDefinition (object)
    • type: Refer to #/definitions/PluginType.
    • location (string, required): The location of the plugin. For a DIRECTORY_PATH, this is the path to the plugin. For a GIT plugin, this is the git url.
    • version (string, required)
  • ExtendsConfigKey: An enumeration. Must be one of: ["AWS_SECRETS_MANAGER", "LOCAL_FILE"].
  • ProviderPlugin (object)
    • version (string, required): The version of the plugin.
    • config_name (string, required): The name of the provider configuration in the iambic config file.
    • requires_secret (boolean): Whether or not the provider requires a secret to be passed in. Default: false.
    • provider_config: The Pydantic model that is attached to the Config.This will contain the provider specific configuration.These are things like the AWSAccount model, OktaOrganization or GoogleProject.
    • templates (array, required): The list of templates used for this provider.
      • Items
  • ExceptionReporting (object)
    • enabled (boolean, required): Enable or disable exception reporting.
    • include_variables (boolean): Include local variables in the report. Default: false.
    • automatically_send_reports (boolean): Automatically send reports without asking for user consent.
    • email_address (string): Email address for correspondence about the exception, if you would like us to communicate with you.
  • DetectionMessages (object)
    • enabled (boolean, required): Enable or disable detection messages.