@aws-blocks/bb-app-setting 0.1.0

package/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

package/README.md

@@ -0,0 +1,156 @@
+# AppSetting
+
+A single application configuration value backed by SSM Parameter Store.
+
+**When to use:** You need a configuration value (feature flag, API URL, threshold) or a secret (API key, token) stored as a single SSM parameter. Each `AppSetting` instance maps to exactly one parameter.
+
+**When NOT to use:** If you need structured key-value data with conditional writes and queries, use `KVStore` or `DistributedTable`.
+
+## API
+
+```typescript
+const setting = new AppSetting(scope, id, options)
+```
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `get()` | `Promise<T>` | Read the current value. |
+| `put(value)` | `Promise<void>` | Update the value at runtime. |
+
+### Options
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `name` | `string` | No | SSM parameter path. When omitted, derived from the scope tree as `/${fullId}`, guaranteeing uniqueness within the stack. |
+| `value` | `T` | No | Initial value. Required for non-secret parameters. Must not be provided when `secret` is set. |
+| `schema` | `StandardSchemaV1<T>` | No | Runtime validation schema (Zod, Valibot, ArkType). Infers `T` from the schema. Cannot be used with `secret`. |
+| `secret` | `boolean` | No | When `true`, creates an SSM SecureString encrypted with the `aws/ssm` KMS key. Cannot be used with `schema` or `value`. |
+| `logger` | `ChildLogger` | No | Optional logger for internal operations. When omitted, a default Logger at error level is created. |
+
+> **Naming:** When you omit `name`, the framework derives a unique SSM path from
+> the construct scope tree (`/${fullId}`). This is the recommended approach — it
+> prevents collisions across stacks automatically. If you provide an explicit
+> `name`, **you** are responsible for ensuring it is unique across all stacks
+> deployed to the same AWS account and region.
+
+### Error Handling
+
+```typescript
+import { isBlocksError } from '@aws-blocks/core';
+import { AppSettingErrors } from '@aws-blocks/bb-app-setting';
+
+try {
+  await setting.put(value);
+} catch (e: unknown) {
+  if (isBlocksError(e, AppSettingErrors.ValidationFailed)) {
+    // schema validation failed or value exceeds 4 KB
+  }
+  throw e;
+}
+
+try {
+  const value = await setting.get();
+} catch (e: unknown) {
+  if (isBlocksError(e, AppSettingErrors.ParameterNotFound)) {
+    // the parameter is missing (e.g., deleted out-of-band) or a secret has an empty value
+  }
+  throw e;
+}
+```
+
+`get()` can throw `AppSettingErrors.ParameterNotFound` when the parameter does not exist or a secret parameter has an empty value (in both the AWS and mock runtimes).
+
+## Examples
+
+### Plain String Setting
+
+```typescript
+// Recommended: let the framework manage the SSM name (unique by default)
+const apiUrl = new AppSetting(scope, 'apiUrl', {
+  value: 'https://api.example.com',
+});
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async getApiUrl() {
+    return { url: await apiUrl.get() };
+  },
+  async setApiUrl(url: string) {
+    await apiUrl.put(url);
+  },
+}));
+```
+
+### Typed Object with Schema
+
+```typescript
+import { z } from 'zod';
+
+const config = new AppSetting(scope, 'config', {
+  value: { maxRetries: 3, timeout: 5000 },
+  schema: z.object({ maxRetries: z.number(), timeout: z.number() }),
+});
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async getConfig() {
+    return await config.get(); // { maxRetries: number; timeout: number }
+  },
+  async updateConfig(cfg: { maxRetries: number; timeout: number }) {
+    await config.put(cfg); // validated against schema
+  },
+}));
+```
+
+### Secret
+
+```typescript
+const stripeKey = new AppSetting(scope, 'stripeKey', {
+  secret: true,
+});
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async charge(amount: number) {
+    const key = await stripeKey.get(); // decrypted from SSM SecureString
+    // use key...
+  },
+}));
+```
+
+### Explicit Name (Cross-Service Reads)
+
+Use an explicit `name` when the SSM parameter must be read by other services or follow a well-known path convention.
+
+> ⚠️ You must ensure this name is unique across all stacks deployed to the
+> same AWS account and region to avoid collisions.
+
+```typescript
+const apiUrl = new AppSetting(scope, 'apiUrl', {
+  name: '/my-app/production/api-url',
+  value: 'https://api.example.com',
+});
+```
+
+## Validation Rules
+
+These are enforced at CDK synth time:
+
+- `secret` + `schema` → error (secrets are plain strings)
+- `schema` without `value` → error (parameter needs a valid initial value)
+- `secret` with `value` → error (don't put secrets in source code)
+- Non-secret without `value` → error (settings require an initial value)
+
+## Scaling & Cost (AWS)
+
+- **String parameters:** Standard tier, free, 4 KB limit, 10,000 per account/region
+- **SecureString parameters:** Standard tier, free, encrypted with `aws/ssm` KMS key
+- **Throughput:** 40 TPS default for GetParameter (can be increased)
+- **Latency:** Single-digit ms reads and writes
+
+## Local Development
+
+Mock data persists to disk at `.bb-data/settings/{fullId}/value.json` across dev server restarts. Wipe with `rm -rf .bb-data`. Secrets generate a random value locally (no KMS encryption in mock mode).
+
+
+
+## See Also
+
+- [DESIGN.md](./DESIGN.md) — Infrastructure details, mock parity gaps, and interface decisions

package/dist/errors.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Typed error constants for AppSetting. Use with `isBlocksError()` in catch blocks.
+ *
+ * @example
+ * ```typescript
+ * import { isBlocksError } from '@aws-blocks/core';
+ * import { AppSettingErrors } from '@aws-blocks/bb-app-setting';
+ *
+ * try {
+ *   await setting.put(value);
+ * } catch (e: unknown) {
+ *   if (isBlocksError(e, AppSettingErrors.ValidationFailed)) {
+ *     // schema validation failed or value exceeds 4 KB
+ *   }
+ *   throw e;
+ * }
+ * ```
+ */
+export declare const AppSettingErrors: {
+    /** Thrown when the SSM parameter does not exist. */
+    readonly ParameterNotFound: "ParameterNotFoundException";
+    /** Thrown when schema validation fails, value exceeds 4 KB, or options are invalid. */
+    readonly ValidationFailed: "ValidationFailedException";
+};
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,gBAAgB;IAC5B,oDAAoD;;IAEpD,uFAAuF;;CAE9E,CAAC"}

package/dist/errors.js

@@ -0,0 +1,26 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Typed error constants for AppSetting. Use with `isBlocksError()` in catch blocks.
+ *
+ * @example
+ * ```typescript
+ * import { isBlocksError } from '@aws-blocks/core';
+ * import { AppSettingErrors } from '@aws-blocks/bb-app-setting';
+ *
+ * try {
+ *   await setting.put(value);
+ * } catch (e: unknown) {
+ *   if (isBlocksError(e, AppSettingErrors.ValidationFailed)) {
+ *     // schema validation failed or value exceeds 4 KB
+ *   }
+ *   throw e;
+ * }
+ * ```
+ */
+export const AppSettingErrors = {
+    /** Thrown when the SSM parameter does not exist. */
+    ParameterNotFound: 'ParameterNotFoundException',
+    /** Thrown when schema validation fails, value exceeds 4 KB, or options are invalid. */
+    ValidationFailed: 'ValidationFailedException',
+};

package/dist/index.aws.d.ts

@@ -0,0 +1,76 @@
+import { Scope } from '@aws-blocks/core';
+import type { ScopeParent } from '@aws-blocks/core';
+import type { AppSettingOptions } from './types.js';
+import type { ChildLogger } from '@aws-blocks/bb-logger';
+export { AppSettingErrors } from './errors.js';
+export type { AppSettingOptions } from './types.js';
+/**
+ * A single application configuration value backed by SSM Parameter Store.
+ *
+ * **When to use:** You need to store and retrieve a non-secret configuration
+ * value at runtime — a feature flag, API URL, threshold, or structured config
+ * object. For sensitive values, set `secret: true` to use SSM SecureString.
+ *
+ * **When NOT to use:** If you need structured key-value data with conditional
+ * writes and queries, use `KVStore` or `DistributedTable`.
+ *
+ * **Best practices:**
+ * - One AppSetting per logical configuration value
+ * - Use a schema for structured objects to get type safety and runtime validation
+ * - Use `secret: true` for API keys, tokens, and passwords
+ *
+ * **Scaling:** Standard-tier SSM parameters. 40 TPS default for GetParameter
+ * (can be increased). No cost for standard parameters.
+ */
+export declare class AppSetting<T = string> extends Scope {
+    /**
+     * Reference an SSM parameter created and owned **outside this stack** (e.g. a
+     * connection string seeded by `ensureSecrets` before deploy). At runtime this
+     * reads the value like any other setting; the construct-time behavior (no
+     * create/seed/tag/delete, read-only grant) is applied by the CDK variant. The
+     * factory exists on every variant so app code uses one API across dev/deploy.
+     */
+    static fromExisting<T = string>(scope: ScopeParent, id: string, options: {
+        name: string;
+        secret?: boolean;
+    }): AppSetting<T>;
+    readonly bbName = "AppSetting";
+    private schema?;
+    private isSecret;
+    private client;
+    /** @internal Logger for internal operations. Defaults to error-level when not provided. */
+    protected log: ChildLogger;
+    constructor(scope: ScopeParent, id: string, options: AppSettingOptions<T>);
+    /**
+     * Retrieve the current value.
+     *
+     * Returns the stored SSM parameter value. The parameter is guaranteed
+     * to exist because the CDK layer creates it with the initial value.
+     *
+     * @returns The current value.
+     * @throws {AppSettingErrors.ParameterNotFound} If the parameter does not exist in SSM (e.g., deleted out-of-band).
+     *
+     * @example
+     * ```typescript
+     * const retries = await maxRetries.get();
+     * ```
+     */
+    get(): Promise<T>;
+    /**
+     * Update the value at runtime.
+     *
+     * Overwrites the current SSM parameter value. When a schema is configured,
+     * the value is validated before writing.
+     *
+     * @param value - The new value to store.
+     * @throws {AppSettingErrors.ValidationFailed} If schema validation fails or value exceeds 4 KB.
+     *
+     * @example
+     * ```typescript
+     * await maxRetries.put('5');
+     * await config.put({ maxRetries: 5, timeout: 10000 });
+     * ```
+     */
+    put(value: T): Promise<void>;
+}
+//# sourceMappingURL=index.aws.d.ts.map

package/dist/index.aws.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.aws.d.ts","sourceRoot":"","sources":["../src/index.aws.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,EAA6C,MAAM,kBAAkB,CAAC;AACpF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGpD,OAAO,KAAK,EAAE,iBAAiB,EAA6B,MAAM,YAAY,CAAC;AAG/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAqBpD;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,UAAU,CAAC,CAAC,GAAG,MAAM,CAAE,SAAQ,KAAK;IAChD;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,MAAM,EAC7B,KAAK,EAAE,WAAW,EAClB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GACzC,UAAU,CAAC,CAAC,CAAC;IAKhB,QAAQ,CAAC,MAAM,gBAAW;IAC1B,OAAO,CAAC,MAAM,CAAC,CAAsB;IACrC,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,MAAM,CAAY;IAE1B,2FAA2F;IAC3F,SAAS,CAAC,GAAG,EAAE,WAAW,CAAC;gBAEf,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAazE;;;;;;;;;;;;;OAaG;IACG,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC;IA2BvB;;;;;;;;;;;;;;OAcG;IACG,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAYlC"}

package/dist/index.aws.js

@@ -0,0 +1,135 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { SSMClient, GetParameterCommand, PutParameterCommand, } from '@aws-sdk/client-ssm';
+import { Scope, registerSdkIdentifiers, getSdkIdentifiers } from '@aws-blocks/core';
+import { AppSettingErrors } from './errors.js';
+import { BB_NAME, BB_VERSION } from './version.js';
+import { Logger } from '@aws-blocks/bb-logger';
+// Re-export public types from types module (canonical source)
+export { AppSettingErrors } from './errors.js';
+// ── Helpers ─────────────────────────────────────────────────────────────────
+function blocksError(name, message) {
+    const err = new Error(`${name}: ${message}`);
+    err.name = name;
+    return err;
+}
+async function validateSchema(schema, value) {
+    if (!schema)
+        return;
+    const result = schema['~standard'].validate(value);
+    const resolved = result instanceof Promise ? await result : result;
+    if (resolved.issues) {
+        throw blocksError(AppSettingErrors.ValidationFailed, resolved.issues[0].message);
+    }
+}
+// ── AppSetting (AWS runtime) ────────────────────────────────────────────────
+/**
+ * A single application configuration value backed by SSM Parameter Store.
+ *
+ * **When to use:** You need to store and retrieve a non-secret configuration
+ * value at runtime — a feature flag, API URL, threshold, or structured config
+ * object. For sensitive values, set `secret: true` to use SSM SecureString.
+ *
+ * **When NOT to use:** If you need structured key-value data with conditional
+ * writes and queries, use `KVStore` or `DistributedTable`.
+ *
+ * **Best practices:**
+ * - One AppSetting per logical configuration value
+ * - Use a schema for structured objects to get type safety and runtime validation
+ * - Use `secret: true` for API keys, tokens, and passwords
+ *
+ * **Scaling:** Standard-tier SSM parameters. 40 TPS default for GetParameter
+ * (can be increased). No cost for standard parameters.
+ */
+export class AppSetting extends Scope {
+    /**
+     * Reference an SSM parameter created and owned **outside this stack** (e.g. a
+     * connection string seeded by `ensureSecrets` before deploy). At runtime this
+     * reads the value like any other setting; the construct-time behavior (no
+     * create/seed/tag/delete, read-only grant) is applied by the CDK variant. The
+     * factory exists on every variant so app code uses one API across dev/deploy.
+     */
+    static fromExisting(scope, id, options) {
+        const opts = { ...options, external: true };
+        return new AppSetting(scope, id, opts);
+    }
+    bbName = BB_NAME;
+    schema;
+    isSecret;
+    client;
+    /** @internal Logger for internal operations. Defaults to error-level when not provided. */
+    log;
+    constructor(scope, id, options) {
+        super(id, { parent: scope, bbName: BB_NAME, bbVersion: BB_VERSION });
+        this.log = options?.logger ?? new Logger(this, 'logger', { level: 'error' });
+        const parameterName = options.name ?? `/${this.fullId}`;
+        this.schema = options.schema;
+        this.isSecret = options.secret ?? false;
+        this.client = new SSMClient({
+            customUserAgent: this.buildUserAgentChain(),
+        });
+        registerSdkIdentifiers(this.fullId, { parameterName });
+    }
+    /**
+     * Retrieve the current value.
+     *
+     * Returns the stored SSM parameter value. The parameter is guaranteed
+     * to exist because the CDK layer creates it with the initial value.
+     *
+     * @returns The current value.
+     * @throws {AppSettingErrors.ParameterNotFound} If the parameter does not exist in SSM (e.g., deleted out-of-band).
+     *
+     * @example
+     * ```typescript
+     * const retries = await maxRetries.get();
+     * ```
+     */
+    async get() {
+        const result = await this.client.send(new GetParameterCommand({
+            Name: getSdkIdentifiers(this).parameterName,
+            WithDecryption: this.isSecret,
+        }));
+        this.client.config.customUserAgent = this.buildUserAgentChain();
+        const raw = result.Parameter?.Value;
+        if (raw === undefined || raw === null) {
+            throw blocksError(AppSettingErrors.ParameterNotFound, `Parameter "${getSdkIdentifiers(this).parameterName}" has no value`);
+        }
+        let value;
+        try {
+            value = JSON.parse(raw);
+        }
+        catch {
+            // fallback for old-format values
+            value = raw;
+        }
+        if (this.isSecret && value === '') {
+            throw blocksError(AppSettingErrors.ParameterNotFound, `Secret parameter "${getSdkIdentifiers(this).parameterName}" has an empty value — secrets must not be empty`);
+        }
+        return value;
+    }
+    /**
+     * Update the value at runtime.
+     *
+     * Overwrites the current SSM parameter value. When a schema is configured,
+     * the value is validated before writing.
+     *
+     * @param value - The new value to store.
+     * @throws {AppSettingErrors.ValidationFailed} If schema validation fails or value exceeds 4 KB.
+     *
+     * @example
+     * ```typescript
+     * await maxRetries.put('5');
+     * await config.put({ maxRetries: 5, timeout: 10000 });
+     * ```
+     */
+    async put(value) {
+        await validateSchema(this.schema, value);
+        const serialized = JSON.stringify(value);
+        await this.client.send(new PutParameterCommand({
+            Name: getSdkIdentifiers(this).parameterName,
+            Value: serialized,
+            Type: this.isSecret ? 'SecureString' : 'String',
+            Overwrite: true,
+        }));
+    }
+}

package/dist/index.browser.d.ts

@@ -0,0 +1,5 @@
+export declare class AppSetting {
+    static fromExisting(...args: any[]): any;
+    constructor(...args: any[]);
+}
+//# sourceMappingURL=index.browser.d.ts.map

package/dist/index.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":"AAIA,qBAAa,UAAU;IACtB,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG;gBAG5B,GAAG,IAAI,EAAE,GAAG,EAAE;CAC1B"}

package/dist/index.browser.js

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+// Browser stub - AppSetting runs server-side only
+export class AppSetting {
+    static fromExisting(...args) {
+        return new AppSetting();
+    }
+    constructor(...args) { }
+}

package/dist/index.cdk.d.ts

@@ -0,0 +1,35 @@
+import { Scope } from '@aws-blocks/core/cdk';
+import type { ScopeParent } from '@aws-blocks/core';
+import type { AppSettingOptions } from './types.js';
+export { AppSettingErrors } from './errors.js';
+export type { AppSettingOptions } from './types.js';
+/**
+ * CDK construct for AppSetting. Creates a single SSM parameter (String or
+ * SecureString) and grants the shared Lambda handler read/write permissions.
+ *
+ * - String parameters use `aws-cdk-lib/aws-ssm.StringParameter` directly.
+ * - SecureString parameters use a Custom Resource Lambda because
+ *   CloudFormation cannot natively create SecureString parameters.
+ * - SecureString parameters are encrypted with the default `aws/ssm` KMS key.
+ */
+export declare class AppSetting<T = string> extends Scope {
+    /**
+     * Reference an SSM parameter that is created and owned **outside this stack**
+     * (e.g. a connection string seeded by `ensureSecrets` before deploy). The
+     * construct does not create, seed, tag, or delete it — it only grants the app
+     * **read-only** access (`ssm:GetParameter`, plus `kms:Decrypt` when `secret`)
+     * and registers the name for config resolution.
+     *
+     * The parameter MUST already exist at deploy time, otherwise the app fails at
+     * runtime with `ParameterNotFound`.
+     *
+     * @example
+     * const dbUrl = AppSetting.fromExisting(scope, 'db-url', { name: dbParameterName, secret: true });
+     */
+    static fromExisting<T = string>(scope: ScopeParent, id: string, options: {
+        name: string;
+        secret?: boolean;
+    }): AppSetting<T>;
+    constructor(scope: ScopeParent, id: string, options: AppSettingOptions<T>);
+}
+//# sourceMappingURL=index.cdk.d.ts.map

package/dist/index.cdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cdk.d.ts","sourceRoot":"","sources":["../src/index.cdk.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,EAAwC,MAAM,sBAAsB,CAAC;AACnF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,OAAO,KAAK,EAAE,iBAAiB,EAA6B,MAAM,YAAY,CAAC;AAE/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEpD;;;;;;;;GAQG;AACH,qBAAa,UAAU,CAAC,CAAC,GAAG,MAAM,CAAE,SAAQ,KAAK;IAChD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,MAAM,EAC7B,KAAK,EAAE,WAAW,EAClB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GACzC,UAAU,CAAC,CAAC,CAAC;gBAKJ,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC;CA0HzE"}