ParameterOptions

class aws_cdk.aws_ssm.ParameterOptions(*, allowed_pattern=None, description=None, parameter_name=None, simple_name=None, tier=None)

Bases: object

Properties needed to create a new 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 whether the parameter name is a simple name. A parameter name without any “/” is considered a simple name. If the parameter name includes “/”, setting simpleName to true might cause unintended issues such as duplicate “/” in the resulting ARN. 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. Default: - auto-detect based on parameterName

  • tier (Optional[ParameterTier]) – The tier of the string parameter. Default: - undefined

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ssm as ssm

parameter_options = ssm.ParameterOptions(
    allowed_pattern="allowedPattern",
    description="description",
    parameter_name="parameterName",
    simple_name=False,
    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

description

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

Default:

none

parameter_name

The name of the parameter.

Default:

  • a name will be generated by CloudFormation

simple_name

Indicates whether the parameter name is a simple name.

A parameter name without any “/” is considered a simple name. If the parameter name includes “/”, setting simpleName to true might cause unintended issues such as duplicate “/” in the resulting ARN.

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.

Default:

  • auto-detect based on parameterName

tier

The tier of the string parameter.

Default:

  • undefined