Interface IParameterReplacementV2

ReplacementsConfig / ParameterReplacementConfig

Description

Fixed replacement value to apply throughout config files. Loaded from SSM parameters in the management account in the HOME_REGION.

Remarks

These SSM Parameters must exist with non-null values before they are added to the replacements-config.yaml file.

Example

globalReplacements:
  - key: FndPrefix
    type: 'SSM'
    path: /accelerator/replacements/FndPrefix
  - key: BudgetEmail
    type: 'SSM'
    path: /accelerator/replacements/BudgetEmail
  - key: ProtectTagKey
    type: 'SSM'
    path: /accelerator/replacements/ProtectTagKey
  - key: ProtectTagValue
    type: 'SSM'
    path: /accelerator/replacements/ProtectTagValue
 -  key: ALLOWED_CORPORATE_CIDRS
    type: 'StringList'
    value:
      - 10.0.1.0/24
      - 10.0.2.0/24
 -  key: ALLOWED_PRINCIPAL_ARN
    type: 'String'
    value: arn:aws:iam::*:role/AWSA*
interface IParameterReplacementV2 {
    key: string;
    path?: string;
    type: ParameterReplacementType;
    value?: string | string[];
}

Properties

key path? type value?

Properties

Readonlykey

key: string

Key of the replacement placeholder

Optional Readonlypath

path?: string

Path of the SSM Parameter containing the value to replace

Readonlytype

type: ParameterReplacementType

Type of the global parameters

Optional Readonlyvalue

value?: string | string[]

Value of the parameter if type is string or array

Settings

Member Visibility

On This Page

Properties