Class AccountsConfig

Hierarchy

AccountsConfig

Implements

TypeOf<typeof accountsConfig>

Constructors

constructor

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; warm: boolean | 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; warm: boolean | 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; warm: boolean | 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; warm: boolean | 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; warm: boolean | 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; warm: boolean | undefined; }) | ({ name: string; description: string | undefined; email: string; organizationalUnit: string | undefined; enableGovCloud: boolean | undefined; }))[]
Returns AccountsConfig

Properties

accountIds

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

`Readonly` mandatoryAccounts

mandatoryAccounts: AccountConfig[] | GovCloudAccountConfig[] = []

`Readonly` workloadAccounts

workloadAccounts: AccountConfig[] | GovCloudAccountConfig[] = []

`Static` `Readonly` AUDIT_ACCOUNT

AUDIT_ACCOUNT: "Audit" = 'Audit'

`Static` `Readonly` FILENAME

FILENAME: "accounts-config.yaml" = 'accounts-config.yaml'

`Static` `Readonly` LOG_ARCHIVE_ACCOUNT

LOG_ARCHIVE_ACCOUNT: "LogArchive" = 'LogArchive'

`Static` `Readonly` MANAGEMENT_ACCOUNT

MANAGEMENT_ACCOUNT: "Management" = 'Management'

Methods

`Private` _addAccountId

_addAccountId(ids: string[], accountId: string): void
Parameters
- ids: string[]
- accountId: string
Returns void

anyGovCloudAccounts

anyGovCloudAccounts(): boolean
Returns boolean

containsAccount

containsAccount(name: string): boolean
Parameters
- name: string
Returns boolean

getAccount

getAccount(name: string): AccountConfig
Parameters
- name: string
Returns AccountConfig

getAccountId

getAccountId(name: string): string
Parameters
- name: string
Returns string

getAccountIds

getAccountIds(): string[]
Returns string[]

getAccountIdsFromDeploymentTarget

getAccountIdsFromDeploymentTarget(deploymentTargets: DeploymentTargets): string[]
Parameters
- deploymentTargets: DeploymentTargets
Returns string[]

getAccounts

getAccounts(enableSingleAccountMode: boolean): (AccountConfig | GovCloudAccountConfig)[]
Parameters
- enableSingleAccountMode: boolean
Returns (AccountConfig | GovCloudAccountConfig)[]

getAuditAccount

getAuditAccount(): AccountConfig
Returns AccountConfig

getAuditAccountId

getAuditAccountId(): string
Returns string

getExcludedAccountIds

getExcludedAccountIds(deploymentTargets: DeploymentTargets): string[]
Parameters
- deploymentTargets: DeploymentTargets
Returns string[]

getLogArchiveAccount

getLogArchiveAccount(): AccountConfig
Returns AccountConfig

getLogArchiveAccountId

getLogArchiveAccountId(): string
Returns string

getManagementAccount

getManagementAccount(): AccountConfig
Returns AccountConfig

getManagementAccountId

getManagementAccountId(): string
Returns string

isGovCloudAccount

isGovCloudAccount(account: AccountConfig | GovCloudAccountConfig): boolean
Parameters
- account: AccountConfig | GovCloudAccountConfig
Returns boolean

isGovCloudEnabled

isGovCloudEnabled(account: AccountConfig | GovCloudAccountConfig): undefined | boolean
Parameters
- account: AccountConfig | GovCloudAccountConfig
Returns undefined | boolean

loadAccountIds

loadAccountIds(partition: string, enableSingleAccountMode: boolean): Promise<void>
Loads account ids by utilizing the organizations client if account ids are not provided in the config.
Parameters
- partition: string
- enableSingleAccountMode: boolean
Returns Promise<void>

`Static` load

load(dir: string): AccountsConfig
Returns
Parameters
- dir: string
Returns AccountsConfig

Class AccountsConfig

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: { auditAccountEmail: string; logArchiveAccountEmail: string; managementAccountEmail: string; }

auditAccountEmail: string

logArchiveAccountEmail: string

managementAccountEmail: string

accountIds: undefined | ({ email: string; accountId: string; })[]

Returns AccountsConfig

Properties

accountIds

Readonly mandatoryAccounts

Readonly workloadAccounts

Static Readonly AUDIT_ACCOUNT

Static Readonly FILENAME

Static Readonly LOG_ARCHIVE_ACCOUNT

Static Readonly MANAGEMENT_ACCOUNT

Methods

Private _addAccountId

Parameters

ids: string[]

accountId: string

Returns void

anyGovCloudAccounts

Returns boolean

containsAccount

Parameters

name: string

Returns boolean

getAccount

Parameters

name: string

Returns AccountConfig

getAccountId

Parameters

name: string

Returns string

getAccountIds

Returns string[]

getAccountIdsFromDeploymentTarget

Parameters

deploymentTargets: DeploymentTargets

Returns string[]

getAccounts

Parameters

enableSingleAccountMode: boolean

Returns (AccountConfig | GovCloudAccountConfig)[]

getAuditAccount

Returns AccountConfig

getAuditAccountId

Returns string

getExcludedAccountIds

Parameters

deploymentTargets: DeploymentTargets

Returns string[]

getLogArchiveAccount

Returns AccountConfig

getLogArchiveAccountId

Returns string

getManagementAccount

Returns AccountConfig

getManagementAccountId

Returns string

isGovCloudAccount

Parameters

account: AccountConfig | GovCloudAccountConfig

Returns boolean

isGovCloudEnabled

Parameters

account: AccountConfig | GovCloudAccountConfig

Returns undefined | boolean

loadAccountIds

Parameters

props: {
auditAccountEmail: string;
logArchiveAccountEmail: string;
managementAccountEmail: string;
}

`Readonly` mandatoryAccounts

`Readonly` workloadAccounts

`Static` `Readonly` AUDIT_ACCOUNT

`Static` `Readonly` FILENAME

`Static` `Readonly` LOG_ARCHIVE_ACCOUNT

`Static` `Readonly` MANAGEMENT_ACCOUNT

`Private` _addAccountId

`Static` load