AWS Configuration Files
config.yaml
This file instructs the pf-update-aws --build
command how to generate the aws config file (config
) which is used by the AWS CLI and SDK.
Format
YAML Schema
sso_start_url = stringsso_region = stringdefault_aws_region = optional(string)module = optional(string)extra_roles = optional(list(object({ account_name = string account_id = string roles = list(string)})))
Top-level Keys
Value | Description | Example |
---|---|---|
sso_start_url | The sign-in url to your IAM Identity Center instance | https://panfactum.awsapps.com/start |
sso_region | The region of your IAM Identity center instance | us-east-2 |
default_aws_region | (Optional) The default region for all configured profiles | us-east-2 |
module | (Optional) A path from <environments_dir> to your aws_iam_identity_center_permissions module (if using) | management/global/aws_iam_identity_center_permissions |
extra_roles | (Optional) Additional statically configured extra roles to use | See below |
extra_roles
This is a list containing objects with the following fields:
Value | Description | Example |
---|---|---|
account_name | An arbitrary human-readable name for the account | production |
account_id | The AWS account id for the account | 1234567891232 |
roles | A list of the IAM Identity Center PermissionSets assigned to this account | ["ExampleRole1", "ExampleRole2"] |