Class ReplacementsConfig

Accelerator replacements configuration

Hierarchy

  • ReplacementsConfig

Implements

Constructors

constructor

Properties

accountsConfig globalReplacements placeholders validateOnly FILENAME POLICY_PARAMETER_PREFIX

Methods

loadReplacementValues preProcessBuffer load

Constructors

constructor

  • Parameters

    • Optional values: {
          globalReplacements: undefined | (({ key: string; path: string; }) | ({ key: string; path: string | undefined; type: "String" | "SSM" | "StringList"; value: string | string[] | undefined; }))[];
      }
      • globalReplacements: undefined | (({ key: string; path: string; }) | ({ key: string; path: string | undefined; type: "String" | "SSM" | "StringList"; value: string | string[] | undefined; }))[]
    • Optional accountsConfig: AccountsConfig
    • validateOnly: boolean = false

    Returns ReplacementsConfig

Properties

Readonly accountsConfig

accountsConfig: undefined | AccountsConfig = undefined

Readonly globalReplacements

globalReplacements: (ParameterReplacementConfig | ParameterReplacementConfigV2)[] = []

The set of placeholder parameters (key/path pairs) that will be merged with yaml configuration files.

placeholders

placeholders: {
    [key: string]: string | string[];
} = {}

Type declaration

  • [key: string]: string | string[]

validateOnly

validateOnly: boolean = false

Static Readonly FILENAME

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

Replacements configuration file name, this file must be present in accelerator config repository

Static Readonly POLICY_PARAMETER_PREFIX

POLICY_PARAMETER_PREFIX: "ACCEL_LOOKUP::CUSTOM" = 'ACCEL_LOOKUP::CUSTOM'

The prefix that needs to be appended in the parameters used in policy files.

For example, ${POLICY_PARAMETER_PREFIX}:ALLOWED_CORPORATE_CIDRS should be used in policy file if ALLOWED_CORPORATE_CIDRS is defined in replacement-config.yaml

Methods

loadReplacementValues

  • Loads replacement values by utilizing the systems manager client

    Parameters

    Returns Promise<void>

preProcessBuffer

  • Parameters

    • initialBuffer: string

    Returns string

Static load

Settings

Member Visibility

Theme

Generated using TypeDoc