Skip to content

Commit

Permalink
chore(ssm): update simple name description and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GavinZZ committed Jun 24, 2024
1 parent 1397737 commit 7f7df3b
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
28 changes: 28 additions & 0 deletions packages/aws-cdk-lib/aws-ssm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,31 @@ When specifying an `allowedPattern`, the values provided as string literals
are validated against the pattern and an exception is raised if a value
provided does not comply.

## Using Tokens in parameter name

When using [CDK Tokens](https://docs.aws.amazon.com/cdk/v2/guide/tokens.html) in parameter name,
you need to explicitly set `simpleName` property. Setting `simpleName` to incorrect boolean
value may result in unexpected behaviours, such as getting duplicate '/' in the parameter ARN
or missing '/' in the parameter ARN.

`simpleName` is used to indicates whether the parameter name is a simple name. A parameter name
without any '/' is considered a simple name, thus you should set `simpleName` to `true`.
If the parameter name includes '/', set `simpleName` to `false`.

```ts
declare const func: lambda.IFunction;

const simpleParameter = new ssm.StringParameter(this, 'StringParameter', {
// the parameter name is simple
parameterName: 'parameter',
stringValue: 'SOME_VALUE',
simpleName: true, // set `simpleName` to true
});

const nonSimpleParameter = new ssm.StringParameter(this, 'StringParameter', {
// the parameter name is not simple
parameterName: `/${func.functionName}/my/app/param`,
stringValue: 'SOME_VALUE',
simpleName: false, // set `simpleName` to false
});
```
12 changes: 8 additions & 4 deletions packages/aws-cdk-lib/aws-ssm/lib/parameter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,10 @@ export interface ParameterOptions {
readonly parameterName?: string;

/**
* Indicates if the parameter name is a simple name (i.e. does not include "/"
* separators).
* Indicates whether the parameter name is a simple name. A parameter name
* without any "/" is considered a simple name. If the parameter name includes
* "/", setting simpleName to true might cause unintended issues, such
* as duplicate "/" in the resulting ARN.
*
* This is required only if `parameterName` is a token, which means we
* are unable to detect if the name is simple or "path-like" for the purpose
Expand Down Expand Up @@ -337,8 +339,10 @@ export interface CommonStringParameterAttributes {
readonly parameterName: string;

/**
* Indicates if the parameter name is a simple name (i.e. does not include "/"
* separators).
* Indicates whether the parameter name is a simple name. A parameter name
* without any "/" is considered a simple name. If the parameter name includes
* "/", setting simpleName to true might cause unintended issues, such
* as duplicate "/" in the resulting ARN.
*
* This is required only if `parameterName` is a token, which means we
* are unable to detect if the name is simple or "path-like" for the purpose
Expand Down

0 comments on commit 7f7df3b

Please sign in to comment.