Amplify Toolbox
    Preparing search index...

    Interface SecretValue

    Marker returned by secret — a sensitive value in AWS Secrets Manager.

    interface SecretValue {
        "[MANAGED_BRAND]": true;
        key: string;
        kind: "secret";
        schema?: StandardSchemaV1<unknown, unknown>;
    }
    Index

    Properties

    [MANAGED_BRAND] key kind schema?

    Properties

    "[MANAGED_BRAND]": true
    key: string

    The logical name; the key you set with secret set <key> and read with getSecret('<key>').

    kind: "secret"

    Always 'secret' (→ Secrets Manager).

    schema?: StandardSchemaV1<unknown, unknown>

    Optional value schema (Zod/Valibot/ArkType — any Standard Schema). When set, getSecret('<key>') returns the schema's output type (typegen inlines it) and the runtime JSON-parses the stored value. Carried for synth wiring (the parse flag) and typegen type inference; never serialized to the template.

    Settings

    Member Visibility

    On This Page

    Properties