aws-cdk-lib.aws_ssm.CommonStringParameterAttributes

interface CommonStringParameterAttributes

LanguageType name
.NETAmazon.CDK.AWS.SSM.CommonStringParameterAttributes
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssm#CommonStringParameterAttributes
Javasoftware.amazon.awscdk.services.ssm.CommonStringParameterAttributes
Pythonaws_cdk.aws_ssm.CommonStringParameterAttributes
TypeScript (source)aws-cdk-lib » aws_ssm » CommonStringParameterAttributes

Common attributes for string parameters.

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

NameTypeDescription
parameterNamestringThe name of the parameter store value.
simpleName?booleanIndicates of the parameter name is a simple name (i.e. does not include "/" separators).

parameterName

Type: string

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).


simpleName?

Type: boolean (optional, default: auto-detect based on parameterName)

Indicates of the parameter name is a simple name (i.e. does not include "/" separators).

This is only 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.