Skip to main content

AWSAccount

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

Description​

Inherited by the provider class to provide a consistent interface for AccessModelMixin

For AWS, this is the AWS account For GCP, this is the GCP project For Okta, this is the IDP domain

Properties​

  • default_region: Default region to use when making AWS requests. Default: "us-east-1".
  • 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)
  • iambic_managed: Controls the directionality of iambic changes. Default: "undefined".
  • account_id (string): The AWS Account ID.
  • org_id (string): A unique identifier designating the identity of the organization.
  • account_name (string)
  • partition: The AWS partition the account is in. Options are aws, aws-us-gov, and aws-cn. Default: "aws".
  • variables (array): A list of variables to be used when creating templates. Default: [].
  • hub_session_info (object)
  • identity_center_details: Refer to #/definitions/IdentityCenterDetails.
  • spoke_role_arn (string): (Auto-populated) The role arn to assume into when making calls to the account.
  • assume_role_arn (string): The role arn to assume into when making calls to the account.
  • organization: The AWS Organization this account belongs to.

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"].
  • IambicManaged: An enumeration. Must be one of: ["undefined", "read_and_write", "import_only", "enforced", "disabled"].
  • Partition: An enumeration. Must be one of: ["aws", "aws-us-gov", "aws-cn"].
  • Variable (object)
    • key (string, required)
    • value (string, required)
  • IdentityCenterDetails (object)
    • region: Default: "us-east-1".
    • instance_arn (string)
    • identity_store_id (string)
    • permission_set_map (object)
    • user_map (object)
    • group_map (object)
    • org_account_map (object)