AccountsConfig / AccountConfig

Account configuration

Example

- name: Workload01
description: Workload account 01
email: example-email+workload01@example.com
organizationalUnit: Workloads
warm: true

Hierarchy

  • AccountConfig

Implements

Constructors

Properties

description: string = ''

The description is to used to provide more information about the account. This value is not used when creating accounts.

email: string = ''

The email address of the owner to assign to the account. The email address must not already be associated with another AWS account. You must use a valid email address. The address must be a minimum of 6 and a maximum of 64 characters long. All characters must be 7-bit ASCII characters There must be one and only one @ symbol, which separates the local name from the domain name. The local name can’t contain any of the following characters: whitespace, ” ‘ ( ) < > [ ] : ; , | % & The local name can’t begin with a dot (.) The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) The domain name can’t begin or end with a hyphen (-) or dot (.) The domain name must contain at least one dot

name: string = ''

The friendly name that is assigned to the account for reference within the Accelerator. The name will be used to reference this account in other configuration files and not to lookup the account in AWS.

For pre-existing accounts this does not need to match the AWS account name.

When creating new accounts with the Accelerator, this name will be used as the AWS account name.

The name should not contain any spaces as this isn't supported by the Accelerator.

organizationalUnit: string = ''

The friendly name for the Organizational Unit that this account is a member of. This Organizational Unit must exist in the organization-config.yaml file.

warm: undefined | boolean = undefined

'Warm' the account by creating an EC2 instance that runs for 15 minutes Use for new accounts that will need to have ec2 instance provisioned as part of the solution The 'warming' will take place in the operations stack This property may be removed after the account has been provisioned

Generated using TypeDoc