Skip to content

ResourceTargetDefinition

Source code in docs_src/capo_cloudformation/types/resource_target_definition.py
class ResourceTargetDefinition(TypedDict, closed=True):
    attribute: NotRequired[
        "capo_cloudformation.types.resource_attribute.ResourceAttribute"
    ]
    """<p>Indicates which resource attribute is triggering this update, such as a change in the resource attribute's <code>Metadata</code>, <code>Properties</code>, or <code>Tags</code>.</p>"""
    name: NotRequired["capo_cloudformation.types.property_name.PropertyName"]
    """<p>If the <code>Attribute</code> value is <code>Properties</code>, the name of the property. For all other attributes, the value is null.</p>"""
    requires_recreation: NotRequired[
        "capo_cloudformation.types.requires_recreation.RequiresRecreation"
    ]
    """<p>If the <code>Attribute</code> value is <code>Properties</code>, indicates whether a change to this property causes the resource to be recreated. The value can be <code>Never</code>, <code>Always</code>, or <code>Conditionally</code>. To determine the conditions for a <code>Conditionally</code> recreation, see the update behavior for that property in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p>"""
    path: NotRequired[
        "capo_cloudformation.types.resource_property_path.ResourcePropertyPath"
    ]
    """<p>The property path of the property.</p>"""
    before_value: NotRequired["capo_cloudformation.types.before_value.BeforeValue"]
    """<p>The value of the property before the change is executed. Large values can be truncated.</p>"""
    after_value: NotRequired["capo_cloudformation.types.after_value.AfterValue"]
    """<p>The value of the property after the change is executed. Large values can be truncated.</p>"""
    before_value_from: NotRequired[
        "capo_cloudformation.types.before_value_from.BeforeValueFrom"
    ]
    """<p>Indicates the source of the before value. Valid values:</p> <ul> <li> <p> <code>ACTUAL_STATE</code> – The before value represents current actual state.</p> </li> <li> <p> <code>PREVIOUS_DEPLOYMENT_STATE</code> – The before value represents the previous CloudFormation deployment state.</p> </li> </ul> <p>Only present for drift-aware change sets.</p>"""
    after_value_from: NotRequired[
        "capo_cloudformation.types.after_value_from.AfterValueFrom"
    ]
    """<p>Indicates the source of the after value. Valid value:</p> <ul> <li> <p> <code>TEMPLATE</code> – The after value comes from the new template.</p> </li> </ul> <p>Only present for drift-aware change sets.</p>"""
    drift: NotRequired[
        "capo_cloudformation.types.live_resource_drift.LiveResourceDrift"
    ]
    """<p>Detailed drift information for the resource property, including actual values, previous deployment values, and drift detection timestamps.</p>"""
    attribute_change_type: NotRequired[
        "capo_cloudformation.types.attribute_change_type.AttributeChangeType"
    ]
    """<p>The type of change to be made to the property if the change is executed.</p> <ul> <li> <p> <code>Add</code> The item will be added.</p> </li> <li> <p> <code>Remove</code> The item will be removed.</p> </li> <li> <p> <code>Modify</code> The item will be modified.</p> </li> <li> <p> <code>SyncWithActual</code> The drift status of this item will be reset but the item will not be modified.</p> </li> </ul>"""

after_value instance-attribute

after_value: NotRequired[AfterValue]

The value of the property after the change is executed. Large values can be truncated.

after_value_from instance-attribute

after_value_from: NotRequired[AfterValueFrom]

Indicates the source of the after value. Valid value:

  • TEMPLATE – The after value comes from the new template.

Only present for drift-aware change sets.

attribute instance-attribute

attribute: NotRequired[ResourceAttribute]

Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

attribute_change_type instance-attribute

attribute_change_type: NotRequired[AttributeChangeType]

The type of change to be made to the property if the change is executed.

  • Add The item will be added.

  • Remove The item will be removed.

  • Modify The item will be modified.

  • SyncWithActual The drift status of this item will be reset but the item will not be modified.

before_value instance-attribute

before_value: NotRequired[BeforeValue]

The value of the property before the change is executed. Large values can be truncated.

before_value_from instance-attribute

before_value_from: NotRequired[BeforeValueFrom]

Indicates the source of the before value. Valid values:

  • ACTUAL_STATE – The before value represents current actual state.

  • PREVIOUS_DEPLOYMENT_STATE – The before value represents the previous CloudFormation deployment state.

Only present for drift-aware change sets.

drift instance-attribute

drift: NotRequired[LiveResourceDrift]

Detailed drift information for the resource property, including actual values, previous deployment values, and drift detection timestamps.

name instance-attribute

name: NotRequired[PropertyName]

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

path instance-attribute

path: NotRequired[ResourcePropertyPath]

The property path of the property.

requires_recreation instance-attribute

requires_recreation: NotRequired[RequiresRecreation]

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.