Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. dlm
  6. getLifecyclePolicy

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

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.dlm.getLifecyclePolicy

aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::DLM::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?: InvokeOutputOptions): Output<GetLifecyclePolicyResult>
    def get_lifecycle_policy(policy_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetLifecyclePolicyResult
def get_lifecycle_policy_output(policy_id: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOutputOptions] = 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 Output<GetLifecyclePolicyResult> Invoke(GetLifecyclePolicyInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetLifecyclePolicyResult> getLifecyclePolicy(GetLifecyclePolicyArgs args, InvokeOptions options)
public static Output<GetLifecyclePolicyResult> getLifecyclePolicy(GetLifecyclePolicyArgs args, InvokeOptions options)
public static Output<GetLifecyclePolicyResult> getLifecyclePolicy(GetLifecyclePolicyArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:dlm:getLifecyclePolicy
  arguments:
    # arguments dictionary
    data "aws-native_dlm_get_lifecycle_policy" "name" {
    # arguments
}

    The following arguments are supported:

    PolicyId string
    The identifier of the lifecycle policy.
    PolicyId string
    The identifier of the lifecycle policy.
    policy_id string
    The identifier of the lifecycle policy.
    policyId String
    The identifier of the lifecycle policy.
    policyId string
    The identifier of the lifecycle policy.
    policy_id str
    The identifier of the lifecycle policy.
    policyId String
    The identifier of the lifecycle policy.

    getLifecyclePolicy Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    CopyTags bool
    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
    CreateInterval int
    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
    CrossRegionCopyTargets List<Pulumi.AwsNative.Dlm.Outputs.LifecyclePolicyCrossRegionCopyTarget>
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    DefaultPolicy string
    [Default policies only] Specify the type of default policy to create.
    Description string
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    Exclusions Pulumi.AwsNative.Dlm.Outputs.LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    ExecutionRoleArn string
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    ExtendDeletion bool
    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
    PolicyDetails Pulumi.AwsNative.Dlm.Outputs.LifecyclePolicyPolicyDetails

    The configuration details of the lifecycle policy.

    If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

    PolicyId string
    The identifier of the lifecycle policy.
    RetainInterval int
    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
    State string
    The activation state of the lifecycle policy.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to apply to the lifecycle policy during creation.
    Arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    CopyTags bool
    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
    CreateInterval int
    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
    CrossRegionCopyTargets []LifecyclePolicyCrossRegionCopyTarget
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    DefaultPolicy string
    [Default policies only] Specify the type of default policy to create.
    Description string
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    Exclusions LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    ExecutionRoleArn string
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    ExtendDeletion bool
    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
    PolicyDetails LifecyclePolicyPolicyDetails

    The configuration details of the lifecycle policy.

    If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

    PolicyId string
    The identifier of the lifecycle policy.
    RetainInterval int
    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
    State string
    The activation state of the lifecycle policy.
    Tags Tag
    The tags to apply to the lifecycle policy during creation.
    arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    copy_tags bool
    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
    create_interval number
    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
    cross_region_copy_targets list(object)
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    default_policy string
    [Default policies only] Specify the type of default policy to create.
    description string
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    exclusions object
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    execution_role_arn string
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    extend_deletion bool
    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
    policy_details object

    The configuration details of the lifecycle policy.

    If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

    policy_id string
    The identifier of the lifecycle policy.
    retain_interval number
    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
    state string
    The activation state of the lifecycle policy.
    tags list(object)
    The tags to apply to the lifecycle policy during creation.
    arn String
    The Amazon Resource Name (ARN) of the lifecycle policy.
    copyTags Boolean
    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
    createInterval Integer
    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
    crossRegionCopyTargets List<LifecyclePolicyCrossRegionCopyTarget>
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    defaultPolicy String
    [Default policies only] Specify the type of default policy to create.
    description String
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    exclusions LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    executionRoleArn String
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    extendDeletion Boolean
    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
    policyDetails LifecyclePolicyPolicyDetails

    The configuration details of the lifecycle policy.

    If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

    policyId String
    The identifier of the lifecycle policy.
    retainInterval Integer
    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
    state String
    The activation state of the lifecycle policy.
    tags List<Tag>
    The tags to apply to the lifecycle policy during creation.
    arn string
    The Amazon Resource Name (ARN) of the lifecycle policy.
    copyTags boolean
    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
    createInterval number
    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
    crossRegionCopyTargets LifecyclePolicyCrossRegionCopyTarget[]
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    defaultPolicy string
    [Default policies only] Specify the type of default policy to create.
    description string
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    exclusions LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    executionRoleArn string
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    extendDeletion boolean
    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
    policyDetails LifecyclePolicyPolicyDetails

    The configuration details of the lifecycle policy.

    If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

    policyId string
    The identifier of the lifecycle policy.
    retainInterval number
    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
    state string
    The activation state of the lifecycle policy.
    tags Tag[]
    The tags to apply to the lifecycle policy during creation.
    arn str
    The Amazon Resource Name (ARN) of the lifecycle policy.
    copy_tags bool
    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
    create_interval int
    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
    cross_region_copy_targets Sequence[LifecyclePolicyCrossRegionCopyTarget]
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    default_policy str
    [Default policies only] Specify the type of default policy to create.
    description str
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    exclusions LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    execution_role_arn str
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    extend_deletion bool
    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
    policy_details LifecyclePolicyPolicyDetails

    The configuration details of the lifecycle policy.

    If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

    policy_id str
    The identifier of the lifecycle policy.
    retain_interval int
    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
    state str
    The activation state of the lifecycle policy.
    tags Sequence[root_Tag]
    The tags to apply to the lifecycle policy during creation.
    arn String
    The Amazon Resource Name (ARN) of the lifecycle policy.
    copyTags Boolean
    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
    createInterval Number
    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
    crossRegionCopyTargets List<Property Map>
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    defaultPolicy String
    [Default policies only] Specify the type of default policy to create.
    description String
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    exclusions Property Map
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    executionRoleArn String
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    extendDeletion Boolean
    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
    policyDetails Property Map

    The configuration details of the lifecycle policy.

    If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

    policyId String
    The identifier of the lifecycle policy.
    retainInterval Number
    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
    state String
    The activation state of the lifecycle policy.
    tags List<Property Map>
    The tags to apply to the lifecycle policy during creation.

    Supporting Types

    LifecyclePolicyAction

    CrossRegionCopy List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyCrossRegionCopyAction>
    The rule for copying shared snapshots across Regions.
    Name string
    A descriptive name for the action.
    CrossRegionCopy []LifecyclePolicyCrossRegionCopyAction
    The rule for copying shared snapshots across Regions.
    Name string
    A descriptive name for the action.
    cross_region_copy list(object)
    The rule for copying shared snapshots across Regions.
    name string
    A descriptive name for the action.
    crossRegionCopy List<LifecyclePolicyCrossRegionCopyAction>
    The rule for copying shared snapshots across Regions.
    name String
    A descriptive name for the action.
    crossRegionCopy LifecyclePolicyCrossRegionCopyAction[]
    The rule for copying shared snapshots across Regions.
    name string
    A descriptive name for the action.
    cross_region_copy Sequence[LifecyclePolicyCrossRegionCopyAction]
    The rule for copying shared snapshots across Regions.
    name str
    A descriptive name for the action.
    crossRegionCopy List<Property Map>
    The rule for copying shared snapshots across Regions.
    name String
    A descriptive name for the action.

    LifecyclePolicyArchiveRetainRule

    RetentionArchiveTier Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyRetentionArchiveTier
    Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots .
    RetentionArchiveTier LifecyclePolicyRetentionArchiveTier
    Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots .
    retention_archive_tier object
    Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots .
    retentionArchiveTier LifecyclePolicyRetentionArchiveTier
    Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots .
    retentionArchiveTier LifecyclePolicyRetentionArchiveTier
    Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots .
    retention_archive_tier LifecyclePolicyRetentionArchiveTier
    Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots .
    retentionArchiveTier Property Map
    Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots .

    LifecyclePolicyArchiveRule

    RetainRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyArchiveRetainRule
    Information about the retention period for the snapshot archiving rule.
    RetainRule LifecyclePolicyArchiveRetainRule
    Information about the retention period for the snapshot archiving rule.
    retain_rule object
    Information about the retention period for the snapshot archiving rule.
    retainRule LifecyclePolicyArchiveRetainRule
    Information about the retention period for the snapshot archiving rule.
    retainRule LifecyclePolicyArchiveRetainRule
    Information about the retention period for the snapshot archiving rule.
    retain_rule LifecyclePolicyArchiveRetainRule
    Information about the retention period for the snapshot archiving rule.
    retainRule Property Map
    Information about the retention period for the snapshot archiving rule.

    LifecyclePolicyCreateRule

    CronExpression string
    The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year.
    Interval int
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    IntervalUnit string
    The interval unit.
    Location string

    [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

    • If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.
    • If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.
    • If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

    Default: CLOUD

    Scripts List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyScript>
    [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
    Times List<string>

    The time, in UTC, to start the operation. The supported format is hh:mm.

    The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

    CronExpression string
    The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year.
    Interval int
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    IntervalUnit string
    The interval unit.
    Location string

    [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

    • If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.
    • If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.
    • If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

    Default: CLOUD

    Scripts []LifecyclePolicyScript
    [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
    Times []string

    The time, in UTC, to start the operation. The supported format is hh:mm.

    The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

    cron_expression string
    The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year.
    interval number
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    interval_unit string
    The interval unit.
    location string

    [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

    • If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.
    • If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.
    • If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

    Default: CLOUD

    scripts list(object)
    [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
    times list(string)

    The time, in UTC, to start the operation. The supported format is hh:mm.

    The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

    cronExpression String
    The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year.
    interval Integer
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    intervalUnit String
    The interval unit.
    location String

    [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

    • If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.
    • If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.
    • If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

    Default: CLOUD

    scripts List<LifecyclePolicyScript>
    [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
    times List<String>

    The time, in UTC, to start the operation. The supported format is hh:mm.

    The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

    cronExpression string
    The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year.
    interval number
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    intervalUnit string
    The interval unit.
    location string

    [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

    • If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.
    • If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.
    • If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

    Default: CLOUD

    scripts LifecyclePolicyScript[]
    [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
    times string[]

    The time, in UTC, to start the operation. The supported format is hh:mm.

    The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

    cron_expression str
    The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year.
    interval int
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    interval_unit str
    The interval unit.
    location str

    [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

    • If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.
    • If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.
    • If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

    Default: CLOUD

    scripts Sequence[LifecyclePolicyScript]
    [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
    times Sequence[str]

    The time, in UTC, to start the operation. The supported format is hh:mm.

    The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

    cronExpression String
    The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year.
    interval Number
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    intervalUnit String
    The interval unit.
    location String

    [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

    • If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.
    • If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.
    • If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

    Default: CLOUD

    scripts List<Property Map>
    [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
    times List<String>

    The time, in UTC, to start the operation. The supported format is hh:mm.

    The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

    LifecyclePolicyCrossRegionCopyAction

    EncryptionConfiguration Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyEncryptionConfiguration
    The encryption settings for the copied snapshot.
    Target string
    The target Region.
    RetainRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyCrossRegionCopyRetainRule
    Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.
    EncryptionConfiguration LifecyclePolicyEncryptionConfiguration
    The encryption settings for the copied snapshot.
    Target string
    The target Region.
    RetainRule LifecyclePolicyCrossRegionCopyRetainRule
    Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.
    encryption_configuration object
    The encryption settings for the copied snapshot.
    target string
    The target Region.
    retain_rule object
    Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.
    encryptionConfiguration LifecyclePolicyEncryptionConfiguration
    The encryption settings for the copied snapshot.
    target String
    The target Region.
    retainRule LifecyclePolicyCrossRegionCopyRetainRule
    Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.
    encryptionConfiguration LifecyclePolicyEncryptionConfiguration
    The encryption settings for the copied snapshot.
    target string
    The target Region.
    retainRule LifecyclePolicyCrossRegionCopyRetainRule
    Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.
    encryption_configuration LifecyclePolicyEncryptionConfiguration
    The encryption settings for the copied snapshot.
    target str
    The target Region.
    retain_rule LifecyclePolicyCrossRegionCopyRetainRule
    Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.
    encryptionConfiguration Property Map
    The encryption settings for the copied snapshot.
    target String
    The target Region.
    retainRule Property Map
    Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.

    LifecyclePolicyCrossRegionCopyDeprecateRule

    Interval int
    The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    IntervalUnit string
    The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    Interval int
    The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    IntervalUnit string
    The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval number
    The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    interval_unit string
    The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval Integer
    The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    intervalUnit String
    The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval number
    The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    intervalUnit string
    The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval int
    The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    interval_unit str
    The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval Number
    The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    intervalUnit String
    The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.

    LifecyclePolicyCrossRegionCopyRetainRule

    Interval int
    The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    IntervalUnit string
    The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    Interval int
    The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    IntervalUnit string
    The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval number
    The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    interval_unit string
    The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval Integer
    The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit String
    The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval number
    The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit string
    The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval int
    The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    interval_unit str
    The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
    interval Number
    The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit String
    The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

    LifecyclePolicyCrossRegionCopyRule

    Encrypted bool
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
    CmkArn string
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    CopyTags bool
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    DeprecateRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyCrossRegionCopyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
    RetainRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyCrossRegionCopyRetainRule
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    Target string
    [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    TargetRegion string
    [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the AMI copies.
    Encrypted bool
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
    CmkArn string
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    CopyTags bool
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    DeprecateRule LifecyclePolicyCrossRegionCopyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
    RetainRule LifecyclePolicyCrossRegionCopyRetainRule
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    Target string
    [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    TargetRegion string
    [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the AMI copies.
    encrypted bool
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
    cmk_arn string
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    copy_tags bool
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    deprecate_rule object
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
    retain_rule object
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    target string
    [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    target_region string
    [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the AMI copies.
    encrypted Boolean
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
    cmkArn String
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    copyTags Boolean
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    deprecateRule LifecyclePolicyCrossRegionCopyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
    retainRule LifecyclePolicyCrossRegionCopyRetainRule
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    target String
    [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    targetRegion String
    [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the AMI copies.
    encrypted boolean
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
    cmkArn string
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    copyTags boolean
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    deprecateRule LifecyclePolicyCrossRegionCopyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
    retainRule LifecyclePolicyCrossRegionCopyRetainRule
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    target string
    [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    targetRegion string
    [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the AMI copies.
    encrypted bool
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
    cmk_arn str
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    copy_tags bool
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    deprecate_rule LifecyclePolicyCrossRegionCopyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
    retain_rule LifecyclePolicyCrossRegionCopyRetainRule
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    target str
    [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    target_region str
    [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the AMI copies.
    encrypted Boolean
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
    cmkArn String
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    copyTags Boolean
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    deprecateRule Property Map
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
    retainRule Property Map
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    target String
    [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    targetRegion String
    [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the AMI copies.

    LifecyclePolicyCrossRegionCopyTarget

    TargetRegion string
    The target Region, for example us-east-1.
    TargetRegion string
    The target Region, for example us-east-1.
    target_region string
    The target Region, for example us-east-1.
    targetRegion String
    The target Region, for example us-east-1.
    targetRegion string
    The target Region, for example us-east-1.
    target_region str
    The target Region, for example us-east-1.
    targetRegion String
    The target Region, for example us-east-1.

    LifecyclePolicyDeprecateRule

    Count int
    If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
    Interval int
    If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    IntervalUnit string
    The unit of time in which to measure the Interval.
    Count int
    If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
    Interval int
    If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    IntervalUnit string
    The unit of time in which to measure the Interval.
    count number
    If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
    interval number
    If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    interval_unit string
    The unit of time in which to measure the Interval.
    count Integer
    If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
    interval Integer
    If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    intervalUnit String
    The unit of time in which to measure the Interval.
    count number
    If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
    interval number
    If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    intervalUnit string
    The unit of time in which to measure the Interval.
    count int
    If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
    interval int
    If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    interval_unit str
    The unit of time in which to measure the Interval.
    count Number
    If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
    interval Number
    If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    intervalUnit String
    The unit of time in which to measure the Interval.

    LifecyclePolicyEncryptionConfiguration

    Encrypted bool
    To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
    CmkArn string
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    Encrypted bool
    To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
    CmkArn string
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    encrypted bool
    To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
    cmk_arn string
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    encrypted Boolean
    To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
    cmkArn String
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    encrypted boolean
    To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
    cmkArn string
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    encrypted bool
    To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
    cmk_arn str
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    encrypted Boolean
    To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
    cmkArn String
    The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.

    LifecyclePolicyEventParameters

    EventType string
    The type of event. Currently, only snapshot sharing events are supported.
    SnapshotOwner List<string>
    The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
    DescriptionRegex string
    The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
    EventType string
    The type of event. Currently, only snapshot sharing events are supported.
    SnapshotOwner []string
    The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
    DescriptionRegex string
    The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
    event_type string
    The type of event. Currently, only snapshot sharing events are supported.
    snapshot_owner list(string)
    The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
    description_regex string
    The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
    eventType String
    The type of event. Currently, only snapshot sharing events are supported.
    snapshotOwner List<String>
    The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
    descriptionRegex String
    The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
    eventType string
    The type of event. Currently, only snapshot sharing events are supported.
    snapshotOwner string[]
    The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
    descriptionRegex string
    The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
    event_type str
    The type of event. Currently, only snapshot sharing events are supported.
    snapshot_owner Sequence[str]
    The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
    description_regex str
    The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
    eventType String
    The type of event. Currently, only snapshot sharing events are supported.
    snapshotOwner List<String>
    The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
    descriptionRegex String
    The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.

    LifecyclePolicyEventSource

    Type string
    The source of the event. Currently only managed Amazon EventBridge events are supported.
    Parameters Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyEventParameters
    Information about the event.
    Type string
    The source of the event. Currently only managed Amazon EventBridge events are supported.
    Parameters LifecyclePolicyEventParameters
    Information about the event.
    type string
    The source of the event. Currently only managed Amazon EventBridge events are supported.
    parameters object
    Information about the event.
    type String
    The source of the event. Currently only managed Amazon EventBridge events are supported.
    parameters LifecyclePolicyEventParameters
    Information about the event.
    type string
    The source of the event. Currently only managed Amazon EventBridge events are supported.
    parameters LifecyclePolicyEventParameters
    Information about the event.
    type str
    The source of the event. Currently only managed Amazon EventBridge events are supported.
    parameters LifecyclePolicyEventParameters
    Information about the event.
    type String
    The source of the event. Currently only managed Amazon EventBridge events are supported.
    parameters Property Map
    Information about the event.

    LifecyclePolicyExclusions

    ExcludeBootVolumes bool
    [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.
    ExcludeTags List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyTag>
    [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
    ExcludeVolumeTypes List<string>
    [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.
    ExcludeBootVolumes bool
    [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.
    ExcludeTags []LifecyclePolicyTag
    [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
    ExcludeVolumeTypes []string
    [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.
    exclude_boot_volumes bool
    [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.
    exclude_tags list(object)
    [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
    exclude_volume_types list(string)
    [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.
    excludeBootVolumes Boolean
    [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.
    excludeTags List<LifecyclePolicyTag>
    [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
    excludeVolumeTypes List<String>
    [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.
    excludeBootVolumes boolean
    [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.
    excludeTags LifecyclePolicyTag[]
    [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
    excludeVolumeTypes string[]
    [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.
    exclude_boot_volumes bool
    [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.
    exclude_tags Sequence[LifecyclePolicyTag]
    [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
    exclude_volume_types Sequence[str]
    [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.
    excludeBootVolumes Boolean
    [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.
    excludeTags List<Property Map>
    [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
    excludeVolumeTypes List<String>
    [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.

    LifecyclePolicyFastRestoreRule

    AvailabilityZoneIds List<string>
    The Availability Zone IDs in which to enable fast snapshot restore.
    AvailabilityZones List<string>
    The Availability Zones in which to enable fast snapshot restore.
    Count int
    The number of snapshots to be enabled with fast snapshot restore.
    Interval int
    The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    IntervalUnit string
    The unit of time for enabling fast snapshot restore.
    AvailabilityZoneIds []string
    The Availability Zone IDs in which to enable fast snapshot restore.
    AvailabilityZones []string
    The Availability Zones in which to enable fast snapshot restore.
    Count int
    The number of snapshots to be enabled with fast snapshot restore.
    Interval int
    The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    IntervalUnit string
    The unit of time for enabling fast snapshot restore.
    availability_zone_ids list(string)
    The Availability Zone IDs in which to enable fast snapshot restore.
    availability_zones list(string)
    The Availability Zones in which to enable fast snapshot restore.
    count number
    The number of snapshots to be enabled with fast snapshot restore.
    interval number
    The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    interval_unit string
    The unit of time for enabling fast snapshot restore.
    availabilityZoneIds List<String>
    The Availability Zone IDs in which to enable fast snapshot restore.
    availabilityZones List<String>
    The Availability Zones in which to enable fast snapshot restore.
    count Integer
    The number of snapshots to be enabled with fast snapshot restore.
    interval Integer
    The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit String
    The unit of time for enabling fast snapshot restore.
    availabilityZoneIds string[]
    The Availability Zone IDs in which to enable fast snapshot restore.
    availabilityZones string[]
    The Availability Zones in which to enable fast snapshot restore.
    count number
    The number of snapshots to be enabled with fast snapshot restore.
    interval number
    The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit string
    The unit of time for enabling fast snapshot restore.
    availability_zone_ids Sequence[str]
    The Availability Zone IDs in which to enable fast snapshot restore.
    availability_zones Sequence[str]
    The Availability Zones in which to enable fast snapshot restore.
    count int
    The number of snapshots to be enabled with fast snapshot restore.
    interval int
    The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    interval_unit str
    The unit of time for enabling fast snapshot restore.
    availabilityZoneIds List<String>
    The Availability Zone IDs in which to enable fast snapshot restore.
    availabilityZones List<String>
    The Availability Zones in which to enable fast snapshot restore.
    count Number
    The number of snapshots to be enabled with fast snapshot restore.
    interval Number
    The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit String
    The unit of time for enabling fast snapshot restore.

    LifecyclePolicyParameters

    ExcludeBootVolume bool
    [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    ExcludeDataVolumeTags List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyTag>
    [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets. If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    NoReboot bool

    [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs.

    The default is true (instances are not rebooted).

    ExcludeBootVolume bool
    [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    ExcludeDataVolumeTags []LifecyclePolicyTag
    [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets. If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    NoReboot bool

    [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs.

    The default is true (instances are not rebooted).

    exclude_boot_volume bool
    [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    exclude_data_volume_tags list(object)
    [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets. If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    no_reboot bool

    [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs.

    The default is true (instances are not rebooted).

    excludeBootVolume Boolean
    [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    excludeDataVolumeTags List<LifecyclePolicyTag>
    [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets. If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    noReboot Boolean

    [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs.

    The default is true (instances are not rebooted).

    excludeBootVolume boolean
    [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    excludeDataVolumeTags LifecyclePolicyTag[]
    [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets. If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    noReboot boolean

    [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs.

    The default is true (instances are not rebooted).

    exclude_boot_volume bool
    [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    exclude_data_volume_tags Sequence[LifecyclePolicyTag]
    [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets. If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    no_reboot bool

    [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs.

    The default is true (instances are not rebooted).

    excludeBootVolume Boolean
    [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    excludeDataVolumeTags List<Property Map>
    [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets. If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    noReboot Boolean

    [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs.

    The default is true (instances are not rebooted).

    LifecyclePolicyPolicyDetails

    Actions List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyAction>
    [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
    CopyTags bool

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

    Default: false

    CreateInterval int

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

    Default: 1

    CrossRegionCopyTargets List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyCrossRegionCopyTarget>
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    EventSource Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyEventSource
    [Event-based policies only] The event that activates the event-based policy.
    Exclusions Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    ExtendDeletion bool

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    Default: false

    Parameters Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyParameters

    [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

    If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

    PolicyLanguage string
    The type of policy to create. Specify one of the following:

    • SIMPLIFIED -- To create a default policy.
    • STANDARD -- To create a custom policy.
    PolicyType string

    The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

    The default is EBS_SNAPSHOT_MANAGEMENT.

    ResourceLocations List<string>
    [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in a Region, specify CLOUD.
    ResourceType string
    [Default policies only] Specify the type of default policy to create.

    • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
    • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    ResourceTypes List<string>
    [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
    RetainInterval int

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

    Default: 7

    Schedules List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicySchedule>
    [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules -- one mandatory schedule and up to three optional schedules.
    TargetTags List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyTag>
    [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
    Actions []LifecyclePolicyAction
    [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
    CopyTags bool

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

    Default: false

    CreateInterval int

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

    Default: 1

    CrossRegionCopyTargets []LifecyclePolicyCrossRegionCopyTarget
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    EventSource LifecyclePolicyEventSource
    [Event-based policies only] The event that activates the event-based policy.
    Exclusions LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    ExtendDeletion bool

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    Default: false

    Parameters LifecyclePolicyParameters

    [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

    If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

    PolicyLanguage string
    The type of policy to create. Specify one of the following:

    • SIMPLIFIED -- To create a default policy.
    • STANDARD -- To create a custom policy.
    PolicyType string

    The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

    The default is EBS_SNAPSHOT_MANAGEMENT.

    ResourceLocations []string
    [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in a Region, specify CLOUD.
    ResourceType string
    [Default policies only] Specify the type of default policy to create.

    • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
    • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    ResourceTypes []string
    [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
    RetainInterval int

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

    Default: 7

    Schedules []LifecyclePolicySchedule
    [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules -- one mandatory schedule and up to three optional schedules.
    TargetTags []LifecyclePolicyTag
    [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
    actions list(object)
    [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
    copy_tags bool

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

    Default: false

    create_interval number

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

    Default: 1

    cross_region_copy_targets list(object)
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    event_source object
    [Event-based policies only] The event that activates the event-based policy.
    exclusions object
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    extend_deletion bool

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    Default: false

    parameters object

    [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

    If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

    policy_language string
    The type of policy to create. Specify one of the following:

    • SIMPLIFIED -- To create a default policy.
    • STANDARD -- To create a custom policy.
    policy_type string

    The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

    The default is EBS_SNAPSHOT_MANAGEMENT.

    resource_locations list(string)
    [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in a Region, specify CLOUD.
    resource_type string
    [Default policies only] Specify the type of default policy to create.

    • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
    • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    resource_types list(string)
    [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
    retain_interval number

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

    Default: 7

    schedules list(object)
    [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules -- one mandatory schedule and up to three optional schedules.
    target_tags list(object)
    [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
    actions List<LifecyclePolicyAction>
    [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
    copyTags Boolean

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

    Default: false

    createInterval Integer

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

    Default: 1

    crossRegionCopyTargets List<LifecyclePolicyCrossRegionCopyTarget>
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    eventSource LifecyclePolicyEventSource
    [Event-based policies only] The event that activates the event-based policy.
    exclusions LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    extendDeletion Boolean

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    Default: false

    parameters LifecyclePolicyParameters

    [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

    If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

    policyLanguage String
    The type of policy to create. Specify one of the following:

    • SIMPLIFIED -- To create a default policy.
    • STANDARD -- To create a custom policy.
    policyType String

    The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

    The default is EBS_SNAPSHOT_MANAGEMENT.

    resourceLocations List<String>
    [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in a Region, specify CLOUD.
    resourceType String
    [Default policies only] Specify the type of default policy to create.

    • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
    • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    resourceTypes List<String>
    [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
    retainInterval Integer

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

    Default: 7

    schedules List<LifecyclePolicySchedule>
    [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules -- one mandatory schedule and up to three optional schedules.
    targetTags List<LifecyclePolicyTag>
    [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
    actions LifecyclePolicyAction[]
    [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
    copyTags boolean

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

    Default: false

    createInterval number

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

    Default: 1

    crossRegionCopyTargets LifecyclePolicyCrossRegionCopyTarget[]
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    eventSource LifecyclePolicyEventSource
    [Event-based policies only] The event that activates the event-based policy.
    exclusions LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    extendDeletion boolean

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    Default: false

    parameters LifecyclePolicyParameters

    [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

    If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

    policyLanguage string
    The type of policy to create. Specify one of the following:

    • SIMPLIFIED -- To create a default policy.
    • STANDARD -- To create a custom policy.
    policyType string

    The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

    The default is EBS_SNAPSHOT_MANAGEMENT.

    resourceLocations string[]
    [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in a Region, specify CLOUD.
    resourceType string
    [Default policies only] Specify the type of default policy to create.

    • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
    • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    resourceTypes string[]
    [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
    retainInterval number

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

    Default: 7

    schedules LifecyclePolicySchedule[]
    [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules -- one mandatory schedule and up to three optional schedules.
    targetTags LifecyclePolicyTag[]
    [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
    actions Sequence[LifecyclePolicyAction]
    [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
    copy_tags bool

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

    Default: false

    create_interval int

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

    Default: 1

    cross_region_copy_targets Sequence[LifecyclePolicyCrossRegionCopyTarget]
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    event_source LifecyclePolicyEventSource
    [Event-based policies only] The event that activates the event-based policy.
    exclusions LifecyclePolicyExclusions
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    extend_deletion bool

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    Default: false

    parameters LifecyclePolicyParameters

    [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

    If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

    policy_language str
    The type of policy to create. Specify one of the following:

    • SIMPLIFIED -- To create a default policy.
    • STANDARD -- To create a custom policy.
    policy_type str

    The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

    The default is EBS_SNAPSHOT_MANAGEMENT.

    resource_locations Sequence[str]
    [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in a Region, specify CLOUD.
    resource_type str
    [Default policies only] Specify the type of default policy to create.

    • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
    • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    resource_types Sequence[str]
    [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
    retain_interval int

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

    Default: 7

    schedules Sequence[LifecyclePolicySchedule]
    [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules -- one mandatory schedule and up to three optional schedules.
    target_tags Sequence[LifecyclePolicyTag]
    [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
    actions List<Property Map>
    [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
    copyTags Boolean

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

    Default: false

    createInterval Number

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

    Default: 1

    crossRegionCopyTargets List<Property Map>
    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    eventSource Property Map
    [Event-based policies only] The event that activates the event-based policy.
    exclusions Property Map
    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
    extendDeletion Boolean

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    Default: false

    parameters Property Map

    [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

    If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

    policyLanguage String
    The type of policy to create. Specify one of the following:

    • SIMPLIFIED -- To create a default policy.
    • STANDARD -- To create a custom policy.
    policyType String

    The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

    The default is EBS_SNAPSHOT_MANAGEMENT.

    resourceLocations List<String>
    [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in a Region, specify CLOUD.
    resourceType String
    [Default policies only] Specify the type of default policy to create.

    • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
    • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    resourceTypes List<String>
    [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
    retainInterval Number

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

    Default: 7

    schedules List<Property Map>
    [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules -- one mandatory schedule and up to three optional schedules.
    targetTags List<Property Map>
    [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

    LifecyclePolicyRetainRule

    Count int
    The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    Interval int
    The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    IntervalUnit string
    The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    Count int
    The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    Interval int
    The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    IntervalUnit string
    The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    count number
    The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    interval number
    The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    interval_unit string
    The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    count Integer
    The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    interval Integer
    The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit String
    The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    count number
    The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    interval number
    The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit string
    The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    count int
    The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    interval int
    The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    interval_unit str
    The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    count Number
    The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
    interval Number
    The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
    intervalUnit String
    The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.

    LifecyclePolicyRetentionArchiveTier

    Count int
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days.
    Interval int
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    IntervalUnit string
    The unit of time in which to measure the Interval. For example, to retain snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    Count int
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days.
    Interval int
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    IntervalUnit string
    The unit of time in which to measure the Interval. For example, to retain snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    count number
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days.
    interval number
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    interval_unit string
    The unit of time in which to measure the Interval. For example, to retain snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    count Integer
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days.
    interval Integer
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    intervalUnit String
    The unit of time in which to measure the Interval. For example, to retain snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    count number
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days.
    interval number
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    intervalUnit string
    The unit of time in which to measure the Interval. For example, to retain snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    count int
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days.
    interval int
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    interval_unit str
    The unit of time in which to measure the Interval. For example, to retain snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    count Number
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days.
    interval Number
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    intervalUnit String
    The unit of time in which to measure the Interval. For example, to retain snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.

    LifecyclePolicySchedule

    ArchiveRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyArchiveRule

    [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

    For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

    CopyTags bool
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    CreateRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyCreateRule
    The creation rule.
    CrossRegionCopyRules List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyCrossRegionCopyRule>
    Specifies a rule for copying snapshots or AMIs across Regions.
    DeprecateRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for the schedule.
    FastRestoreRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyFastRestoreRule
    [Custom snapshot policies only] The rule for enabling fast snapshot restore.
    Name string
    The name of the schedule.
    RetainRule Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyRetainRule
    The retention rule for snapshots or AMIs created by the policy.
    ShareRules List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyShareRule>
    [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.
    TagsToAdd List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyTag>
    The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
    VariableTags List<Pulumi.AwsNative.Dlm.Inputs.LifecyclePolicyTag>
    [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management -- Instance policies.
    ArchiveRule LifecyclePolicyArchiveRule

    [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

    For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

    CopyTags bool
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    CreateRule LifecyclePolicyCreateRule
    The creation rule.
    CrossRegionCopyRules []LifecyclePolicyCrossRegionCopyRule
    Specifies a rule for copying snapshots or AMIs across Regions.
    DeprecateRule LifecyclePolicyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for the schedule.
    FastRestoreRule LifecyclePolicyFastRestoreRule
    [Custom snapshot policies only] The rule for enabling fast snapshot restore.
    Name string
    The name of the schedule.
    RetainRule LifecyclePolicyRetainRule
    The retention rule for snapshots or AMIs created by the policy.
    ShareRules []LifecyclePolicyShareRule
    [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.
    TagsToAdd []LifecyclePolicyTag
    The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
    VariableTags []LifecyclePolicyTag
    [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management -- Instance policies.
    archive_rule object

    [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

    For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

    copy_tags bool
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    create_rule object
    The creation rule.
    cross_region_copy_rules list(object)
    Specifies a rule for copying snapshots or AMIs across Regions.
    deprecate_rule object
    [Custom AMI policies only] The AMI deprecation rule for the schedule.
    fast_restore_rule object
    [Custom snapshot policies only] The rule for enabling fast snapshot restore.
    name string
    The name of the schedule.
    retain_rule object
    The retention rule for snapshots or AMIs created by the policy.
    share_rules list(object)
    [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.
    tags_to_add list(object)
    The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
    variable_tags list(object)
    [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management -- Instance policies.
    archiveRule LifecyclePolicyArchiveRule

    [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

    For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

    copyTags Boolean
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    createRule LifecyclePolicyCreateRule
    The creation rule.
    crossRegionCopyRules List<LifecyclePolicyCrossRegionCopyRule>
    Specifies a rule for copying snapshots or AMIs across Regions.
    deprecateRule LifecyclePolicyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for the schedule.
    fastRestoreRule LifecyclePolicyFastRestoreRule
    [Custom snapshot policies only] The rule for enabling fast snapshot restore.
    name String
    The name of the schedule.
    retainRule LifecyclePolicyRetainRule
    The retention rule for snapshots or AMIs created by the policy.
    shareRules List<LifecyclePolicyShareRule>
    [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.
    tagsToAdd List<LifecyclePolicyTag>
    The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
    variableTags List<LifecyclePolicyTag>
    [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management -- Instance policies.
    archiveRule LifecyclePolicyArchiveRule

    [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

    For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

    copyTags boolean
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    createRule LifecyclePolicyCreateRule
    The creation rule.
    crossRegionCopyRules LifecyclePolicyCrossRegionCopyRule[]
    Specifies a rule for copying snapshots or AMIs across Regions.
    deprecateRule LifecyclePolicyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for the schedule.
    fastRestoreRule LifecyclePolicyFastRestoreRule
    [Custom snapshot policies only] The rule for enabling fast snapshot restore.
    name string
    The name of the schedule.
    retainRule LifecyclePolicyRetainRule
    The retention rule for snapshots or AMIs created by the policy.
    shareRules LifecyclePolicyShareRule[]
    [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.
    tagsToAdd LifecyclePolicyTag[]
    The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
    variableTags LifecyclePolicyTag[]
    [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management -- Instance policies.
    archive_rule LifecyclePolicyArchiveRule

    [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

    For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

    copy_tags bool
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    create_rule LifecyclePolicyCreateRule
    The creation rule.
    cross_region_copy_rules Sequence[LifecyclePolicyCrossRegionCopyRule]
    Specifies a rule for copying snapshots or AMIs across Regions.
    deprecate_rule LifecyclePolicyDeprecateRule
    [Custom AMI policies only] The AMI deprecation rule for the schedule.
    fast_restore_rule LifecyclePolicyFastRestoreRule
    [Custom snapshot policies only] The rule for enabling fast snapshot restore.
    name str
    The name of the schedule.
    retain_rule LifecyclePolicyRetainRule
    The retention rule for snapshots or AMIs created by the policy.
    share_rules Sequence[LifecyclePolicyShareRule]
    [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.
    tags_to_add Sequence[LifecyclePolicyTag]
    The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
    variable_tags Sequence[LifecyclePolicyTag]
    [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management -- Instance policies.
    archiveRule Property Map

    [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

    For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

    copyTags Boolean
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    createRule Property Map
    The creation rule.
    crossRegionCopyRules List<Property Map>
    Specifies a rule for copying snapshots or AMIs across Regions.
    deprecateRule Property Map
    [Custom AMI policies only] The AMI deprecation rule for the schedule.
    fastRestoreRule Property Map
    [Custom snapshot policies only] The rule for enabling fast snapshot restore.
    name String
    The name of the schedule.
    retainRule Property Map
    The retention rule for snapshots or AMIs created by the policy.
    shareRules List<Property Map>
    [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.
    tagsToAdd List<Property Map>
    The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
    variableTags List<Property Map>
    [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management -- Instance policies.

    LifecyclePolicyScript

    ExecuteOperationOnScriptFailure bool

    Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

    • To default to crash consistent snapshot if the pre script fails, specify true.
    • To skip the instance for snapshot creation if the pre script fails, specify false.

    This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

    Default: true

    ExecutionHandler string

    The SSM document that includes the pre and/or post scripts to run.

    If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

    If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

    ExecutionHandlerService string

    Indicates the service used to execute the pre and/or post scripts.

    Default: AWS_SYSTEMS_MANAGER

    ExecutionTimeout int

    Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

    Default: 10

    MaximumRetryCount int

    Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

    If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

    If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

    If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

    Default: 0

    Stages List<string>

    Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

    • To run a pre script only, specify PRE.
    • To run a post script only, specify POST.
    • To run both pre and post scripts, specify both PRE and POST.

    Default: PRE and POST

    ExecuteOperationOnScriptFailure bool

    Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

    • To default to crash consistent snapshot if the pre script fails, specify true.
    • To skip the instance for snapshot creation if the pre script fails, specify false.

    This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

    Default: true

    ExecutionHandler string

    The SSM document that includes the pre and/or post scripts to run.

    If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

    If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

    ExecutionHandlerService string

    Indicates the service used to execute the pre and/or post scripts.

    Default: AWS_SYSTEMS_MANAGER

    ExecutionTimeout int

    Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

    Default: 10

    MaximumRetryCount int

    Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

    If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

    If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

    If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

    Default: 0

    Stages []string

    Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

    • To run a pre script only, specify PRE.
    • To run a post script only, specify POST.
    • To run both pre and post scripts, specify both PRE and POST.

    Default: PRE and POST

    execute_operation_on_script_failure bool

    Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

    • To default to crash consistent snapshot if the pre script fails, specify true.
    • To skip the instance for snapshot creation if the pre script fails, specify false.

    This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

    Default: true

    execution_handler string

    The SSM document that includes the pre and/or post scripts to run.

    If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

    If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

    execution_handler_service string

    Indicates the service used to execute the pre and/or post scripts.

    Default: AWS_SYSTEMS_MANAGER

    execution_timeout number

    Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

    Default: 10

    maximum_retry_count number

    Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

    If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

    If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

    If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

    Default: 0

    stages list(string)

    Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

    • To run a pre script only, specify PRE.
    • To run a post script only, specify POST.
    • To run both pre and post scripts, specify both PRE and POST.

    Default: PRE and POST

    executeOperationOnScriptFailure Boolean

    Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

    • To default to crash consistent snapshot if the pre script fails, specify true.
    • To skip the instance for snapshot creation if the pre script fails, specify false.

    This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

    Default: true

    executionHandler String

    The SSM document that includes the pre and/or post scripts to run.

    If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

    If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

    executionHandlerService String

    Indicates the service used to execute the pre and/or post scripts.

    Default: AWS_SYSTEMS_MANAGER

    executionTimeout Integer

    Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

    Default: 10

    maximumRetryCount Integer

    Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

    If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

    If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

    If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

    Default: 0

    stages List<String>

    Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

    • To run a pre script only, specify PRE.
    • To run a post script only, specify POST.
    • To run both pre and post scripts, specify both PRE and POST.

    Default: PRE and POST

    executeOperationOnScriptFailure boolean

    Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

    • To default to crash consistent snapshot if the pre script fails, specify true.
    • To skip the instance for snapshot creation if the pre script fails, specify false.

    This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

    Default: true

    executionHandler string

    The SSM document that includes the pre and/or post scripts to run.

    If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

    If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

    executionHandlerService string

    Indicates the service used to execute the pre and/or post scripts.

    Default: AWS_SYSTEMS_MANAGER

    executionTimeout number

    Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

    Default: 10

    maximumRetryCount number

    Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

    If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

    If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

    If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

    Default: 0

    stages string[]

    Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

    • To run a pre script only, specify PRE.
    • To run a post script only, specify POST.
    • To run both pre and post scripts, specify both PRE and POST.

    Default: PRE and POST

    execute_operation_on_script_failure bool

    Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

    • To default to crash consistent snapshot if the pre script fails, specify true.
    • To skip the instance for snapshot creation if the pre script fails, specify false.

    This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

    Default: true

    execution_handler str

    The SSM document that includes the pre and/or post scripts to run.

    If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

    If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

    execution_handler_service str

    Indicates the service used to execute the pre and/or post scripts.

    Default: AWS_SYSTEMS_MANAGER

    execution_timeout int

    Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

    Default: 10

    maximum_retry_count int

    Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

    If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

    If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

    If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

    Default: 0

    stages Sequence[str]

    Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

    • To run a pre script only, specify PRE.
    • To run a post script only, specify POST.
    • To run both pre and post scripts, specify both PRE and POST.

    Default: PRE and POST

    executeOperationOnScriptFailure Boolean

    Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

    • To default to crash consistent snapshot if the pre script fails, specify true.
    • To skip the instance for snapshot creation if the pre script fails, specify false.

    This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

    Default: true

    executionHandler String

    The SSM document that includes the pre and/or post scripts to run.

    If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

    If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

    executionHandlerService String

    Indicates the service used to execute the pre and/or post scripts.

    Default: AWS_SYSTEMS_MANAGER

    executionTimeout Number

    Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

    Default: 10

    maximumRetryCount Number

    Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

    If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

    If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

    If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

    Default: 0

    stages List<String>

    Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

    • To run a pre script only, specify PRE.
    • To run a post script only, specify POST.
    • To run both pre and post scripts, specify both PRE and POST.

    Default: PRE and POST

    LifecyclePolicyShareRule

    TargetAccounts List<string>
    The IDs of the AWS accounts with which to share the snapshots.
    UnshareInterval int
    The period after which snapshots that are shared with other AWS accounts are automatically unshared.
    UnshareIntervalUnit string
    The unit of time for the automatic unsharing interval.
    TargetAccounts []string
    The IDs of the AWS accounts with which to share the snapshots.
    UnshareInterval int
    The period after which snapshots that are shared with other AWS accounts are automatically unshared.
    UnshareIntervalUnit string
    The unit of time for the automatic unsharing interval.
    target_accounts list(string)
    The IDs of the AWS accounts with which to share the snapshots.
    unshare_interval number
    The period after which snapshots that are shared with other AWS accounts are automatically unshared.
    unshare_interval_unit string
    The unit of time for the automatic unsharing interval.
    targetAccounts List<String>
    The IDs of the AWS accounts with which to share the snapshots.
    unshareInterval Integer
    The period after which snapshots that are shared with other AWS accounts are automatically unshared.
    unshareIntervalUnit String
    The unit of time for the automatic unsharing interval.
    targetAccounts string[]
    The IDs of the AWS accounts with which to share the snapshots.
    unshareInterval number
    The period after which snapshots that are shared with other AWS accounts are automatically unshared.
    unshareIntervalUnit string
    The unit of time for the automatic unsharing interval.
    target_accounts Sequence[str]
    The IDs of the AWS accounts with which to share the snapshots.
    unshare_interval int
    The period after which snapshots that are shared with other AWS accounts are automatically unshared.
    unshare_interval_unit str
    The unit of time for the automatic unsharing interval.
    targetAccounts List<String>
    The IDs of the AWS accounts with which to share the snapshots.
    unshareInterval Number
    The period after which snapshots that are shared with other AWS accounts are automatically unshared.
    unshareIntervalUnit String
    The unit of time for the automatic unsharing interval.

    LifecyclePolicyTag

    Key string
    The tag key.
    Value string
    The tag value.
    Key string
    The tag key.
    Value string
    The tag value.
    key string
    The tag key.
    value string
    The tag value.
    key String
    The tag key.
    value String
    The tag value.
    key string
    The tag key.
    value string
    The tag value.
    key str
    The tag key.
    value str
    The tag value.
    key String
    The tag key.
    value String
    The tag value.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.79.0
    published on Monday, Sep 14, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial