Skip to content

StackRefactorAction

Source code in docs_src/capo_cloudformation/types/stack_refactor_action.py
class StackRefactorAction(TypedDict, closed=True):
    action: NotRequired[
        "capo_cloudformation.types.stack_refactor_action_type.StackRefactorActionType"
    ]
    """<p>The action that CloudFormation takes on the stack.</p>"""
    entity: NotRequired[
        "capo_cloudformation.types.stack_refactor_action_entity.StackRefactorActionEntity"
    ]
    """<p>The type that will be evaluated in the <code>StackRefactorAction</code>. The following are potential <code>Entity</code> types:</p> <ul> <li> <p> <code>Stack</code> </p> </li> <li> <p> <code>Resource</code> </p> </li> </ul>"""
    physical_resource_id: NotRequired[
        "capo_cloudformation.types.physical_resource_id.PhysicalResourceId"
    ]
    """<p>The name or unique identifier associated with the physical instance of the resource.</p>"""
    resource_identifier: NotRequired[
        "capo_cloudformation.types.stack_refactor_resource_identifier.StackRefactorResourceIdentifier"
    ]
    """<p>A key-value pair that identifies the target resource. The key is an identifier property (for example, <code>BucketName</code> for <code>AWS::S3::Bucket</code> resources) and the value is the actual property value (for example, <code>MyS3Bucket</code>).</p>"""
    description: NotRequired["capo_cloudformation.types.description.Description"]
    """<p>A description to help you identify the refactor.</p>"""
    detection: NotRequired[
        "capo_cloudformation.types.stack_refactor_detection.StackRefactorDetection"
    ]
    """<p>The detection type is one of the following:</p> <ul> <li> <p>Auto: CloudFormation figured out the mapping on its own.</p> </li> <li> <p>Manual: The customer provided the mapping in the <code>ResourceMapping</code> parameter.</p> </li> </ul>"""
    detection_reason: NotRequired[
        "capo_cloudformation.types.detection_reason.DetectionReason"
    ]
    """<p>The description of the detection type.</p>"""
    tag_resources: NotRequired[
        "capo_cloudformation.types.stack_refactor_tag_resources.StackRefactorTagResources"
    ]
    """<p>Assigns one or more tags to specified resources.</p>"""
    untag_resources: NotRequired[
        "capo_cloudformation.types.stack_refactor_untag_resources.StackRefactorUntagResources"
    ]
    """<p>Removes one or more tags to specified resources.</p>"""
    resource_mapping: NotRequired[
        "capo_cloudformation.types.resource_mapping.ResourceMapping"
    ]
    """<p>The mapping for the stack resource <code>Source</code> and stack resource <code>Destination</code>.</p>"""

action instance-attribute

action: NotRequired[StackRefactorActionType]

The action that CloudFormation takes on the stack.

description instance-attribute

description: NotRequired[Description]

A description to help you identify the refactor.

detection instance-attribute

detection: NotRequired[StackRefactorDetection]

The detection type is one of the following:

  • Auto: CloudFormation figured out the mapping on its own.

  • Manual: The customer provided the mapping in the ResourceMapping parameter.

detection_reason instance-attribute

detection_reason: NotRequired[DetectionReason]

The description of the detection type.

entity instance-attribute

entity: NotRequired[StackRefactorActionEntity]

The type that will be evaluated in the StackRefactorAction. The following are potential Entity types:

  • Stack

  • Resource

physical_resource_id instance-attribute

physical_resource_id: NotRequired[PhysicalResourceId]

The name or unique identifier associated with the physical instance of the resource.

resource_identifier instance-attribute

resource_identifier: NotRequired[StackRefactorResourceIdentifier]

A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

resource_mapping instance-attribute

resource_mapping: NotRequired[ResourceMapping]

The mapping for the stack resource Source and stack resource Destination.

tag_resources instance-attribute

tag_resources: NotRequired[StackRefactorTagResources]

Assigns one or more tags to specified resources.

untag_resources instance-attribute

untag_resources: NotRequired[StackRefactorUntagResources]

Removes one or more tags to specified resources.