CfnLifecyclePolicy

class aws_cdk.aws_imagebuilder.CfnLifecyclePolicy(scope, id, *, execution_role, name, policy_details, resource_selection, resource_type, description=None, status=None, tags=None)

Bases: CfnResource

Create a lifecycle policy resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html

CloudformationResource:

AWS::ImageBuilder::LifecyclePolicy

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

cfn_lifecycle_policy = imagebuilder.CfnLifecyclePolicy(self, "MyCfnLifecyclePolicy",
    execution_role="executionRole",
    name="name",
    policy_details=[imagebuilder.CfnLifecyclePolicy.PolicyDetailProperty(
        action=imagebuilder.CfnLifecyclePolicy.ActionProperty(
            type="type",

            # the properties below are optional
            include_resources=imagebuilder.CfnLifecyclePolicy.IncludeResourcesProperty(
                amis=False,
                containers=False,
                snapshots=False
            )
        ),
        filter=imagebuilder.CfnLifecyclePolicy.FilterProperty(
            type="type",
            value=123,

            # the properties below are optional
            retain_at_least=123,
            unit="unit"
        ),

        # the properties below are optional
        exclusion_rules=imagebuilder.CfnLifecyclePolicy.ExclusionRulesProperty(
            amis=imagebuilder.CfnLifecyclePolicy.AmiExclusionRulesProperty(
                is_public=False,
                last_launched=imagebuilder.CfnLifecyclePolicy.LastLaunchedProperty(
                    unit="unit",
                    value=123
                ),
                regions=["regions"],
                shared_accounts=["sharedAccounts"],
                tag_map={
                    "tag_map_key": "tagMap"
                }
            ),
            tag_map={
                "tag_map_key": "tagMap"
            }
        )
    )],
    resource_selection=imagebuilder.CfnLifecyclePolicy.ResourceSelectionProperty(
        recipes=[imagebuilder.CfnLifecyclePolicy.RecipeSelectionProperty(
            name="name",
            semantic_version="semanticVersion"
        )],
        tag_map={
            "tag_map_key": "tagMap"
        }
    ),
    resource_type="resourceType",

    # the properties below are optional
    description="description",
    status="status",
    tags={
        "tags_key": "tags"
    }
)

Parameters:

• scope (Construct) – Scope in which this resource is defined.

• id (str) – Construct identifier for this resource (unique in its scope).

• execution_role (str) – The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.

• name (str) – The name of the lifecycle policy to create.

• policy_details (Union[IResolvable, Sequence[Union[IResolvable, PolicyDetailProperty, Dict[str, Any]]]]) – Configuration details for the lifecycle policy rules.

• resource_selection (Union[IResolvable, ResourceSelectionProperty, Dict[str, Any]]) – Selection criteria for the resources that the lifecycle policy applies to.

• resource_type (str) – The type of Image Builder resource that the lifecycle policy applies to.

• description (Optional[str]) – Optional description for the lifecycle policy.

• status (Optional[str]) – Indicates whether the lifecycle policy resource is enabled.

• tags (Optional[Mapping[str, str]]) – Tags to apply to the lifecycle policy resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

• key (str) –

• value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

• path (str) –

  • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

• value (Any) –

  • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

• property_path (str) – The path of the property.

• value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

• policy (Optional[RemovalPolicy]) –

• apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

• default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

• attribute_name (str) – The name of the attribute.

• type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

• target (CfnResource) – The dependency to replace.

• new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ImageBuilder::LifecyclePolicy'

attr_arn

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

CloudformationAttribute:

Arn

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

Optional description for the lifecycle policy.

execution_role

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the lifecycle policy to create.

node

The tree node.

policy_details

Configuration details for the lifecycle policy rules.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

resource_selection

Selection criteria for the resources that the lifecycle policy applies to.

resource_type

The type of Image Builder resource that the lifecycle policy applies to.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

status

Indicates whether the lifecycle policy resource is enabled.

tags

Tags to apply to the lifecycle policy resource.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

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.

ActionProperty

class CfnLifecyclePolicy.ActionProperty(*, type, include_resources=None)

Bases: object

Contains selection criteria for the lifecycle policy.

Parameters:

• type (str) – Specifies the lifecycle action to take.

• include_resources (Union[IResolvable, IncludeResourcesProperty, Dict[str, Any], None]) – Specifies the resources that the lifecycle policy applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-action.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

action_property = imagebuilder.CfnLifecyclePolicy.ActionProperty(
    type="type",

    # the properties below are optional
    include_resources=imagebuilder.CfnLifecyclePolicy.IncludeResourcesProperty(
        amis=False,
        containers=False,
        snapshots=False
    )
)

Attributes

include_resources

Specifies the resources that the lifecycle policy applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-action.html#cfn-imagebuilder-lifecyclepolicy-action-includeresources

type

Specifies the lifecycle action to take.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-action.html#cfn-imagebuilder-lifecyclepolicy-action-type

AmiExclusionRulesProperty

class CfnLifecyclePolicy.AmiExclusionRulesProperty(*, is_public=None, last_launched=None, regions=None, shared_accounts=None, tag_map=None)

