AWS::SSM::Parameter¶

The AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store.

Generated by cfn-typegen --out cfn_types AWS::SSM::Parameter into cfn_types/ssm.py:

# Generated by cfn-typegen from the CloudFormation registry schemas. Do not edit.
# fmt: off
# ruff: noqa
"""AWS::SSM resources."""

from collections.abc import Mapping
from typing import Any, Literal, NotRequired, Unpack
from typing_extensions import TypedDict
from cfn_typed.base import DeletionPolicy, DependsOn, ResourceAttrs, UpdateReplacePolicy, build
from cfn_typed.intrinsics import Expr


CONSTRAINTS:dict[str,Any]={
'AWS::SSM::Parameter':{'Type':{'e':["String","StringList"]},'Tier':{'e':["Standard","Advanced","Intelligent-Tiering"]},'DataType':{'e':["text","aws:ec2:image"]},'Arn':{'p':"arn:aws(-[a-z0-9-]+)*:ssm:[a-z0-9-]+:[0-9]{12}:parameter/.+"}},
}


ATTRIBUTES:dict[str,Any]={"AWS::SSM::Parameter":["Arn","Name"]}


RULES:dict[str,Any]={}

Nested types (3)

These are defined above the properties in the generated module.

class ParameterProps(TypedDict, closed=True):
    'The ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.'
    Type: Expr[str]
    'The type of parameter.'
    Value: Expr[str]
    'The parameter value.'
    Description: NotRequired[Expr[str]]
    'Information about the parameter.'
    Policies: NotRequired[Expr[str]]
    'Information about the policies assigned to a parameter.'
    AllowedPattern: NotRequired[Expr[str]]
    'A regular expression used to validate the parameter value.'
    Tier: NotRequired[Expr[str]]
    'The parameter tier.'
    Tags: NotRequired[Expr[Mapping[str, Expr[str]]]]
    'Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).'
    DataType: NotRequired[Expr[str]]
    'The data type of the parameter, such as ``text`` or ``aws:ec2:image``.'
    Name: NotRequired[Expr[str]]
    'The name of the parameter.'


class Parameter(ResourceAttrs):
    'The ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.'
    Type: Literal['AWS::SSM::Parameter']
    Properties: ParameterProps


def parameter(
    *,
    depends_on: DependsOn | None = None,
    deletion_policy: DeletionPolicy | None = None,
    update_replace_policy: UpdateReplacePolicy | None = None,
    condition: str | None = None,
    metadata: dict[str, Any] | None = None,
    **props: Unpack[ParameterProps],
) -> Parameter:
    return build('AWS::SSM::Parameter', props, depends_on, deletion_policy, update_replace_policy, condition, metadata)

Attributes¶

Read-only values for get_att(logical_id, attribute). They are not accepted as inputs.

Arn