aws-cdk-lib.aws_ssm.ParameterOptions

interface ParameterOptions

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

Properties needed to create a new SSM Parameter.

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 parameterOptions: ssm.ParameterOptions = {
  allowedPattern: 'allowedPattern',
  description: 'description',
  parameterName: 'parameterName',
  simpleName: false,
  tier: ssm.ParameterTier.ADVANCED,
};

Properties

NameTypeDescription
allowedPattern?stringA regular expression used to validate the parameter value.
description?stringInformation about the parameter that you want to add to the system.
parameterName?stringThe name of the parameter.
simpleName?booleanIndicates of the parameter name is a simple name (i.e. does not include "/" separators).
tier?ParameterTierThe tier of the string parameter.

allowedPattern?

Type: string (optional, default: no validation is performed)

A regular expression used to validate the parameter value.

For example, for String types with values restricted to numbers, you can specify the following: ^\d+$


description?

Type: string (optional, default: none)

Information about the parameter that you want to add to the system.


parameterName?

Type: string (optional, default: a name will be generated by CloudFormation)

The name of the parameter.


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.


tier?

Type: ParameterTier (optional, default: undefined)

The tier of the string parameter.