Bases: object

Defines criteria for AMIs that are excluded from lifecycle actions.

Parameters:

• is_public (Union[bool, IResolvable, None]) – Configures whether public AMIs are excluded from the lifecycle action.

• last_launched (Union[IResolvable, LastLaunchedProperty, Dict[str, Any], None]) – Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions.

• regions (Optional[Sequence[str]]) – Configures AWS Region s that are excluded from the lifecycle action.

• shared_accounts (Optional[Sequence[str]]) – Specifies AWS account s whose resources are excluded from the lifecycle action.

• tag_map (Union[IResolvable, Mapping[str, str], None]) – Lists tags that should be excluded from lifecycle actions for the AMIs that have them.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

ami_exclusion_rules_property = imagebuilder.CfnLifecyclePolicy.AmiExclusionRulesProperty(
    is_public=False,
    last_launched=imagebuilder.CfnLifecyclePolicy.LastLaunchedProperty(
        unit="unit",
        value=123
    ),
    regions=["regions"],
    shared_accounts=["sharedAccounts"],
    tag_map={
        "tag_map_key": "tagMap"
    }
)

Attributes

is_public

Configures whether public AMIs are excluded from the lifecycle action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-ispublic

last_launched

Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-lastlaunched

regions

Configures AWS Region s that are excluded from the lifecycle action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-regions

shared_accounts

Specifies AWS account s whose resources are excluded from the lifecycle action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-sharedaccounts

tag_map

Lists tags that should be excluded from lifecycle actions for the AMIs that have them.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-tagmap

ExclusionRulesProperty

class CfnLifecyclePolicy.ExclusionRulesProperty(*, amis=None, tag_map=None)

Bases: object

Specifies resources that lifecycle policy actions should not apply to.

Parameters:

• amis (Union[IResolvable, AmiExclusionRulesProperty, Dict[str, Any], None]) – Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.

• tag_map (Union[IResolvable, Mapping[str, str], None]) – Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-exclusionrules.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

exclusion_rules_property = imagebuilder.CfnLifecyclePolicy.ExclusionRulesProperty(
    amis=imagebuilder.CfnLifecyclePolicy.AmiExclusionRulesProperty(
        is_public=False,
        last_launched=imagebuilder.CfnLifecyclePolicy.LastLaunchedProperty(
            unit="unit",
            value=123
        ),
        regions=["regions"],
        shared_accounts=["sharedAccounts"],
        tag_map={
            "tag_map_key": "tagMap"
        }
    ),
    tag_map={
        "tag_map_key": "tagMap"
    }
)

Attributes

amis

Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-exclusionrules.html#cfn-imagebuilder-lifecyclepolicy-exclusionrules-amis

tag_map

Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-exclusionrules.html#cfn-imagebuilder-lifecyclepolicy-exclusionrules-tagmap

FilterProperty

class CfnLifecyclePolicy.FilterProperty(*, type, value, retain_at_least=None, unit=None)

Bases: object

Defines filters that the lifecycle policy uses to determine impacted resource.

Parameters:

• type (str) – Filter resources based on either age or count .

• value (Union[int, float]) – The number of units for the time period or for the count. For example, a value of 6 might refer to six months or six AMIs. .. epigraph:: For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.

• retain_at_least (Union[int, float, None]) – For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.

• unit (Optional[str]) – Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

filter_property = imagebuilder.CfnLifecyclePolicy.FilterProperty(
    type="type",
    value=123,

    # the properties below are optional
    retain_at_least=123,
    unit="unit"
)

Attributes

retain_at_least

For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied.

Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-retainatleast

type

Filter resources based on either age or count .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-type

unit

Defines the unit of time that the lifecycle policy uses to determine impacted resources.

This is required for age-based rules.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-unit

value

The number of units for the time period or for the count.

For example, a value of 6 might refer to six months or six AMIs. .. epigraph:

For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-value

IncludeResourcesProperty

class CfnLifecyclePolicy.IncludeResourcesProperty(*, amis=None, containers=None, snapshots=None)

Bases: object

Specifies how the lifecycle policy should apply actions to selected resources.

Parameters:

• amis (Union[bool, IResolvable, None]) – Specifies whether the lifecycle action should apply to distributed AMIs.

• containers (Union[bool, IResolvable, None]) – Specifies whether the lifecycle action should apply to distributed containers.

• snapshots (Union[bool, IResolvable, None]) – Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-includeresources.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

include_resources_property = imagebuilder.CfnLifecyclePolicy.IncludeResourcesProperty(
    amis=False,
    containers=False,
    snapshots=False
)

Attributes

amis

Specifies whether the lifecycle action should apply to distributed AMIs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-includeresources.html#cfn-imagebuilder-lifecyclepolicy-includeresources-amis

containers

Specifies whether the lifecycle action should apply to distributed containers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-includeresources.html#cfn-imagebuilder-lifecyclepolicy-includeresources-containers

snapshots

Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-includeresources.html#cfn-imagebuilder-lifecyclepolicy-includeresources-snapshots

LastLaunchedProperty

class CfnLifecyclePolicy.LastLaunchedProperty(*, unit, value)

Bases: object

Defines criteria to exclude AMIs from lifecycle actions based on the last time they were used to launch an instance.

Parameters:

• unit (str) – Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years.

• value (Union[int, float]) – The integer number of units for the time period. For example 6 (months).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-lastlaunched.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

last_launched_property = imagebuilder.CfnLifecyclePolicy.LastLaunchedProperty(
    unit="unit",
    value=123
)

Attributes

unit

Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI.

For example: days, weeks, months, or years.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-lastlaunched.html#cfn-imagebuilder-lifecyclepolicy-lastlaunched-unit

value

The integer number of units for the time period.

For example 6 (months).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-lastlaunched.html#cfn-imagebuilder-lifecyclepolicy-lastlaunched-value

PolicyDetailProperty

class CfnLifecyclePolicy.PolicyDetailProperty(*, action, filter, exclusion_rules=None)

Bases: object

The configuration details for a lifecycle policy resource.

Parameters:

• action (Union[IResolvable, ActionProperty, Dict[str, Any]]) – Configuration details for the policy action.

• filter (Union[IResolvable, FilterProperty, Dict[str, Any]]) – Specifies the resources that the lifecycle policy applies to.

• exclusion_rules (Union[IResolvable, ExclusionRulesProperty, Dict[str, Any], None]) – Additional rules to specify resources that should be exempt from policy actions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-policydetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

policy_detail_property = imagebuilder.CfnLifecyclePolicy.PolicyDetailProperty(
    action=imagebuilder.CfnLifecyclePolicy.ActionProperty(
        type="type",

        # the properties below are optional
        include_resources=imagebuilder.CfnLifecyclePolicy.IncludeResourcesProperty(
            amis=False,
            containers=False,
            snapshots=False
        )
    ),
    filter=imagebuilder.CfnLifecyclePolicy.FilterProperty(
        type="type",
        value=123,

        # the properties below are optional
        retain_at_least=123,
        unit="unit"
    ),

    # the properties below are optional
    exclusion_rules=imagebuilder.CfnLifecyclePolicy.ExclusionRulesProperty(
        amis=imagebuilder.CfnLifecyclePolicy.AmiExclusionRulesProperty(
            is_public=False,
            last_launched=imagebuilder.CfnLifecyclePolicy.LastLaunchedProperty(
                unit="unit",
                value=123
            ),
            regions=["regions"],
            shared_accounts=["sharedAccounts"],
            tag_map={
                "tag_map_key": "tagMap"
            }
        ),
        tag_map={
            "tag_map_key": "tagMap"
        }
    )
)

Attributes

action

Configuration details for the policy action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-policydetail.html#cfn-imagebuilder-lifecyclepolicy-policydetail-action

exclusion_rules

Additional rules to specify resources that should be exempt from policy actions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-policydetail.html#cfn-imagebuilder-lifecyclepolicy-policydetail-exclusionrules

filter

Specifies the resources that the lifecycle policy applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-policydetail.html#cfn-imagebuilder-lifecyclepolicy-policydetail-filter

RecipeSelectionProperty

class CfnLifecyclePolicy.RecipeSelectionProperty(*, name, semantic_version)

Bases: object

Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.

Parameters:

• name (str) – The name of an Image Builder recipe that the lifecycle policy uses for resource selection.

• semantic_version (str) – The version of the Image Builder recipe specified by the name field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-recipeselection.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

recipe_selection_property = imagebuilder.CfnLifecyclePolicy.RecipeSelectionProperty(
    name="name",
    semantic_version="semanticVersion"
)

Attributes

name

The name of an Image Builder recipe that the lifecycle policy uses for resource selection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-recipeselection.html#cfn-imagebuilder-lifecyclepolicy-recipeselection-name

semantic_version

The version of the Image Builder recipe specified by the name field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-recipeselection.html#cfn-imagebuilder-lifecyclepolicy-recipeselection-semanticversion

ResourceSelectionProperty

class CfnLifecyclePolicy.ResourceSelectionProperty(*, recipes=None, tag_map=None)

Bases: object

Resource selection criteria for the lifecycle policy.

Parameters:

• recipes (Union[IResolvable, Sequence[Union[IResolvable, RecipeSelectionProperty, Dict[str, Any]]], None]) – A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.

• tag_map (Union[IResolvable, Mapping[str, str], None]) – A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-resourceselection.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

resource_selection_property = imagebuilder.CfnLifecyclePolicy.ResourceSelectionProperty(
    recipes=[imagebuilder.CfnLifecyclePolicy.RecipeSelectionProperty(
        name="name",
        semantic_version="semanticVersion"
    )],
    tag_map={
        "tag_map_key": "tagMap"
    }
)

Attributes

recipes

A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-resourceselection.html#cfn-imagebuilder-lifecyclepolicy-resourceselection-recipes

tag_map

A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-resourceselection.html#cfn-imagebuilder-lifecyclepolicy-resourceselection-tagmap