JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.dlm.model

Class UpdateLifecyclePolicyRequest

    • Constructor Detail

      • UpdateLifecyclePolicyRequest

        public UpdateLifecyclePolicyRequest()
    • Method Detail

      • setPolicyId

        public void setPolicyId(String policyId)

        The identifier of the lifecycle policy.

        Parameters:
        policyId - The identifier of the lifecycle policy.
      • getPolicyId

        public String getPolicyId()

        The identifier of the lifecycle policy.

        Returns:
        The identifier of the lifecycle policy.
      • withPolicyId

        public UpdateLifecyclePolicyRequest withPolicyId(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.
      • setExecutionRoleArn

        public void setExecutionRoleArn(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.
      • getExecutionRoleArn

        public String getExecutionRoleArn()

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

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

        public UpdateLifecyclePolicyRequest withExecutionRoleArn(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.
      • setState

        public void setState(String state)

        The desired activation state of the lifecycle policy after creation.

        Parameters:
        state - The desired activation state of the lifecycle policy after creation.
        See Also:
        SettablePolicyStateValues
      • getState

        public String getState()

        The desired activation state of the lifecycle policy after creation.

        Returns:
        The desired activation state of the lifecycle policy after creation.
        See Also:
        SettablePolicyStateValues
      • withState

        public UpdateLifecyclePolicyRequest withState(String state)

        The desired activation state of the lifecycle policy after creation.

        Parameters:
        state - The desired activation state of the lifecycle policy after creation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SettablePolicyStateValues
      • setDescription

        public void setDescription(String description)

        A description of the lifecycle policy.

        Parameters:
        description - A description of the lifecycle policy.
      • getDescription

        public String getDescription()

        A description of the lifecycle policy.

        Returns:
        A description of the lifecycle policy.
      • withDescription

        public UpdateLifecyclePolicyRequest withDescription(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.
      • setPolicyDetails

        public void setPolicyDetails(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.
      • getPolicyDetails

        public PolicyDetails getPolicyDetails()

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

        Returns:
        The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
      • withPolicyDetails

        public UpdateLifecyclePolicyRequest withPolicyDetails(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.
      • setCreateInterval

        public void setCreateInterval(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.
      • getCreateInterval

        public Integer getCreateInterval()

        [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:
        [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.
      • withCreateInterval

        public UpdateLifecyclePolicyRequest withCreateInterval(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.
      • setRetainInterval

        public void setRetainInterval(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.
      • getRetainInterval

        public Integer getRetainInterval()

        [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:
        [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.
      • withRetainInterval

        public UpdateLifecyclePolicyRequest withRetainInterval(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.
      • setCopyTags

        public void setCopyTags(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.
      • getCopyTags

        public Boolean getCopyTags()

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

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

        public UpdateLifecyclePolicyRequest withCopyTags(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.
      • isCopyTags

        public Boolean isCopyTags()

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

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

        public void setExtendDeletion(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

      • getExtendDeletion

        public Boolean getExtendDeletion()

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

      • withExtendDeletion

        public UpdateLifecyclePolicyRequest withExtendDeletion(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.
      • isExtendDeletion

        public Boolean isExtendDeletion()

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

      • getCrossRegionCopyTargets

        public List<CrossRegionCopyTarget> getCrossRegionCopyTargets()

        [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:
        [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.
      • setCrossRegionCopyTargets

        public void setCrossRegionCopyTargets(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.
      • withCrossRegionCopyTargets

        public UpdateLifecyclePolicyRequest withCrossRegionCopyTargets(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.

        NOTE: This method appends the values to the existing list (if any). Use setCrossRegionCopyTargets(java.util.Collection) or withCrossRegionCopyTargets(java.util.Collection) if you want to override the existing values.

        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.
      • withCrossRegionCopyTargets

        public UpdateLifecyclePolicyRequest withCrossRegionCopyTargets(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.
      • setExclusions

        public void setExclusions(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.
      • getExclusions

        public Exclusions getExclusions()

        [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:
        [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.
      • withExclusions

        public UpdateLifecyclePolicyRequest withExclusions(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.
      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /