Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • AccountsConfig

Implements

Index

Constructors

  • new AccountsConfig(props: { auditAccountEmail: string; logArchiveAccountEmail: string; managementAccountEmail: string }, values?: { accountIds: undefined | { email: string; accountId: string; }[]; mandatoryAccounts: ({ name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; } | { name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; enableGovCloud: boolean | undefined; })[]; workloadAccounts: ({ name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; } | { name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; enableGovCloud: boolean | undefined; })[] }): AccountsConfig
  • Parameters

    • props: { auditAccountEmail: string; logArchiveAccountEmail: string; managementAccountEmail: string }
      • auditAccountEmail: string
      • logArchiveAccountEmail: string
      • managementAccountEmail: string
    • Optional values: { accountIds: undefined | { email: string; accountId: string; }[]; mandatoryAccounts: ({ name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; } | { name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; enableGovCloud: boolean | undefined; })[]; workloadAccounts: ({ name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; } | { name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; enableGovCloud: boolean | undefined; })[] }
      • accountIds: undefined | { email: string; accountId: string; }[]
      • mandatoryAccounts: ({ name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; } | { name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; enableGovCloud: boolean | undefined; })[]
      • workloadAccounts: ({ name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; } | { name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; enableGovCloud: boolean | undefined; })[]

    Returns AccountsConfig

Properties

accountIds: undefined | AccountIdConfig[] = undefined

Optionally provide a list of AWS Account IDs to bypass the usage of the AWS Organizations Client lookup. This is not a readonly member since we will initialize it with values if it is not provided

mandatoryAccounts: AccountConfig[] | GovCloudAccountConfig[] = []
workloadAccounts: AccountConfig[] | GovCloudAccountConfig[] = []
AUDIT_ACCOUNT: "Audit" = 'Audit'
FILENAME: "accounts-config.yaml" = 'accounts-config.yaml'
LOG_ARCHIVE_ACCOUNT: "LogArchive" = 'LogArchive'
MANAGEMENT_ACCOUNT: "Management" = 'Management'

Methods

  • anyGovCloudAccounts(): boolean
  • Returns boolean

  • containsAccount(name: string): boolean
  • Parameters

    • name: string

    Returns boolean

  • getAccountId(name: string): string
  • Parameters

    • name: string

    Returns string

  • getAuditAccountId(): string
  • Returns string

  • getLogArchiveAccountId(): string
  • Returns string

  • getManagementAccountId(): string
  • Returns string

  • loadAccountIds(partition: string): Promise<void>
  • Loads account ids by utilizing the organizations client if account ids are not provided in the config.

    Parameters

    • partition: string

    Returns Promise<void>

Generated using TypeDoc