Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. imagebuilder
  5. getLifecyclePolicy

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.imagebuilder.getLifecyclePolicy

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::ImageBuilder::LifecyclePolicy

    Using getLifecyclePolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLifecyclePolicy(args: GetLifecyclePolicyArgs, opts?: InvokeOptions): Promise<GetLifecyclePolicyResult>
function getLifecyclePolicyOutput(args: GetLifecyclePolicyOutputArgs, opts?: InvokeOptions): Output<GetLifecyclePolicyResult>
    def get_lifecycle_policy(arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetLifecyclePolicyResult
def get_lifecycle_policy_output(arn: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetLifecyclePolicyResult]
    func LookupLifecyclePolicy(ctx *Context, args *LookupLifecyclePolicyArgs, opts ...InvokeOption) (*LookupLifecyclePolicyResult, error)
func LookupLifecyclePolicyOutput(ctx *Context, args *LookupLifecyclePolicyOutputArgs, opts ...InvokeOption) LookupLifecyclePolicyResultOutput

    > Note: This function is named LookupLifecyclePolicy in the Go SDK.

    public static class GetLifecyclePolicy 
{
    public static Task<GetLifecyclePolicyResult> InvokeAsync(GetLifecyclePolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetLifecyclePolicyResult> Invoke(GetLifecyclePolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLifecyclePolicyResult> getLifecyclePolicy(GetLifecyclePolicyArgs args, InvokeOptions options)
public static Output<GetLifecyclePolicyResult> getLifecyclePolicy(GetLifecyclePolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:imagebuilder:getLifecyclePolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    Arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    arn String
    The Amazon Resource Name (ARN) of the lifecycle policy.
    arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    arn str
    The Amazon Resource Name (ARN) of the lifecycle policy.
    arn String
    The Amazon Resource Name (ARN) of the lifecycle policy.

    getLifecyclePolicy Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    Description string
    The description of the lifecycle policy.
    ExecutionRole string
    The execution role of the lifecycle policy.
    PolicyDetails List<Pulumi.AwsNative.ImageBuilder.Outputs.LifecyclePolicyPolicyDetail>
    The policy details of the lifecycle policy.
    ResourceSelection Pulumi.AwsNative.ImageBuilder.Outputs.LifecyclePolicyResourceSelection
    The resource selection of the lifecycle policy.
    ResourceType Pulumi.AwsNative.ImageBuilder.LifecyclePolicyResourceType
    The resource type 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.
    Arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    Description string
    The description of 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.
    Status LifecyclePolicyStatus
    The status of the lifecycle policy.
    Tags map[string]string
    The tags associated with the lifecycle policy.
    arn String
    The Amazon Resource Name (ARN) of the lifecycle policy.
    description String
    The description of 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.
    status LifecyclePolicyStatus
    The status of the lifecycle policy.
    tags Map<String,String>
    The tags associated with the lifecycle policy.
    arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    description string
    The description of 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.
    status LifecyclePolicyStatus
    The status of the lifecycle policy.
    tags {[key: string]: string}
    The tags associated with the lifecycle policy.
    arn str
    The Amazon Resource Name (ARN) of the lifecycle policy.
    description str
    The description of the lifecycle policy.
    execution_role str
    The execution role of the lifecycle policy.
    policy_details Sequence[LifecyclePolicyPolicyDetail]
    The policy details of the lifecycle policy.
    resource_selection LifecyclePolicyResourceSelection
    The resource selection of the lifecycle policy.
    resource_type LifecyclePolicyResourceType
    The resource type of the lifecycle policy.
    status LifecyclePolicyStatus
    The status of the lifecycle policy.
    tags Mapping[str, str]
    The tags associated with the lifecycle policy.
    arn String
    The Amazon Resource Name (ARN) of the lifecycle policy.
    description String
    The description of 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.
    status "DISABLED" | "ENABLED"
    The status of the lifecycle policy.
    tags Map<String>
    The tags associated with the lifecycle policy.

    Supporting Types

    LifecyclePolicyAction

    Type Pulumi.AwsNative.ImageBuilder.LifecyclePolicyActionType
    The action type of the policy detail.
    IncludeResources Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyIncludeResources
    Specifies the resources that the lifecycle policy applies to.
    Type LifecyclePolicyActionType
    The action type of the policy detail.
    IncludeResources LifecyclePolicyIncludeResources
    Specifies the resources that the lifecycle policy applies to.
    type LifecyclePolicyActionType
    The action type of the policy detail.
    includeResources LifecyclePolicyIncludeResources
    Specifies the resources that the lifecycle policy applies to.
    type LifecyclePolicyActionType
    The action type of the policy detail.
    includeResources LifecyclePolicyIncludeResources
    Specifies the resources that the lifecycle policy applies to.
    type LifecyclePolicyActionType
    The action type of the policy detail.
    include_resources LifecyclePolicyIncludeResources
    Specifies the resources that the lifecycle policy applies to.
    type "DELETE" | "DEPRECATE" | "DISABLE"
    The action type of the policy detail.
    includeResources Property Map
    Specifies the resources that the lifecycle policy applies to.

    LifecyclePolicyActionType

    LifecyclePolicyAmiExclusionRules

    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

    Amis Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyAmiExclusionRules
    Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
    TagMap Dictionary<string, string>
    The Image Builder tags to filter on.
    Amis LifecyclePolicyAmiExclusionRules
    Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
    TagMap map[string]string
    The Image Builder tags to filter on.
    amis LifecyclePolicyAmiExclusionRules
    Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
    tagMap Map<String,String>
    The Image Builder tags to filter on.
    amis LifecyclePolicyAmiExclusionRules
    Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
    tagMap {[key: string]: string}
    The Image Builder tags to filter on.
    amis LifecyclePolicyAmiExclusionRules
    Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
    tag_map Mapping[str, str]
    The Image Builder tags to filter on.
    amis Property Map
    Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
    tagMap Map<String>
    The Image Builder tags to filter on.

    LifecyclePolicyFilter

    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

    LifecyclePolicyIncludeResources

    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

    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

    Action Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyAction
    Configuration details for the policy action.
    Filter Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyFilter
    Specifies the resources that the lifecycle policy applies to.
    ExclusionRules Pulumi.AwsNative.ImageBuilder.Inputs.LifecyclePolicyExclusionRules
    Additional rules to specify resources that should be exempt from policy actions.
    Action LifecyclePolicyAction
    Configuration details for the policy action.
    Filter LifecyclePolicyFilter
    Specifies the resources that the lifecycle policy applies to.
    ExclusionRules LifecyclePolicyExclusionRules
    Additional rules to specify resources that should be exempt from policy actions.
    action LifecyclePolicyAction
    Configuration details for the policy action.
    filter LifecyclePolicyFilter
    Specifies the resources that the lifecycle policy applies to.
    exclusionRules LifecyclePolicyExclusionRules
    Additional rules to specify resources that should be exempt from policy actions.
    action LifecyclePolicyAction
    Configuration details for the policy action.
    filter LifecyclePolicyFilter
    Specifies the resources that the lifecycle policy applies to.
    exclusionRules LifecyclePolicyExclusionRules
    Additional rules to specify resources that should be exempt from policy actions.
    action LifecyclePolicyAction
    Configuration details for the policy action.
    filter LifecyclePolicyFilter
    Specifies the resources that the lifecycle policy applies to.
    exclusion_rules LifecyclePolicyExclusionRules
    Additional rules to specify resources that should be exempt from policy actions.
    action Property Map
    Configuration details for the policy action.
    filter Property Map
    Specifies the resources that the lifecycle policy applies to.
    exclusionRules Property Map
    Additional rules to specify resources that should be exempt from policy actions.

    LifecyclePolicyRecipeSelection

    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

    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

    LifecyclePolicyStatus

    LifecyclePolicyTimeUnit

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native