Skip to content

ParameterMetadata

Source code in docs_src/capo_ssm/types/parameter_metadata.py
class ParameterMetadata(TypedDict, closed=True):
    name: NotRequired["capo_ssm.types.ps_parameter_name.PSParameterName"]
    """<p>The parameter name.</p>"""
    arn: NotRequired["capo_ssm.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the parameter.</p>"""
    type: NotRequired["capo_ssm.types.parameter_type.ParameterType"]
    """<p>The type of parameter. Valid parameter types include the following: <code>String</code>, <code>StringList</code>, and <code>SecureString</code>.</p>"""
    key_id: NotRequired["capo_ssm.types.parameter_key_id.ParameterKeyId"]
    """<p>The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to <code>SecureString</code> parameters only.</p>"""
    last_modified_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>Date the parameter was last changed or updated.</p>"""
    last_modified_user: NotRequired["capo_ssm.types.string.String"]
    """<p>Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.</p>"""
    description: NotRequired[
        "capo_ssm.types.parameter_description.ParameterDescription"
    ]
    """<p>Description of the parameter actions.</p>"""
    allowed_pattern: NotRequired["capo_ssm.types.allowed_pattern.AllowedPattern"]
    """<p>A parameter name can include only the following letters and symbols.</p> <p>a-zA-Z0-9_.-</p>"""
    version: "capo_ssm.types.ps_parameter_version.PSParameterVersion"
    """<p>The parameter version.</p>"""
    tier: NotRequired["capo_ssm.types.parameter_tier.ParameterTier"]
    """<p>The parameter tier.</p>"""
    policies: NotRequired["capo_ssm.types.parameter_policy_list.ParameterPolicyList"]
    """<p>A list of policies associated with a parameter.</p>"""
    data_type: NotRequired["capo_ssm.types.parameter_data_type.ParameterDataType"]
    """<p>The data type of the parameter, such as <code>text</code> or <code>aws:ec2:image</code>. The default is <code>text</code>.</p>"""

allowed_pattern instance-attribute

allowed_pattern: NotRequired[AllowedPattern]

A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

arn instance-attribute

arn: NotRequired[String]

The Amazon Resource Name (ARN) of the parameter.

data_type instance-attribute

data_type: NotRequired[ParameterDataType]

The data type of the parameter, such as text or aws:ec2:image. The default is text.

description instance-attribute

description: NotRequired[ParameterDescription]

Description of the parameter actions.

key_id instance-attribute

key_id: NotRequired[ParameterKeyId]

The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to SecureString parameters only.

last_modified_date instance-attribute

last_modified_date: NotRequired[DateTime]

Date the parameter was last changed or updated.

last_modified_user instance-attribute

last_modified_user: NotRequired[String]

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

name instance-attribute

name: NotRequired[PSParameterName]

The parameter name.

policies instance-attribute

policies: NotRequired[ParameterPolicyList]

A list of policies associated with a parameter.

tier instance-attribute

tier: NotRequired[ParameterTier]

The parameter tier.

type instance-attribute

type: NotRequired[ParameterType]

The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

version instance-attribute

The parameter version.