AWSOrganization

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

Description

Properties

• default_region: Default region to use when making AWS requests. Default: "us-east-1".
  • All of
    • : Refer to #/definitions/RegionName.
• aws_profile (string): The AWS profile used when making calls to the account.
• hub_role_arn (string): The role arn to assume into when making calls to the account.
• external_id (string): The external id to use for assuming into a role when making calls to the account.
• boto3_session_map (object)
• org_name (string): Optional friendly name for the organization.
• org_id (string): A unique identifier designating the identity of the organization.
• org_account_id (string): The AWS Organization's master account ID.
• identity_center: The AWS Account ID and region of the AWS Identity Center instance to use for this organization.
  • All of
    • : Refer to #/definitions/AWSIdentityCenter.
• default_rule: The rule used to determine how an organization account should be handled if the account was not found in account_rules. Default: {"metadata_commented_dict": {}, "iambic_managed": "undefined"}.
  • All of
    • : Refer to #/definitions/BaseAWSOrgRule.
• account_rules (array): A list of rules used to determine how organization accounts are handled. Default: [].
  • Items: Refer to #/definitions/AWSOrgAccountRule.
• spoke_role_is_read_only (boolean): if true, the spoke role will be limited to read-only permissions. Default: false.
• preferred_spoke_role_name (string): SpokeRoleName use across organization. Default: "IambicSpokeRole".

Definitions

• RegionName: An enumeration. Must be one of: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"].

• AWSIdentityCenter (object)
  • region: Region identity center is configured on. Default: "us-east-1".
    • All of
      • : Refer to #/definitions/RegionName.

• IambicManaged: An enumeration. Must be one of: ["undefined", "read_and_write", "import_only", "enforced", "disabled"].

• BaseAWSOrgRule (object): A base model class that provides additional helper methods and configurations for other models used in IAMbic.
  • iambic_managed: Controls the directionality of iambic changes. Default: "undefined".
    • All of
      • : Refer to #/definitions/IambicManaged.

• AWSOrgAccountRule (object): A base model class that provides additional helper methods and configurations for other models used in IAMbic.
  • iambic_managed: Controls the directionality of iambic changes. Default: "undefined".
    • All of
      • : Refer to #/definitions/IambicManaged.
  • included_accounts (array): A list of account ids and/or account names this rule applies to. Account ids/names can be represented as a regex and string. Default: ["*"].
    • Items (string)
  • excluded_accounts (array): A list of account ids and/or account names this rule explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: [].
    • Items (string)