Interface UpdateLifecyclePolicyRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateLifecyclePolicyRequest.Builder,
,UpdateLifecyclePolicyRequest> DlmRequest.Builder
,SdkBuilder<UpdateLifecyclePolicyRequest.Builder,
,UpdateLifecyclePolicyRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateLifecyclePolicyRequest
-
Method Summary
Modifier and TypeMethodDescription[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.createInterval
(Integer createInterval) [Default policies only] Specifies how often the policy should run and create snapshots or AMIs.crossRegionCopyTargets
(Collection<CrossRegionCopyTarget> crossRegionCopyTargets) [Default policies only] Specifies destination Regions for snapshot or AMI copies.crossRegionCopyTargets
(Consumer<CrossRegionCopyTarget.Builder>... crossRegionCopyTargets) [Default policies only] Specifies destination Regions for snapshot or AMI copies.crossRegionCopyTargets
(CrossRegionCopyTarget... crossRegionCopyTargets) [Default policies only] Specifies destination Regions for snapshot or AMI copies.description
(String description) A description of the lifecycle policy.exclusions
(Consumer<Exclusions.Builder> exclusions) [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.exclusions
(Exclusions exclusions) [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.executionRoleArn
(String executionRoleArn) The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.policyDetails
(Consumer<PolicyDetails.Builder> policyDetails) The configuration of the lifecycle policy.policyDetails
(PolicyDetails policyDetails) The configuration of the lifecycle policy.The identifier of the lifecycle policy.retainInterval
(Integer retainInterval) [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.The desired activation state of the lifecycle policy after creation.state
(SettablePolicyStateValues state) The desired activation state of the lifecycle policy after creation.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.dlm.model.DlmRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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.
-
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:
-
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:
-
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
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.
-
policyDetails
default UpdateLifecyclePolicyRequest.Builder policyDetails(Consumer<PolicyDetails.Builder> policyDetails) The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
This is a convenience method that creates an instance of thePolicyDetails.Builder
avoiding the need to create one manually viaPolicyDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topolicyDetails(PolicyDetails)
.- Parameters:
policyDetails
- a consumer that will call methods onPolicyDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
[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
[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
[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.
-
crossRegionCopyTargets
UpdateLifecyclePolicyRequest.Builder crossRegionCopyTargets(Consumer<CrossRegionCopyTarget.Builder>... 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.
This is a convenience method that creates an instance of theCrossRegionCopyTarget.Builder
avoiding the need to create one manually viaCrossRegionCopyTarget.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocrossRegionCopyTargets(List<CrossRegionCopyTarget>)
.- Parameters:
crossRegionCopyTargets
- a consumer that will call methods onCrossRegionCopyTarget.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
This is a convenience method that creates an instance of theExclusions.Builder
avoiding the need to create one manually viaExclusions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexclusions(Exclusions)
.- Parameters:
exclusions
- a consumer that will call methods onExclusions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateLifecyclePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateLifecyclePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-