java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.dlm.model.DlmRequest
    - - software.amazon.awssdk.services.dlm.model.UpdateLifecyclePolicyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateLifecyclePolicyRequest
extends DlmRequest
implements ToCopyableBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateLifecyclePolicyRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateLifecyclePolicyRequest.Builder`	`builder()`
`Boolean`	`copyTags()`	[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
`Integer`	`createInterval()`	[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
`List<CrossRegionCopyTarget>`	`crossRegionCopyTargets()`	[Default policies only] Specifies destination Regions for snapshot or AMI copies.
`String`	`description()`	A description of the lifecycle policy.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Exclusions`	`exclusions()`	[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.
`String`	`executionRoleArn()`	The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
`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.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCrossRegionCopyTargets()`	For responses, this returns true if the service returned a value for the CrossRegionCopyTargets property.
`int`	`hashCode()`
`PolicyDetails`	`policyDetails()`	The configuration of the lifecycle policy.
`String`	`policyId()`	The identifier of the lifecycle policy.
`Integer`	`retainInterval()`	[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateLifecyclePolicyRequest.Builder>`	`serializableBuilderClass()`
`SettablePolicyStateValues`	`state()`	The desired activation state of the lifecycle policy after creation.
`String`	`stateAsString()`	The desired activation state of the lifecycle policy after creation.
`UpdateLifecyclePolicyRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - policyId
```
public final String policyId()
```
    The identifier of the lifecycle policy.
    
    Returns:
    
    The identifier of the lifecycle policy.
  - executionRoleArn
```
public final String executionRoleArn()
```
    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.
  - state
```
public final SettablePolicyStateValues state()
```
    The desired activation state of the lifecycle policy after creation.
    
    If the service returns an enum value that is not available in the current SDK version, state will return SettablePolicyStateValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The desired activation state of the lifecycle policy after creation.
    
    See Also:
    
    SettablePolicyStateValues
  - stateAsString
```
public final String stateAsString()
```
    The desired activation state of the lifecycle policy after creation.
    
    If the service returns an enum value that is not available in the current SDK version, state will return SettablePolicyStateValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The desired activation state of the lifecycle policy after creation.
    
    See Also:
    
    SettablePolicyStateValues
  - description
```
public final String description()
```
    A description of the lifecycle policy.
    
    Returns:
    
    A description of the lifecycle policy.
  - policyDetails
```
public final PolicyDetails policyDetails()
```
    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.
  - createInterval
```
public final 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.
    
    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.
  - retainInterval
```
public final 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.
    
    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.
  - copyTags
```
public final Boolean copyTags()
```
    [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.
  - extendDeletion
```
public final 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
    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
  - hasCrossRegionCopyTargets
```
public final boolean hasCrossRegionCopyTargets()
```
    For responses, this returns true if the service returned a value for the CrossRegionCopyTargets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - crossRegionCopyTargets
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCrossRegionCopyTargets() method.
    
    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.
  - exclusions
```
public final 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.
    
    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.
  - toBuilder
```
public UpdateLifecyclePolicyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>
    
    Specified by:
    
    toBuilder in class DlmRequest
  - builder
```
public static UpdateLifecyclePolicyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateLifecyclePolicyRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateLifecyclePolicyRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

policyId

executionRoleArn

state

stateAsString

description

policyDetails

createInterval

retainInterval

copyTags

extendDeletion

hasCrossRegionCopyTargets

crossRegionCopyTargets

exclusions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields