Skip to content

LifecyclePolicy

Source code in docs_src/capo_imagebuilder/types/lifecycle_policy.py
class LifecyclePolicy(TypedDict, closed=True):
    arn: NotRequired["capo_imagebuilder.types.lifecycle_policy_arn.LifecyclePolicyArn"]
    """<p>The Amazon Resource Name (ARN) of the lifecycle policy resource.</p>"""
    name: NotRequired["capo_imagebuilder.types.resource_name.ResourceName"]
    """<p>The name of the lifecycle policy.</p>"""
    description: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>Optional description for the lifecycle policy.</p>"""
    status: NotRequired[
        "capo_imagebuilder.types.lifecycle_policy_status.LifecyclePolicyStatus"
    ]
    """<p>Indicates whether the lifecycle policy resource is enabled. Only enabled policies run on their schedule. Disabling or deleting a policy removes its schedule and cancels any in-flight lifecycle execution.</p>"""
    execution_role: NotRequired[
        "capo_imagebuilder.types.role_name_or_arn.RoleNameOrArn"
    ]
    """<p>The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.</p>"""
    resource_type: NotRequired[
        "capo_imagebuilder.types.lifecycle_policy_resource_type.LifecyclePolicyResourceType"
    ]
    """<p>The type of resources the lifecycle policy targets.</p>"""
    policy_details: NotRequired[
        "capo_imagebuilder.types.lifecycle_policy_details.LifecyclePolicyDetails"
    ]
    """<p>The list of rules for the lifecycle policy. Each rule pairs an action with a filter and optional exclusion rules. A policy can contain at most one rule per action type.</p>"""
    resource_selection: NotRequired[
        "capo_imagebuilder.types.lifecycle_policy_resource_selection.LifecyclePolicyResourceSelection"
    ]
    """<p>Resource selection criteria used to run the lifecycle policy.</p>"""
    date_created: NotRequired[
        "capo_imagebuilder.types.date_time_timestamp.DateTimeTimestamp"
    ]
    """<p>The timestamp when Image Builder created the lifecycle policy resource.</p>"""
    date_updated: NotRequired[
        "capo_imagebuilder.types.date_time_timestamp.DateTimeTimestamp"
    ]
    """<p>The timestamp when Image Builder updated the lifecycle policy resource.</p>"""
    date_last_run: NotRequired[
        "capo_imagebuilder.types.date_time_timestamp.DateTimeTimestamp"
    ]
    """<p>The timestamp for the last time Image Builder ran the lifecycle policy.</p>"""
    tags: NotRequired["capo_imagebuilder.types.tag_map.TagMap"]
    """<p>To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.</p>"""

arn instance-attribute

arn: NotRequired[LifecyclePolicyArn]

The Amazon Resource Name (ARN) of the lifecycle policy resource.

date_created instance-attribute

date_created: NotRequired[DateTimeTimestamp]

The timestamp when Image Builder created the lifecycle policy resource.

date_last_run instance-attribute

date_last_run: NotRequired[DateTimeTimestamp]

The timestamp for the last time Image Builder ran the lifecycle policy.

date_updated instance-attribute

date_updated: NotRequired[DateTimeTimestamp]

The timestamp when Image Builder updated the lifecycle policy resource.

description instance-attribute

description: NotRequired[NonEmptyString]

Optional description for the lifecycle policy.

execution_role instance-attribute

execution_role: NotRequired[RoleNameOrArn]

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.

name instance-attribute

name: NotRequired[ResourceName]

The name of the lifecycle policy.

policy_details instance-attribute

policy_details: NotRequired[LifecyclePolicyDetails]

The list of rules for the lifecycle policy. Each rule pairs an action with a filter and optional exclusion rules. A policy can contain at most one rule per action type.

resource_selection instance-attribute

resource_selection: NotRequired[LifecyclePolicyResourceSelection]

Resource selection criteria used to run the lifecycle policy.

resource_type instance-attribute

resource_type: NotRequired[LifecyclePolicyResourceType]

The type of resources the lifecycle policy targets.

status instance-attribute

status: NotRequired[LifecyclePolicyStatus]

Indicates whether the lifecycle policy resource is enabled. Only enabled policies run on their schedule. Disabling or deleting a policy removes its schedule and cancels any in-flight lifecycle execution.

tags instance-attribute

tags: NotRequired[TagMap]

To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.