aws-cdk-lib.aws_ssm.CommonStringParameterAttributes

CommonStringParameterAttributes Struct

Common attributes for string parameters.

Source

aws-ssm/lib/parameter.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const commonStringParameterAttributes: ssm.CommonStringParameterAttributes = {
  parameterName: 'parameterName',

  // the properties below are optional
  simpleName: false,
};

Properties

parameterNamestringparameter_namestrparameterNameStringParameterNamestringParameterName*stringrequired#

The name of the parameter store value.

This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).

simpleNamebooleansimple_nameboolsimpleNameBooleanSimpleNameboolSimpleName*bool= auto-detect based on `parameterN…#

Indicates whether the parameter name is a simple name.

notes · default

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 of rendering SSM parameter ARNs.

If parameterName is not specified, simpleName must be true (or undefined) since the name generated by AWS CloudFormation is always a simple name.

Default: auto-detect based on parameterName