Metadata-Version: 2.1
Name: alma-cdk.cross-region-parameter
Version: 2.0.0
Summary: Store AWS SSM Parameter Store Parameters into another AWS Region with AWS CDK
Home-page: https://github.com/alma-cdk/cross-region-parameter.git
Author: Alma Media<opensource@almamedia.dev>
License: Apache-2.0
Project-URL: Source, https://github.com/alma-cdk/cross-region-parameter.git
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aws-cdk-lib <3.0.0,>=2.260.0
Requires-Dist: constructs <11.0.0,>=10.7.2
Requires-Dist: jsii <2.0.0,>=1.139.0
Requires-Dist: publication >=0.0.3

<div align="center">
	<br/>
	<br/>
  <h1>
	<img height="140" src="assets/alma-cdk-cross-region-parameter.svg" alt="Alma CDK Cross-Region Parameter" />
  <br/>
  <br/>
  </h1>

```sh
npm i -D @alma-cdk/cross-region-parameter
```

  <div align="left">

Store [AWS SSM Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) Parameters into another AWS Region with AWS CDK.

  </div>
  <br/>
</div><br/><div align="center">

![diagram](assets/diagram.svg)

</div><br/>

## Prefer native CDK/CloudFormation features

> [!IMPORTANT]
> Since CloudFormation's [`Fn::GetStackOutput`](https://aws.amazon.com/about-aws/whats-new/2026/05/aws-cloudformation-cdk-stack/) (May 2026) and `aws-cdk-lib@2.254.0`, CDK passes values across regions natively — no custom resources, no SSM round-trip. **For most use cases you no longer need this package.**
>
> 📖 [AWS What's New](https://aws.amazon.com/about-aws/whats-new/2026/05/aws-cloudformation-cdk-stack/) · [AWS DevOps Blog](https://aws.amazon.com/blogs/devops/simplify-cross-account-and-cross-region-stack-output-references-with-aws-cloudformation-and-cdks-new-fngetstackoutput/) · [Deep dive by @pahud](https://dev.to/pahud/fngetstackoutput-how-cloudformation-and-cdk-solved-cross-region-references-together-9f8)

`Fn::GetStackOutput` resolves values inside CloudFormation at deploy time. Reach for
`CrossRegionParameter` only when you genuinely need **an SSM Parameter to exist in the target
region** — because it is read at runtime by an application, by another account or tool, or by
infrastructure that isn't part of this CDK app.

<br/>

## Getting Started

```python
import { CrossRegionParameter } from "@alma-cdk/cross-region-parameter";

new CrossRegionParameter(this, 'SayHiToSweden', {
  region: 'eu-north-1',
  name: '/parameter/path/message',
  description: 'Some message for the Swedes',
  value: 'Hej då!',
});
```