Interface Resolver

An interface to be implemented by objects that resolve values for stack parameters at deploy time.

interface Resolver {
    confidential?: boolean | (() => boolean);
    dependencies?: string[] | (() => string[]);
    iamRoleArns?: string[] | (() => string[]);
    resolve: ((input) => Promise<any>);
}

Properties

confidential? dependencies? iamRoleArns? resolve

Properties

Optional Readonly confidential

confidential?: boolean | (() => boolean)

An optional boolean indicating whether the resolved parameter value is confidential and should be concealed from the logs.

Type declaration

    • (): boolean

    • Returns boolean

Optional Readonly dependencies

dependencies?: string[] | (() => string[])

An optional list of stack paths of the stacks this resolver depends on.

The stacks are added to the list of stacks that the stack where this resolver is used depends on.

Type declaration

    • (): string[]

    • Returns string[]

Optional Readonly iamRoleArns

iamRoleArns?: string[] | (() => string[])

An optional list of IAM roles needed to resolve the parameter value.

The credentials used to deploy the stack that uses this resolver must have sufficient permissions to assume the listed IAM roles.

Type declaration

    • (): string[]

    • Returns string[]

Readonly resolve

resolve: ((input) => Promise<any>)

Resolve the stack parameter value.

Type declaration

    • (input): Promise<any>

    • Resolve the stack parameter value.

      Parameters

      Returns Promise<any>

      Resolved parameter value

Param: input

Resolver input

Returns

Resolved parameter value

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc