# API Reference
## Constructs
### CrossRegionParameter
Cross-Region SSM Parameter.
#### Initializers
```typescript
import { CrossRegionParameter } from '@alma-cdk/cross-region-parameter'
new CrossRegionParameter(scope: Construct, name: string, props: CrossRegionParameterProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| name | string | *No description.* |
| props | CrossRegionParameterProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `name`Required
- *Type:* string
---
##### `props`Required
- *Type:* CrossRegionParameterProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { CrossRegionParameter } from '@alma-cdk/cross-region-parameter'
CrossRegionParameter.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
## Structs
### CrossRegionParameterProps
#### Initializer
```typescript
import { CrossRegionParameterProps } from '@alma-cdk/cross-region-parameter'
const crossRegionParameterProps: CrossRegionParameterProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| description | string | Information about the SSM Parameter that you want to add. |
| name | string | SSM Parameter name. |
| region | string | Target region for the parameter. |
| value | string | The SSM Parameter value that you want to add. |
| allowedPattern | string | A regular expression used to validate the SSM Parameter Value. |
| keyId | string | The AWS Key Management Service (AWS KMS) ID that you want to use to encrypt a parameter. |
| parameterTier | aws-cdk-lib.aws_ssm.ParameterTier | The SSM Parameter Tier to assign to a parameter. |
| parameterType | aws-cdk-lib.aws_ssm.ParameterType | The type of SSM Parameter that you want to add. |
| policies | string | One or more policies to apply to a SSM Parameter. |
| tags | TagProp[] | Tags to add into the SSM Paramater that you want to add. |
---
##### `description`Required
```typescript
public readonly description: string;
```
- *Type:* string
Information about the SSM Parameter that you want to add.
Required by this construct (AWS considers it as optional).
---
*Example*
```typescript
'Some message for the Swedes'
```
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
SSM Parameter name.
---
*Example*
```typescript
'/parameter/path/message'
```
##### `region`Required
```typescript
public readonly region: string;
```
- *Type:* string
Target region for the parameter.
Must be some other region than the current Stack's region.
---
*Example*
```typescript
'eu-north-1'
```
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* string
The SSM Parameter value that you want to add.
Limits:
- Standard parameters have a value limit of 4 KB.
- Advanced parameters have a value limit of 8 KB.
---
*Example*
```typescript
'Hej då!'
```
##### `allowedPattern`Optional
```typescript
public readonly allowedPattern: string;
```
- *Type:* string
A regular expression used to validate the SSM Parameter Value.
For example, for String types with values restricted to numbers,
you can specify the following: `^\d+$`.
> [https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html#systemsmanager-PutParameter-request-AllowedPattern](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html#systemsmanager-PutParameter-request-AllowedPattern)
---
*Example*
```typescript
'^\d+$'
```
##### `keyId`Optional
```typescript
public readonly keyId: string;
```
- *Type:* string
The AWS Key Management Service (AWS KMS) ID that you want to use to encrypt a parameter.
Either the default AWS KMS key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.
The KMS Key must exists in the target region.
If you don't specify a key ID, the system uses the default key associated with your AWS account.
> [https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html#systemsmanager-PutParameter-request-KeyId](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html#systemsmanager-PutParameter-request-KeyId)
---
*Example*
```typescript
'1234abcd-12ab-34cd-56ef-1234567890ab'
```
##### `parameterTier`Optional
```typescript
public readonly parameterTier: ParameterTier;
```
- *Type:* aws-cdk-lib.aws_ssm.ParameterTier
- *Default:* ParameterTier.STANDARD
The SSM Parameter Tier to assign to a parameter.
Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.
- Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the AWS Systems Manager User Guide.
- You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
- If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.
---
*Example*
```typescript
ParameterTier.INTELLIGENT_TIERING
```
##### `parameterType`Optional
```typescript
public readonly parameterType: ParameterType;
```
- *Type:* aws-cdk-lib.aws_ssm.ParameterType
- *Default:* ParameterType.STRING
The type of SSM Parameter that you want to add.
---
*Example*
```typescript
ParameterType.STRING_LIST
```
##### `policies`Optional
```typescript
public readonly policies: string;
```
- *Type:* string
One or more policies to apply to a SSM Parameter.
> [https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html)
---
##### `tags`Optional
```typescript
public readonly tags: TagProp[];
```
- *Type:* TagProp[]
Tags to add into the SSM Paramater that you want to add.
---
*Example*
```typescript
[
{
Key: 'STRING_VALUE',
Value: 'STRING_VALUE'
},
]
```
### TagProp
Tag properties.
#### Initializer
```typescript
import { TagProp } from '@alma-cdk/cross-region-parameter'
const tagProp: TagProp = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| key | string | *No description.* |
| value | string | *No description.* |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* string
---
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* string
---