Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. imagebuilder
  5. LifecyclePolicy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.imagebuilder.LifecyclePolicy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::ImageBuilder::LifecyclePolicy

    Create LifecyclePolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LifecyclePolicy(name: string, args: LifecyclePolicyArgs, opts?: CustomResourceOptions);
    @overload
def LifecyclePolicy(resource_name: str,
                    args: LifecyclePolicyArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def LifecyclePolicy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    execution_role: Optional[str] = None,
                    policy_details: Optional[Sequence[LifecyclePolicyPolicyDetailArgs]] = None,
                    resource_selection: Optional[LifecyclePolicyResourceSelectionArgs] = None,
                    resource_type: Optional[LifecyclePolicyResourceType] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    status: Optional[LifecyclePolicyStatus] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewLifecyclePolicy(ctx *Context, name string, args LifecyclePolicyArgs, opts ...ResourceOption) (*LifecyclePolicy, error)
    public LifecyclePolicy(string name, LifecyclePolicyArgs args, CustomResourceOptions? opts = null)
    public LifecyclePolicy(String name, LifecyclePolicyArgs args)
public LifecyclePolicy(String name, LifecyclePolicyArgs args, CustomResourceOptions options)

    type: aws-native:imagebuilder:LifecyclePolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const lifecyclePolicyResource = new aws_native.imagebuilder.LifecyclePolicy("lifecyclePolicyResource", {
    executionRole: "string",
    policyDetails: [{
        action: {
            type: aws_native.imagebuilder.LifecyclePolicyActionType.Delete,
            includeResources: {
                amis: false,
                containers: false,
                snapshots: false,
            },
        },
        filter: {
            type: aws_native.imagebuilder.LifecyclePolicyFilterType.Age,
            value: 0,
            retainAtLeast: 0,
            unit: aws_native.imagebuilder.LifecyclePolicyTimeUnit.Days,
        },
        exclusionRules: {
            amis: {
                isPublic: false,
                lastLaunched: {
                    unit: aws_native.imagebuilder.LifecyclePolicyTimeUnit.Days,
                    value: 0,
                },
                regions: ["string"],
                sharedAccounts: ["string"],
                tagMap: {
                    string: "string",
                },
            },
            tagMap: {
                string: "string",
            },
        },
    }],
    resourceSelection: {
        recipes: [{
            name: "string",
            semanticVersion: "string",
        }],
        tagMap: {
            string: "string",
        },
    },
    resourceType: aws_native.imagebuilder.LifecyclePolicyResourceType.AmiImage,
    description: "string",
    name: "string",
    status: aws_native.imagebuilder.LifecyclePolicyStatus.Disabled,
    tags: {
        string: "string",
    },
});

    Coming soon!

    LifecyclePolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The LifecyclePolicy resource accepts the following input properties:

    ExecutionRole string
    The execution role of the lifecycle policy.
    PolicyDetails List<Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyPolicyDetail>
    The policy details of the lifecycle policy.
    ResourceSelection Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyResourceSelection
    The resource selection of the lifecycle policy.
    ResourceType Pulumi.AwsNative.ImageBuilder.LifecyclePolicyResourceType
    The resource type of the lifecycle policy.
    Description string
    The description of the lifecycle policy.
    Name string
    The name of the lifecycle policy.
    Status Pulumi.AwsNative.ImageBuilder.LifecyclePolicyStatus
    The status of the lifecycle policy.
    Tags Dictionary<string, string>
    The tags associated with the lifecycle policy.
    ExecutionRole string
    The execution role of the lifecycle policy.
    PolicyDetails []LifecyclePolicyPolicyDetailArgs
    The policy details of the lifecycle policy.
    ResourceSelection LifecyclePolicyResourceSelectionArgs
    The resource selection of the lifecycle policy.
    ResourceType LifecyclePolicyResourceType
    The resource type of the lifecycle policy.
    Description string
    The description of the lifecycle policy.
    Name string
    The name of the lifecycle policy.
    Status LifecyclePolicyStatus
    The status of the lifecycle policy.
    Tags map[string]string
    The tags associated with the lifecycle policy.
    executionRole String
    The execution role of the lifecycle policy.
    policyDetails List<LifecyclePolicyPolicyDetail>
    The policy details of the lifecycle policy.
    resourceSelection LifecyclePolicyResourceSelection
    The resource selection of the lifecycle policy.
    resourceType LifecyclePolicyResourceType
    The resource type of the lifecycle policy.
    description String
    The description of the lifecycle policy.
    name String
    The name of the lifecycle policy.
    status LifecyclePolicyStatus
    The status of the lifecycle policy.
    tags Map<String,String>
    The tags associated with the lifecycle policy.
    executionRole string
    The execution role of the lifecycle policy.
    policyDetails LifecyclePolicyPolicyDetail[]
    The policy details of the lifecycle policy.
    resourceSelection LifecyclePolicyResourceSelection
    The resource selection of the lifecycle policy.
    resourceType LifecyclePolicyResourceType
    The resource type of the lifecycle policy.
    description string
    The description of the lifecycle policy.
    name string
    The name of the lifecycle policy.
    status LifecyclePolicyStatus
    The status of the lifecycle policy.
    tags {[key: string]: string}
    The tags associated with the lifecycle policy.
    execution_role str
    The execution role of the lifecycle policy.
    policy_details Sequence[LifecyclePolicyPolicyDetailArgs]
    The policy details of the lifecycle policy.
    resource_selection LifecyclePolicyResourceSelectionArgs
    The resource selection of the lifecycle policy.
    resource_type LifecyclePolicyResourceType
    The resource type of the lifecycle policy.
    description str
    The description of the lifecycle policy.
    name str
    The name of the lifecycle policy.
    status LifecyclePolicyStatus
    The status of the lifecycle policy.
    tags Mapping[str, str]
    The tags associated with the lifecycle policy.
    executionRole String
    The execution role of the lifecycle policy.
    policyDetails List<Property Map>
    The policy details of the lifecycle policy.
    resourceSelection Property Map
    The resource selection of the lifecycle policy.
    resourceType "AMI_IMAGE" | "CONTAINER_IMAGE"
    The resource type of the lifecycle policy.
    description String
    The description of the lifecycle policy.
    name String
    The name of the lifecycle policy.
    status "DISABLED" | "ENABLED"
    The status of the lifecycle policy.
    tags Map<String>
    The tags associated with the lifecycle policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LifecyclePolicy resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the lifecycle policy.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the lifecycle policy.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the lifecycle policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    LifecyclePolicyAction, LifecyclePolicyActionArgs

    LifecyclePolicyActionType, LifecyclePolicyActionTypeArgs

    Delete
    DELETE
    Deprecate
    DEPRECATE
    Disable
    DISABLE
    LifecyclePolicyActionTypeDelete
    DELETE
    LifecyclePolicyActionTypeDeprecate
    DEPRECATE
    LifecyclePolicyActionTypeDisable
    DISABLE
    Delete
    DELETE
    Deprecate
    DEPRECATE
    Disable
    DISABLE
    Delete
    DELETE
    Deprecate
    DEPRECATE
    Disable
    DISABLE
    DELETE
    DELETE
    DEPRECATE
    DEPRECATE
    DISABLE
    DISABLE
    "DELETE"
    DELETE
    "DEPRECATE"
    DEPRECATE
    "DISABLE"
    DISABLE

    LifecyclePolicyAmiExclusionRules, LifecyclePolicyAmiExclusionRulesArgs

    IsPublic bool
    Use to apply lifecycle policy actions on whether the AMI is public.
    LastLaunched Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyLastLaunched
    Use to apply lifecycle policy actions on AMIs launched before a certain time.
    Regions List<string>
    Use to apply lifecycle policy actions on AMIs distributed to a set of regions.
    SharedAccounts List<string>
    Use to apply lifecycle policy actions on AMIs shared with a set of regions.
    TagMap Dictionary<string, string>
    The AMIs to select by tag.
    IsPublic bool
    Use to apply lifecycle policy actions on whether the AMI is public.
    LastLaunched LifecyclePolicyLastLaunched
    Use to apply lifecycle policy actions on AMIs launched before a certain time.
    Regions []string
    Use to apply lifecycle policy actions on AMIs distributed to a set of regions.
    SharedAccounts []string
    Use to apply lifecycle policy actions on AMIs shared with a set of regions.
    TagMap map[string]string
    The AMIs to select by tag.
    isPublic Boolean
    Use to apply lifecycle policy actions on whether the AMI is public.
    lastLaunched LifecyclePolicyLastLaunched
    Use to apply lifecycle policy actions on AMIs launched before a certain time.
    regions List<String>
    Use to apply lifecycle policy actions on AMIs distributed to a set of regions.
    sharedAccounts List<String>
    Use to apply lifecycle policy actions on AMIs shared with a set of regions.
    tagMap Map<String,String>
    The AMIs to select by tag.
    isPublic boolean
    Use to apply lifecycle policy actions on whether the AMI is public.
    lastLaunched LifecyclePolicyLastLaunched
    Use to apply lifecycle policy actions on AMIs launched before a certain time.
    regions string[]
    Use to apply lifecycle policy actions on AMIs distributed to a set of regions.
    sharedAccounts string[]
    Use to apply lifecycle policy actions on AMIs shared with a set of regions.
    tagMap {[key: string]: string}
    The AMIs to select by tag.
    is_public bool
    Use to apply lifecycle policy actions on whether the AMI is public.
    last_launched LifecyclePolicyLastLaunched
    Use to apply lifecycle policy actions on AMIs launched before a certain time.
    regions Sequence[str]
    Use to apply lifecycle policy actions on AMIs distributed to a set of regions.
    shared_accounts Sequence[str]
    Use to apply lifecycle policy actions on AMIs shared with a set of regions.
    tag_map Mapping[str, str]
    The AMIs to select by tag.
    isPublic Boolean
    Use to apply lifecycle policy actions on whether the AMI is public.
    lastLaunched Property Map
    Use to apply lifecycle policy actions on AMIs launched before a certain time.
    regions List<String>
    Use to apply lifecycle policy actions on AMIs distributed to a set of regions.
    sharedAccounts List<String>
    Use to apply lifecycle policy actions on AMIs shared with a set of regions.
    tagMap Map<String>
    The AMIs to select by tag.

    LifecyclePolicyExclusionRules, LifecyclePolicyExclusionRulesArgs

    Amis Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyAmiExclusionRules
    TagMap Dictionary<string, string>
    The Image Builder tags to filter on.
    Amis LifecyclePolicyAmiExclusionRules
    TagMap map[string]string
    The Image Builder tags to filter on.
    amis LifecyclePolicyAmiExclusionRules
    tagMap Map<String,String>
    The Image Builder tags to filter on.
    amis LifecyclePolicyAmiExclusionRules
    tagMap {[key: string]: string}
    The Image Builder tags to filter on.
    amis LifecyclePolicyAmiExclusionRules
    tag_map Mapping[str, str]
    The Image Builder tags to filter on.
    amis Property Map
    tagMap Map<String>
    The Image Builder tags to filter on.

    LifecyclePolicyFilter, LifecyclePolicyFilterArgs

    Type Pulumi.AwsNative.ImageBuilder.LifecyclePolicyFilterType
    The filter type.
    Value int
    The filter value.
    RetainAtLeast int
    The minimum number of Image Builder resources to retain.
    Unit Pulumi.AwsNative.ImageBuilder.LifecyclePolicyTimeUnit
    The value's time unit.
    Type LifecyclePolicyFilterType
    The filter type.
    Value int
    The filter value.
    RetainAtLeast int
    The minimum number of Image Builder resources to retain.
    Unit LifecyclePolicyTimeUnit
    The value's time unit.
    type LifecyclePolicyFilterType
    The filter type.
    value Integer
    The filter value.
    retainAtLeast Integer
    The minimum number of Image Builder resources to retain.
    unit LifecyclePolicyTimeUnit
    The value's time unit.
    type LifecyclePolicyFilterType
    The filter type.
    value number
    The filter value.
    retainAtLeast number
    The minimum number of Image Builder resources to retain.
    unit LifecyclePolicyTimeUnit
    The value's time unit.
    type LifecyclePolicyFilterType
    The filter type.
    value int
    The filter value.
    retain_at_least int
    The minimum number of Image Builder resources to retain.
    unit LifecyclePolicyTimeUnit
    The value's time unit.
    type "AGE" | "COUNT"
    The filter type.
    value Number
    The filter value.
    retainAtLeast Number
    The minimum number of Image Builder resources to retain.
    unit "DAYS" | "WEEKS" | "MONTHS" | "YEARS"
    The value's time unit.

    LifecyclePolicyFilterType, LifecyclePolicyFilterTypeArgs

    Age
    AGE
    Count
    COUNT
    LifecyclePolicyFilterTypeAge
    AGE
    LifecyclePolicyFilterTypeCount
    COUNT
    Age
    AGE
    Count
    COUNT
    Age
    AGE
    Count
    COUNT
    AGE
    AGE
    COUNT
    COUNT
    "AGE"
    AGE
    "COUNT"
    COUNT

    LifecyclePolicyIncludeResources, LifecyclePolicyIncludeResourcesArgs

    Amis bool
    Use to configure lifecycle actions on AMIs.
    Containers bool
    Use to configure lifecycle actions on containers.
    Snapshots bool
    Use to configure lifecycle actions on snapshots.
    Amis bool
    Use to configure lifecycle actions on AMIs.
    Containers bool
    Use to configure lifecycle actions on containers.
    Snapshots bool
    Use to configure lifecycle actions on snapshots.
    amis Boolean
    Use to configure lifecycle actions on AMIs.
    containers Boolean
    Use to configure lifecycle actions on containers.
    snapshots Boolean
    Use to configure lifecycle actions on snapshots.
    amis boolean
    Use to configure lifecycle actions on AMIs.
    containers boolean
    Use to configure lifecycle actions on containers.
    snapshots boolean
    Use to configure lifecycle actions on snapshots.
    amis bool
    Use to configure lifecycle actions on AMIs.
    containers bool
    Use to configure lifecycle actions on containers.
    snapshots bool
    Use to configure lifecycle actions on snapshots.
    amis Boolean
    Use to configure lifecycle actions on AMIs.
    containers Boolean
    Use to configure lifecycle actions on containers.
    snapshots Boolean
    Use to configure lifecycle actions on snapshots.

    LifecyclePolicyLastLaunched, LifecyclePolicyLastLaunchedArgs

    Unit Pulumi.AwsNative.ImageBuilder.LifecyclePolicyTimeUnit
    The value's time unit.
    Value int
    The last launched value.
    Unit LifecyclePolicyTimeUnit
    The value's time unit.
    Value int
    The last launched value.
    unit LifecyclePolicyTimeUnit
    The value's time unit.
    value Integer
    The last launched value.
    unit LifecyclePolicyTimeUnit
    The value's time unit.
    value number
    The last launched value.
    unit LifecyclePolicyTimeUnit
    The value's time unit.
    value int
    The last launched value.
    unit "DAYS" | "WEEKS" | "MONTHS" | "YEARS"
    The value's time unit.
    value Number
    The last launched value.

    LifecyclePolicyPolicyDetail, LifecyclePolicyPolicyDetailArgs

    LifecyclePolicyRecipeSelection, LifecyclePolicyRecipeSelectionArgs

    Name string
    The recipe name.
    SemanticVersion string
    The recipe version.
    Name string
    The recipe name.
    SemanticVersion string
    The recipe version.
    name String
    The recipe name.
    semanticVersion String
    The recipe version.
    name string
    The recipe name.
    semanticVersion string
    The recipe version.
    name str
    The recipe name.
    semantic_version str
    The recipe version.
    name String
    The recipe name.
    semanticVersion String
    The recipe version.

    LifecyclePolicyResourceSelection, LifecyclePolicyResourceSelectionArgs

    Recipes List<Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyRecipeSelection>
    The recipes to select.
    TagMap Dictionary<string, string>
    The Image Builder resources to select by tag.
    Recipes []LifecyclePolicyRecipeSelection
    The recipes to select.
    TagMap map[string]string
    The Image Builder resources to select by tag.
    recipes List<LifecyclePolicyRecipeSelection>
    The recipes to select.
    tagMap Map<String,String>
    The Image Builder resources to select by tag.
    recipes LifecyclePolicyRecipeSelection[]
    The recipes to select.
    tagMap {[key: string]: string}
    The Image Builder resources to select by tag.
    recipes Sequence[LifecyclePolicyRecipeSelection]
    The recipes to select.
    tag_map Mapping[str, str]
    The Image Builder resources to select by tag.
    recipes List<Property Map>
    The recipes to select.
    tagMap Map<String>
    The Image Builder resources to select by tag.

    LifecyclePolicyResourceType, LifecyclePolicyResourceTypeArgs

    AmiImage
    AMI_IMAGE
    ContainerImage
    CONTAINER_IMAGE
    LifecyclePolicyResourceTypeAmiImage
    AMI_IMAGE
    LifecyclePolicyResourceTypeContainerImage
    CONTAINER_IMAGE
    AmiImage
    AMI_IMAGE
    ContainerImage
    CONTAINER_IMAGE
    AmiImage
    AMI_IMAGE
    ContainerImage
    CONTAINER_IMAGE
    AMI_IMAGE
    AMI_IMAGE
    CONTAINER_IMAGE
    CONTAINER_IMAGE
    "AMI_IMAGE"
    AMI_IMAGE
    "CONTAINER_IMAGE"
    CONTAINER_IMAGE

    LifecyclePolicyStatus, LifecyclePolicyStatusArgs

    Disabled
    DISABLED
    Enabled
    ENABLED
    LifecyclePolicyStatusDisabled
    DISABLED
    LifecyclePolicyStatusEnabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    DISABLED
    DISABLED
    ENABLED
    ENABLED
    "DISABLED"
    DISABLED
    "ENABLED"
    ENABLED

    LifecyclePolicyTimeUnit, LifecyclePolicyTimeUnitArgs

    Days
    DAYS
    Weeks
    WEEKS
    Months
    MONTHS
    Years
    YEARS
    LifecyclePolicyTimeUnitDays
    DAYS
    LifecyclePolicyTimeUnitWeeks
    WEEKS
    LifecyclePolicyTimeUnitMonths
    MONTHS
    LifecyclePolicyTimeUnitYears
    YEARS
    Days
    DAYS
    Weeks
    WEEKS
    Months
    MONTHS
    Years
    YEARS
    Days
    DAYS
    Weeks
    WEEKS
    Months
    MONTHS
    Years
    YEARS
    DAYS
    DAYS
    WEEKS
    WEEKS
    MONTHS
    MONTHS
    YEARS
    YEARS
    "DAYS"
    DAYS
    "WEEKS"
    WEEKS
    "MONTHS"
    MONTHS
    "YEARS"
    YEARS

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
    pulumi/pulumi-aws-native