StringParameterAttributes

class aws_cdk.aws_ssm.StringParameterAttributes(*, parameter_name, simple_name=None, type=None, version=None)

Bases: aws_cdk.aws_ssm.CommonStringParameterAttributes

__init__(*, parameter_name, simple_name=None, type=None, version=None)

Attributes for parameters of various types of string.

Parameters

  • parameter_name (str) – The name of the parameter store value. This value can be a token or a concrete string. If it is a concrete string and includes “/” it must also be prefixed with a “/” (fully-qualified).

  • 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

  • type (Optional[ParameterType]) – The type of the string parameter. Default: ParameterType.STRING

  • version (Union[int, float, None]) – The version number of the value you wish to retrieve. Default: The latest version will be retrieved.

see :see: ParameterType

Attributes

parameter_name

The name of the parameter store value.

This value can be a token or a concrete string. If it is a concrete string and includes “/” it must also be prefixed with a “/” (fully-qualified).

Return type

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 :default: - auto-detect based on parameterName

Return type

Optional[bool]

type

The type of the string parameter.

default :default: ParameterType.STRING

Return type

Optional[ParameterType]

version

The version number of the value you wish to retrieve.

default :default: The latest version will be retrieved.

Return type

Union[int, float, None]