CommonStringParameterAttributes¶

class aws_cdk.aws_ssm.CommonStringParameterAttributes(*, parameter_name, simple_name=None)¶

Bases: object

Common attributes for string parameters.

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

ExampleMetadata

fixture=_generated

Example:

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

common_string_parameter_attributes = ssm.CommonStringParameterAttributes(
    parameter_name="parameterName",

    # the properties below are optional
    simple_name=False
)

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

auto-detect based on parameterName

Return type

Optional[bool]