class StringParameter (construct)

Language	Type name
.NET	Amazon.CDK.AWS.SSM.StringParameter
Java	software.amazon.awscdk.services.ssm.StringParameter
Python	aws_cdk.aws_ssm.StringParameter
TypeScript (source)	@aws-cdk/aws-ssm » StringParameter

Implements IConstruct, IConstruct, IDependable, IResource, IStringParameter, IParameter

Creates a new String SSM Parameter.

Example

const vpc = ec2.Vpc.fromVpcAttributes(this, 'VPC', {
  vpcId: 'vpc-1234',
  availabilityZones: ['us-east-1a', 'us-east-1b'],

  // Either pass literals for all IDs
  publicSubnetIds: ['s-12345', 's-67890'],

  // OR: import a list of known length
  privateSubnetIds: Fn.importListValue('PrivateSubnetIds', 2),

  // OR: split an imported string to a list of known length
  isolatedSubnetIds: Fn.split(',', ssm.StringParameter.valueForStringParameter(this, `MyParameter`), 2),
});

Initializer

new StringParameter(scope: Construct, id: string, props: StringParameterProps)

Parameters

• scope Construct
• id string
• props StringParameterProps

Construct Props

Name	Type	Description
stringValue	string	The value of the parameter.
allowedPattern?	string	A regular expression used to validate the parameter value.
dataType?	ParameterDataType	The data type of the parameter, such as text or aws:ec2:image.
description?	string	Information about the parameter that you want to add to the system.
parameterName?	string	The name of the parameter.
simpleName?	boolean	Indicates of the parameter name is a simple name (i.e. does not include "/" separators).
tier?	ParameterTier	The tier of the string parameter.
type?	ParameterType	The type of the string parameter.

---

stringValue

Type: string

The value of the parameter.

It may not reference another parameter and {{}} cannot be used in the value.

---

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+$

---

dataType?

Type: ParameterDataType (optional, default: ParameterDataType.TEXT)

The data type of the parameter, such as text or aws:ec2:image.

---

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.

---

type?

Type: ParameterType (optional, default: ParameterType.STRING)

The type of the string parameter.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
parameterArn	string	The ARN of the SSM Parameter resource.
parameterName	string	The name of the SSM Parameter resource.
parameterType	string	The type of the SSM Parameter resource.
stack	Stack	The stack in which this resource is defined.
stringValue	string	The parameter value.
encryptionKey?	IKey	The encryption key that is used to encrypt this parameter.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

parameterArn

Type: string

The ARN of the SSM Parameter resource.

---

parameterName

Type: string

The name of the SSM Parameter resource.

---

parameterType

Type: string

The type of the SSM Parameter resource.

---

stack

Type: Stack

The stack in which this resource is defined.

---

stringValue

Type: string

The parameter value.

Value must not nest another parameter. Do not use {{}} in the value.

---

encryptionKey?

Type: IKey (optional)

The encryption key that is used to encrypt this parameter.

• @default - default master key

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantRead(grantee)	Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
grantWrite(grantee)	Grants write (PutParameter) permissions on the SSM Parameter.
toString()	Returns a string representation of this construct.
static fromSecureStringParameterAttributes(scope, id, attrs)	Imports a secure string parameter from the SSM parameter store.
static fromStringParameterAttributes(scope, id, attrs)	Imports an external string parameter with name and optional version.
static fromStringParameterName(scope, id, stringParameterName)	Imports an external string parameter by name.
static valueForSecureStringParameter(scope, parameterName, version)⚠️	Returns a token that will resolve (during deployment).
static valueForStringParameter(scope, parameterName, version?)	Returns a token that will resolve (during deployment) to the string value of an SSM string parameter.
static valueForTypedStringParameter(scope, parameterName, type?, version?)	Returns a token that will resolve (during deployment) to the string value of an SSM string parameter.
static valueFromLookup(scope, parameterName)	Reads the value of an SSM parameter during synthesis through an environmental context provider.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantRead(grantee)

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

---

grantWrite(grantee)

public grantWrite(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants write (PutParameter) permissions on the SSM Parameter.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromSecureStringParameterAttributes(scope, id, attrs)

public static fromSecureStringParameterAttributes(scope: Construct, id: string, attrs: SecureStringParameterAttributes): IStringParameter

Parameters

• scope Construct
• id string
• attrs SecureStringParameterAttributes

Returns

• IStringParameter

Imports a secure string parameter from the SSM parameter store.

---

static fromStringParameterAttributes(scope, id, attrs)

public static fromStringParameterAttributes(scope: Construct, id: string, attrs: StringParameterAttributes): IStringParameter

Parameters

• scope Construct
• id string
• attrs StringParameterAttributes

Returns

• IStringParameter

Imports an external string parameter with name and optional version.

---

static fromStringParameterName(scope, id, stringParameterName)

public static fromStringParameterName(scope: Construct, id: string, stringParameterName: string): IStringParameter

Parameters

• scope Construct
• id string
• stringParameterName string

Returns

• IStringParameter

Imports an external string parameter by name.

---

static valueForSecureStringParameter(scope, parameterName, version)⚠️

public static valueForSecureStringParameter(scope: Construct, parameterName: string, version: number): string

⚠️ Deprecated: Use SecretValue.ssmSecure() instead, it will correctly type the imported value as a SecretValue and allow importing without version.

Parameters

• scope Construct — Some scope within a stack.
• parameterName string — The name of the SSM parameter.
• version number — The parameter version (required for secure strings).

Returns

• string

Returns a token that will resolve (during deployment).

---

static valueForStringParameter(scope, parameterName, version?)

public static valueForStringParameter(scope: Construct, parameterName: string, version?: number): string

Parameters

• scope Construct — Some scope within a stack.
• parameterName string — The name of the SSM parameter.
• version number — The parameter version (recommended in order to ensure that the value won't change during deployment).

Returns

• string

Returns a token that will resolve (during deployment) to the string value of an SSM string parameter.

---

static valueForTypedStringParameter(scope, parameterName, type?, version?)

public static valueForTypedStringParameter(scope: Construct, parameterName: string, type?: ParameterType, version?: number): string

Parameters

• scope Construct — Some scope within a stack.
• parameterName string — The name of the SSM parameter.
• type ParameterType — The type of the SSM parameter.
• version number — The parameter version (recommended in order to ensure that the value won't change during deployment).

Returns

• string

Returns a token that will resolve (during deployment) to the string value of an SSM string parameter.

---

static valueFromLookup(scope, parameterName)

public static valueFromLookup(scope: Construct, parameterName: string): string

Parameters

• scope Construct
• parameterName string

Returns

• string

Reads the value of an SSM parameter during synthesis through an environmental context provider.

Requires that the stack this scope is defined in will have explicit account/region information. Otherwise, it will fail during synthesis.