class ArrayMergeStrategy

Language	Type name
.NET	Amazon.CDK.ArrayMergeStrategy
Go	github.com/aws/aws-cdk-go/awscdk/v2#ArrayMergeStrategy
Java	software.amazon.awscdk.ArrayMergeStrategy
Python	aws_cdk.ArrayMergeStrategy
TypeScript (source)	aws-cdk-lib » ArrayMergeStrategy

Strategies for merging arrays in L1 property mixins.

Array elements are never deep-merged.

Methods

Name	Description
static append()	Append source elements after the existing target elements.
static prepend()	Prepend source elements before the existing target elements.
static replace()	Replace the target array entirely with the source array.
static replaceByIndex()	Overwrite target elements positionally with source elements.
static replaceByKey(key)	Match source and target elements by a shared key property.

---

static append()

public static append(): IArrayMergeStrategy

Returns

• IArrayMergeStrategy

Append source elements after the existing target elements. Example

// target: [1, 2], source: [3, 4] → [1, 2, 3, 4]

---

static prepend()

public static prepend(): IArrayMergeStrategy

Returns

• IArrayMergeStrategy

Prepend source elements before the existing target elements. Example

// target: [1, 2], source: [3, 4] → [3, 4, 1, 2]

---

static replace()

public static replace(): IArrayMergeStrategy

Returns

• IArrayMergeStrategy

Replace the target array entirely with the source array. Example

// target: [1, 2, 3], source: [4, 5] → [4, 5]

---

static replaceByIndex()

public static replaceByIndex(): IArrayMergeStrategy

Returns

• IArrayMergeStrategy

Overwrite target elements positionally with source elements.

Target elements beyond the source length are preserved. Example

// target: ['a', 'b', 'c', 'd'], source: ['x', 'y'] → ['x', 'y', 'c', 'd']

---

static replaceByKey(key)

public static replaceByKey(key: string): IArrayMergeStrategy

Parameters

• key string — - The property name to match elements on.

Returns

• IArrayMergeStrategy

Match source and target elements by a shared key property.

Matching target elements are replaced (not deep-merged). Unmatched source elements are appended. Example

// key: 'id'
// target: [{id: 1, v: 'old'}, {id: 2, v: 'keep'}]
// source: [{id: 1, v: 'new'}, {id: 3, v: 'added'}]
// result: [{id: 1, v: 'new'}, {id: 2, v: 'keep'}, {id: 3, v: 'added'}]