LifecyclePolicy

class aws_cdk.aws_imagebuilder_alpha.LifecyclePolicy(scope, id, *, details, resource_selection, resource_type, description=None, execution_role=None, lifecycle_policy_name=None, status=None, tags=None)

Bases: Resource

(experimental) Represents an EC2 Image Builder Lifecycle Policy.

See:: https://docs.aws.amazon.com/imagebuilder/latest/userguide/manage-image-lifecycles.html
Stability:: experimental
ExampleMetadata:: infused

Example:

disabled_policy = imagebuilder.LifecyclePolicy(self, "DisabledPolicy",
    lifecycle_policy_name="my-disabled-policy",
    description="A lifecycle policy that is temporarily disabled",
    status=imagebuilder.LifecyclePolicyStatus.DISABLED,
    resource_type=imagebuilder.LifecyclePolicyResourceType.AMI_IMAGE,
    details=[imagebuilder.LifecyclePolicyDetail(
        action=imagebuilder.LifecyclePolicyAction(type=imagebuilder.LifecyclePolicyActionType.DELETE),
        filter=imagebuilder.LifecyclePolicyFilter(age_filter=imagebuilder.LifecyclePolicyAgeFilter(age=Duration.days(30)))
    )
    ],
    resource_selection=imagebuilder.LifecyclePolicyResourceSelection(
        tags={"Environment": "testing"}
    ),
    tags={
        "Owner": "DevOps",
        "CostCenter": "Engineering"
    }
)

Parameters:

scope (Construct)
id (str)
details (Sequence[Union[LifecyclePolicyDetail, Dict[str, Any]]]) – (experimental) Configuration details for the lifecycle policy rules.
resource_selection (Union[LifecyclePolicyResourceSelection, Dict[str, Any]]) – (experimental) Selection criteria for the resources that the lifecycle policy applies to.
resource_type (LifecyclePolicyResourceType) – (experimental) The type of Image Builder resource that the lifecycle policy applies to.
description (Optional[str]) – (experimental) The description of the lifecycle policy. Default: None
execution_role (Optional[IRole]) – (experimental) The execution role that grants Image Builder access to run lifecycle actions. By default, an execution role will be created with the minimal permissions needed to execute the lifecycle policy actions. Default: - an execution role will be generated
lifecycle_policy_name (Optional[str]) – (experimental) The name of the lifecycle policy. Default: - a name is generated
status (Optional[LifecyclePolicyStatus]) – (experimental) The status of the lifecycle policy. Default: LifecyclePolicyStatus.ENABLED
tags (Optional[Mapping[str, str]]) – (experimental) The tags to apply to the lifecycle policy. Default: - none

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

grant(grantee, *actions)

(experimental) Grant custom actions to the given grantee for the lifecycle policy.

Parameters:

grantee (IGrantable)
actions (str)

Stability:

experimental

Return type:

Grant

grant_read(grantee)

(experimental) Grant read permissions to the given grantee for the lifecycle policy.

Parameters:: grantee (IGrantable)
Stability:: experimental
Return type:: Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-imagebuilder-alpha.LifecyclePolicy'

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

execution_role

(experimental) The execution role used for lifecycle policy executions.

Stability:: experimental

lifecycle_policy_arn

(experimental) The ARN of the lifecycle policy.

Stability:: experimental

lifecycle_policy_name

(experimental) The name of the lifecycle policy.

Stability:: experimental

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_lifecycle_policy_arn(scope, id, lifecycle_policy_arn)

(experimental) Import an existing lifecycle policy given its ARN.

Parameters:

scope (Construct)
id (str)
lifecycle_policy_arn (str)

Stability:

experimental

Return type:

ILifecyclePolicy

classmethod from_lifecycle_policy_name(scope, id, lifecycle_policy_name)

(experimental) Import an existing lifecycle policy given its name.

If the name is a token representing a dynamic CloudFormation expression, you must ensure all alphabetic characters in the expression are already lowercased

Parameters:

scope (Construct)
id (str)
lifecycle_policy_name (str)

Stability:

experimental

Return type:

ILifecyclePolicy

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_lifecycle_policy(x)

(experimental) Return whether the given object is a LifecyclePolicy.

Parameters:: x (Any)
Stability:: experimental
Return type:: bool

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool