Skip to content

Parameter

Source code in docs_src/capo_cloudformation/types/parameter.py
class Parameter(TypedDict, closed=True):
    parameter_key: NotRequired["capo_cloudformation.types.parameter_key.ParameterKey"]
    """<p>The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.</p>"""
    parameter_value: NotRequired[
        "capo_cloudformation.types.parameter_value.ParameterValue"
    ]
    """<p>The input value associated with the parameter.</p>"""
    use_previous_value: NotRequired[
        "capo_cloudformation.types.use_previous_value.UsePreviousValue"
    ]
    """<p>During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify <code>true</code>, do not specify a parameter value.</p>"""
    resolved_value: NotRequired[
        "capo_cloudformation.types.parameter_value.ParameterValue"
    ]
    """<p>Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-supplied-parameter-types.html">Specify existing resources at runtime with CloudFormation-supplied parameter types</a> in the <i>CloudFormation User Guide</i>.</p>"""

parameter_key instance-attribute

parameter_key: NotRequired[ParameterKey]

The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

parameter_value instance-attribute

parameter_value: NotRequired[ParameterValue]

The input value associated with the parameter.

resolved_value instance-attribute

resolved_value: NotRequired[ParameterValue]

Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see Specify existing resources at runtime with CloudFormation-supplied parameter types in the CloudFormation User Guide.

use_previous_value instance-attribute

use_previous_value: NotRequired[UsePreviousValue]

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.