Python usage¶
To use stackwhy in your own Python scripts, import StackWhy
:
- class stackwhy.StackWhy(stack: str, session: Optional[boto3.session.Session] = None)¶
Visualises the most recent events on an Amazon Web Services CloudFormation stack.
- Parameters
stack – Stack ARN
session – Session (defaults to a new session)
- property events: List[stackwhy.event.Event]¶
Gets the most recent events on the stack.
- property has_any_physical_id: bool¶
Returns
True
if any of the discovered events describe a physical ID.
- render(writer: Optional[IO[str]] = None) None ¶
Renders a table of events.
- Parameters
writer – Writer (defaults to
stdout
)
- class stackwhy.Event(logical_id: str, physical_id: str, status: str, status_reason: str, type: str)¶
- logical_id: str¶
Logical ID of the resource referenced by this event.
- physical_id: str¶
Physical ID of the resource referenced by this event.
- status: str¶
Status of the resource referenced by this event.
- status_reason: str¶
Reason for the status of the resource referenced by this event.
- type: str¶
Type of the resource referenced by this event.