runway.cfngin.hooks.cleanup_s3 module

CFNgin hook for cleaning up resources prior to CFN stack deletion.

pydantic model runway.cfngin.hooks.cleanup_s3.PurgeBucketHookArgs

Bases: BaseModel

Hook arguments for purge_bucket.

Show JSON schema

{
   "title": "PurgeBucketHookArgs",
   "description": "Hook arguments for ``purge_bucket``.",
   "type": "object",
   "properties": {
      "bucket_name": {
         "title": "Bucket Name",
         "type": "string"
      }
   },
   "required": [
      "bucket_name"
   ]
}

field bucket_name: str = PydanticUndefined

Name of the bucket to purge.

runway.cfngin.hooks.cleanup_s3.purge_bucket(context: runway.context.CfnginContext, *__args: Any, **kwargs: Any) → bool

Delete objects in bucket.