Package software.amazon.awssdk.services.dlm.model

Interface UpdateLifecyclePolicyRequest.Builder

    • Method Detail

      • policyId

        UpdateLifecyclePolicyRequest.Builder policyId​(String policyId)

        The identifier of the lifecycle policy.

        Parameters:
        policyId - The identifier of the lifecycle policy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionRoleArn

        UpdateLifecyclePolicyRequest.Builder executionRoleArn​(String executionRoleArn)

        The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

        Parameters:
        executionRoleArn - The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        UpdateLifecyclePolicyRequest.Builder description​(String description)

        A description of the lifecycle policy.

        Parameters:
        description - A description of the lifecycle policy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • policyDetails

        UpdateLifecyclePolicyRequest.Builder policyDetails​(PolicyDetails policyDetails)

        The configuration of the lifecycle policy. You cannot update the policy type or the resource type.

        Parameters:
        policyDetails - The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createInterval

        UpdateLifecyclePolicyRequest.Builder createInterval​(Integer createInterval)

        [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.

        Parameters:
        createInterval - [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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retainInterval

        UpdateLifecyclePolicyRequest.Builder retainInterval​(Integer retainInterval)

        [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.

        Parameters:
        retainInterval - [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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • copyTags

        UpdateLifecyclePolicyRequest.Builder copyTags​(Boolean copyTags)

        [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.

        Parameters:
        copyTags - [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • extendDeletion

        UpdateLifecyclePolicyRequest.Builder extendDeletion​(Boolean extendDeletion)

        [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.

        By default (ExtendDeletion=false):

        • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

        • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

        If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

        Default: false

        Parameters:
        extendDeletion - [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.

        By default (ExtendDeletion=false):

        • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

        • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

        If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

        Default: false

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • crossRegionCopyTargets

        UpdateLifecyclePolicyRequest.Builder crossRegionCopyTargets​(Collection<CrossRegionCopyTarget> crossRegionCopyTargets)

        [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.

        Parameters:
        crossRegionCopyTargets - [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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • crossRegionCopyTargets

        UpdateLifecyclePolicyRequest.Builder crossRegionCopyTargets​(CrossRegionCopyTarget... crossRegionCopyTargets)

        [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.

        Parameters:
        crossRegionCopyTargets - [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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exclusions

        UpdateLifecyclePolicyRequest.Builder exclusions​(Exclusions exclusions)

        [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.

        Parameters:
        exclusions - [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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.