StringParameterProps¶

class aws_cdk.aws_ssm.StringParameterProps(*, allowed_pattern=None, description=None, parameter_name=None, simple_name=None, tier=None, string_value, data_type=None, type=None)¶

Bases: aws_cdk.aws_ssm.ParameterOptions

Properties needed to create a String SSM parameter.

Parameters

allowed_pattern (Optional[str]) – 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+$ Default: no validation is performed
description (Optional[str]) – Information about the parameter that you want to add to the system. Default: none
parameter_name (Optional[str]) – The name of the parameter. Default: - a name will be generated by CloudFormation
simple_name (Optional[bool]) – 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. Default: - auto-detect based on parameterName
tier (Optional[ParameterTier]) – The tier of the string parameter. Default: - undefined
string_value (str) – The value of the parameter. It may not reference another parameter and {{}} cannot be used in the value.
data_type (Optional[ParameterDataType]) – The data type of the parameter, such as text or aws:ec2:image. Default: ParameterDataType.TEXT
type (Optional[ParameterType]) – The type of the string parameter. Default: ParameterType.STRING

ExampleMetadata

infused

Example:

ssm.StringParameter(self, "Parameter",
    allowed_pattern=".*",
    description="The value Foo",
    parameter_name="FooParameter",
    string_value="Foo",
    tier=ssm.ParameterTier.ADVANCED
)

Attributes

allowed_pattern¶

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

Default: no validation is performed
Return type: Optional[str]

data_type¶

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

Default: ParameterDataType.TEXT
Return type: Optional[ParameterDataType]

description¶

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

Default: none
Return type: Optional[str]

parameter_name¶

The name of the parameter.

Default

a name will be generated by CloudFormation

Return type

Optional[str]

simple_name¶

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.

Default

auto-detect based on parameterName

Return type

Optional[bool]

string_value¶

The value of the parameter.

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

Return type: str

tier¶

The tier of the string parameter.

Default

undefined

Return type

Optional[ParameterTier]

type¶

The type of the string parameter.

Default: ParameterType.STRING
Return type: Optional[ParameterType]