Landing Zone Accelerator on AWS - Replacements Config

Used to manage all of the replacement values across the configuration files

Type IReplacementsConfig
File match replacements-config.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/landing-zone-accelerator-on-aws-replacements-config/latest.json
Source https://raw.githubusercontent.com/awslabs/landing-zone-accelerator-on-aws/main/source/packages/@aws-accelerator/config/lib/schemas/replacements-config.json

Validate with Lintel

npx @lintel/lintel check
Type: IReplacementsConfig

Definitions

IParameterReplacement object

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

key string required

Non-Empty String Type

Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.

minLength=1
path string required

Non-Empty String Type

Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.

minLength=1
IParameterReplacementV2 object

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

key string required

Non-Empty String Type

Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.

minLength=1
type string required

Parameter Replacement Type

Defines the types of parameter replacement mechanisms supported in configuration templates and CloudFormation deployments.

Values

  • SSM: AWS Systems Manager Parameter Store values
  • String: Simple string replacement
  • StringList: Comma-separated list of strings
  • Number: Numeric value replacement

Use Cases

  • SSM: Dynamic configuration values, secrets, cross-stack references
  • String: Static configuration values, environment names
  • StringList: Multiple values like subnet IDs, security group IDs
  • Number: Port numbers, counts, numeric thresholds
Values: "SSM" "String" "StringList" "Number"
path string

Non-Empty String Type

Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.

minLength=1
value NonEmptyString | NonEmptyString[] | number

Value of the parameter if type is string or array

IReplacementsConfig object

Accelerator replacements configuration

globalReplacements IParameterReplacement | IParameterReplacementV2[]

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

NonEmptyString string

Non-Empty String Type

Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.

ParameterReplacementType string

Parameter Replacement Type

Defines the types of parameter replacement mechanisms supported in configuration templates and CloudFormation deployments.

Values

  • SSM: AWS Systems Manager Parameter Store values
  • String: Simple string replacement
  • StringList: Comma-separated list of strings
  • Number: Numeric value replacement

Use Cases

  • SSM: Dynamic configuration values, secrets, cross-stack references
  • String: Static configuration values, environment names
  • StringList: Multiple values like subnet IDs, security group IDs
  • Number: Port numbers, counts, numeric thresholds