Class UpdateLifecyclePolicyRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateLifecyclePolicyRequest.Builder,
UpdateLifecyclePolicyRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
copyTags()
[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.final Integer
[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.final List
<CrossRegionCopyTarget> [Default policies only] Specifies destination Regions for snapshot or AMI copies.final String
A description of the lifecycle policy.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Exclusions
[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.final String
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.final 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.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the CrossRegionCopyTargets property.final int
hashCode()
final PolicyDetails
The configuration of the lifecycle policy.final String
policyId()
The identifier of the lifecycle policy.final Integer
[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.static Class
<? extends UpdateLifecyclePolicyRequest.Builder> state()
The desired activation state of the lifecycle policy after creation.final String
The desired activation state of the lifecycle policy after creation.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
policyId
The identifier of the lifecycle policy.
- Returns:
- The identifier of the lifecycle policy.
-
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
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 returnSettablePolicyStateValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The desired activation state of the lifecycle policy after creation.
- See Also:
-
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 returnSettablePolicyStateValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The desired activation state of the lifecycle policy after creation.
- See Also:
-
description
A description of the lifecycle policy.
- Returns:
- A description of the lifecycle policy.
-
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
[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
[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
[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
[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 theisEmpty()
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
[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
[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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateLifecyclePolicyRequest.Builder,
UpdateLifecyclePolicyRequest> - Specified by:
toBuilder
in classDlmRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-