interface StringParameterProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.SSM.StringParameterProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsssm#StringParameterProps |
Java | software.amazon.awscdk.services.ssm.StringParameterProps |
Python | aws_cdk.aws_ssm.StringParameterProps |
TypeScript (source) | aws-cdk-lib » aws_ssm » StringParameterProps |
Properties needed to create a String SSM parameter.
Example
// Create a new SSM Parameter holding a String
const param = new ssm.StringParameter(this, 'StringParameter', {
// description: 'Some user-friendly description',
// name: 'ParameterName',
stringValue: 'Initial parameter value',
// allowedPattern: '.*',
});
// Grant read access to some Role
declare const role: iam.IRole;
param.grantRead(role);
// Create a new SSM Parameter holding a StringList
const listParameter = new ssm.StringListParameter(this, 'StringListParameter', {
// description: 'Some user-friendly description',
// name: 'ParameterName',
stringListValue: ['Initial parameter value A', 'Initial parameter value B'],
// allowedPattern: '.*',
});
Properties
Name | Type | Description |
---|---|---|
string | string | The value of the parameter. |
allowed | string | A regular expression used to validate the parameter value. |
data | Parameter | 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. |
parameter | string | The name of the parameter. |
simple | boolean | Indicates if the parameter name is a simple name (i.e. does not include "/" separators). |
tier? | Parameter | The tier of the string parameter. |
type? | Parameter | 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:
Parameter
(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 if the parameter name is a simple name (i.e. does not include "/" separators).
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.
tier?
Type:
Parameter
(optional, default: undefined)
The tier of the string parameter.
type?
⚠️ Deprecated: - type will always be 'String'
Type:
Parameter
(optional, default: ParameterType.STRING)
The type of the string parameter.