ListParameterAttributes

class aws_cdk.aws_ssm.ListParameterAttributes(*, parameter_name, simple_name=None, element_type=None, version=None)

Bases: CommonStringParameterAttributes

Attributes for parameters of string list type.

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 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
element_type (Optional[ParameterValueType]) – The type of the string list parameter value. Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account. Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING Default: ParameterValueType.STRING
version (Union[int, float, None]) – The version number of the value you wish to retrieve. Default: The latest version will be retrieved.

See:

ParameterType

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

list_parameter_attributes = ssm.ListParameterAttributes(
    parameter_name="parameterName",

    # the properties below are optional
    element_type=ssm.ParameterValueType.STRING,
    simple_name=False,
    version=123
)

Attributes

element_type

The type of the string list parameter value.

Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account.

Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING

Default:: ParameterValueType.STRING
See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types

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).

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

version

The version number of the value you wish to retrieve.

Default:: The latest version will be retrieved.