Skip to content

Parameter

Source code in docs_src/capo_ssm/types/parameter.py
class Parameter(TypedDict, closed=True):
    name: NotRequired["capo_ssm.types.ps_parameter_name.PSParameterName"]
    """<p>The name of the parameter.</p>"""
    type: NotRequired["capo_ssm.types.parameter_type.ParameterType"]
    """<p>The type of parameter. Valid values include the following: <code>String</code>, <code>StringList</code>, and <code>SecureString</code>.</p> <note> <p>If type is <code>StringList</code>, the system returns a comma-separated string with no spaces between commas in the <code>Value</code> field.</p> </note>"""
    value: NotRequired["capo_ssm.types.ps_parameter_value.PSParameterValue"]
    """<p>The parameter value.</p> <note> <p>If type is <code>StringList</code>, the system returns a comma-separated string with no spaces between commas in the <code>Value</code> field.</p> </note>"""
    version: "capo_ssm.types.ps_parameter_version.PSParameterVersion"
    """<p>The parameter version.</p>"""
    selector: NotRequired["capo_ssm.types.ps_parameter_selector.PSParameterSelector"]
    """<p>Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:</p> <p>parameter_name:version</p> <p>parameter_name:label</p>"""
    source_result: NotRequired["capo_ssm.types.string.String"]
    """<p>Applies to parameters that reference information in other Amazon Web Services services. <code>SourceResult</code> is the raw result or response from the source.</p>"""
    last_modified_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>Date the parameter was last changed or updated and the parameter version was created.</p>"""
    arn: NotRequired["capo_ssm.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the 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>"""

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.

last_modified_date instance-attribute

last_modified_date: NotRequired[DateTime]

Date the parameter was last changed or updated and the parameter version was created.

name instance-attribute

name: NotRequired[PSParameterName]

The name of the parameter.

selector instance-attribute

selector: NotRequired[PSParameterSelector]

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

source_result instance-attribute

source_result: NotRequired[String]

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

type instance-attribute

type: NotRequired[ParameterType]

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

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

value instance-attribute

value: NotRequired[PSParameterValue]

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

version instance-attribute

The parameter version.