Package software.amazon.awscdk.services.dlm

Class CfnLifecyclePolicyProps.Builder

java.lang.Object
software.amazon.awscdk.services.dlm.CfnLifecyclePolicyProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnLifecyclePolicyProps>
Enclosing interface:
CfnLifecyclePolicyProps
@Stability(Stable) public static final class CfnLifecyclePolicyProps.Builder extends Object implements software.amazon.jsii.Builder<CfnLifecyclePolicyProps>
A builder for CfnLifecyclePolicyProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copyTags

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder copyTags(Boolean copyTags)
      Sets the value of CfnLifecyclePolicyProps.getCopyTags()
      Parameters:
      copyTags - [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false .

      Default: false

      Returns:
      this

    • copyTags

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder copyTags(IResolvable copyTags)
      Sets the value of CfnLifecyclePolicyProps.getCopyTags()
      Parameters:
      copyTags - [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false .

      Default: false

      Returns:
      this

    • createInterval

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder createInterval(Number createInterval)
      Sets the value of CfnLifecyclePolicyProps.getCreateInterval()
      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. If you do not specify a value, the default is 1.

      Default: 1

      Returns:
      this

    • crossRegionCopyTargets

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder crossRegionCopyTargets(Object crossRegionCopyTargets)
      Sets the value of CfnLifecyclePolicyProps.getCrossRegionCopyTargets()
      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:
      this

    • defaultPolicy

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder defaultPolicy(String defaultPolicy)
      Sets the value of CfnLifecyclePolicyProps.getDefaultPolicy()
      Parameters:
      defaultPolicy - [Default policies only] Specify the type of default policy to create.
      • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME .
      • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE .
      Returns:
      this

    • description

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder description(String description)
      Sets the value of CfnLifecyclePolicyProps.getDescription()
      Parameters:
      description - A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
      Returns:
      this

    • exclusions

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder exclusions(IResolvable exclusions)
      Sets the value of CfnLifecyclePolicyProps.getExclusions()
      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:
      this

    • exclusions

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder exclusions(CfnLifecyclePolicy.ExclusionsProperty exclusions)
      Sets the value of CfnLifecyclePolicyProps.getExclusions()
      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:
      this

    • executionRoleArn

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder executionRoleArn(String executionRoleArn)
      Sets the value of CfnLifecyclePolicyProps.getExecutionRoleArn()
      Parameters:
      executionRoleArn - The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
      Returns:
      this

    • extendDeletion

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder extendDeletion(Boolean extendDeletion)
      Sets the value of CfnLifecyclePolicyProps.getExtendDeletion()
      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.

      If you do not specify a value, the default is false .

      Default: false

      Returns:
      this

    • extendDeletion

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder extendDeletion(IResolvable extendDeletion)
      Sets the value of CfnLifecyclePolicyProps.getExtendDeletion()
      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.

      If you do not specify a value, the default is false .

      Default: false

      Returns:
      this

    • policyDetails

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder policyDetails(IResolvable policyDetails)
      Sets the value of CfnLifecyclePolicyProps.getPolicyDetails()
      Parameters:
      policyDetails - The configuration details of the lifecycle policy.

      If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

      Returns:
      this

    • policyDetails

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder policyDetails(CfnLifecyclePolicy.PolicyDetailsProperty policyDetails)
      Sets the value of CfnLifecyclePolicyProps.getPolicyDetails()
      Parameters:
      policyDetails - The configuration details of the lifecycle policy.

      If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

      Returns:
      this

    • retainInterval

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder retainInterval(Number retainInterval)
      Sets the value of CfnLifecyclePolicyProps.getRetainInterval()
      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. If you do not specify a value, the default is 7.

      Default: 7

      Returns:
      this

    • state

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder state(String state)
      Sets the value of CfnLifecyclePolicyProps.getState()
      Parameters:
      state - The activation state of the lifecycle policy.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnLifecyclePolicyProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnLifecyclePolicyProps.getTags()
      Parameters:
      tags - The tags to apply to the lifecycle policy during creation.
      Returns:
      this

    • build

      @Stability(Stable) public CfnLifecyclePolicyProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnLifecyclePolicyProps>
      Returns:
      a new instance of CfnLifecyclePolicyProps
      Throws:
      NullPointerException - if any required attribute was not provided