CreateLifecyclePolicyRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.dlm.model.CreateLifecyclePolicyRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateLifecyclePolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateLifecyclePolicyRequest()

Constructors
Constructor and Description
`CreateLifecyclePolicyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateLifecyclePolicyRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreateLifecyclePolicyRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateLifecyclePolicyRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Boolean`	`getCopyTags()` [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
`Integer`	`getCreateInterval()` [Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
`List<CrossRegionCopyTarget>`	`getCrossRegionCopyTargets()` [Default policies only] Specifies destination Regions for snapshot or AMI copies.
`String`	`getDefaultPolicy()` [Default policies only] Specify the type of default policy to create.
`String`	`getDescription()` A description of the lifecycle policy.
`Exclusions`	`getExclusions()` [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.
`String`	`getExecutionRoleArn()` The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
`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.
`PolicyDetails`	`getPolicyDetails()` The configuration details of the lifecycle policy.
`Integer`	`getRetainInterval()` [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.
`String`	`getState()` The activation state of the lifecycle policy after creation.
`Map<String,String>`	`getTags()` The tags to apply to the lifecycle policy during creation.
`int`	`hashCode()`
`Boolean`	`isCopyTags()` [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
`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.
`void`	`setCopyTags(Boolean copyTags)` [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
`void`	`setCreateInterval(Integer createInterval)` [Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
`void`	`setCrossRegionCopyTargets(Collection<CrossRegionCopyTarget> crossRegionCopyTargets)` [Default policies only] Specifies destination Regions for snapshot or AMI copies.
`void`	`setDefaultPolicy(String defaultPolicy)` [Default policies only] Specify the type of default policy to create.
`void`	`setDescription(String description)` A description of the lifecycle policy.
`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.
`void`	`setExecutionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
`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.
`void`	`setPolicyDetails(PolicyDetails policyDetails)` The configuration details of the lifecycle policy.
`void`	`setRetainInterval(Integer retainInterval)` [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.
`void`	`setState(String state)` The activation state of the lifecycle policy after creation.
`void`	`setTags(Map<String,String> tags)` The tags to apply to the lifecycle policy during creation.
`String`	`toString()` Returns a string representation of this object.
`CreateLifecyclePolicyRequest`	`withCopyTags(Boolean copyTags)` [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
`CreateLifecyclePolicyRequest`	`withCreateInterval(Integer createInterval)` [Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
`CreateLifecyclePolicyRequest`	`withCrossRegionCopyTargets(Collection<CrossRegionCopyTarget> crossRegionCopyTargets)` [Default policies only] Specifies destination Regions for snapshot or AMI copies.
`CreateLifecyclePolicyRequest`	`withCrossRegionCopyTargets(CrossRegionCopyTarget... crossRegionCopyTargets)` [Default policies only] Specifies destination Regions for snapshot or AMI copies.
`CreateLifecyclePolicyRequest`	`withDefaultPolicy(DefaultPolicyTypeValues defaultPolicy)` [Default policies only] Specify the type of default policy to create.
`CreateLifecyclePolicyRequest`	`withDefaultPolicy(String defaultPolicy)` [Default policies only] Specify the type of default policy to create.
`CreateLifecyclePolicyRequest`	`withDescription(String description)` A description of the lifecycle policy.
`CreateLifecyclePolicyRequest`	`withExclusions(Exclusions exclusions)` [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.
`CreateLifecyclePolicyRequest`	`withExecutionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
`CreateLifecyclePolicyRequest`	`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.
`CreateLifecyclePolicyRequest`	`withPolicyDetails(PolicyDetails policyDetails)` The configuration details of the lifecycle policy.
`CreateLifecyclePolicyRequest`	`withRetainInterval(Integer retainInterval)` [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.
`CreateLifecyclePolicyRequest`	`withState(SettablePolicyStateValues state)` The activation state of the lifecycle policy after creation.
`CreateLifecyclePolicyRequest`	`withState(String state)` The activation state of the lifecycle policy after creation.
`CreateLifecyclePolicyRequest`	`withTags(Map<String,String> tags)` The tags to apply to the lifecycle policy during creation.

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

- Constructor Detail
  - CreateLifecyclePolicyRequest
```
public CreateLifecyclePolicyRequest()
```
- Method Detail
  - 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 CreateLifecyclePolicyRequest 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.
  - setDescription
```
public void setDescription(String description)
```
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    
    Parameters:
    
    description - A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
  - getDescription
```
public String getDescription()
```
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    
    Returns:
    
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
  - withDescription
```
public CreateLifecyclePolicyRequest withDescription(String description)
```
    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    
    Parameters:
    
    description - A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The activation state of the lifecycle policy after creation.
    
    Parameters:
    
    state - The activation state of the lifecycle policy after creation.
    
    See Also:
    
    SettablePolicyStateValues
  - getState
```
public String getState()
```
    The activation state of the lifecycle policy after creation.
    
    Returns:
    
    The activation state of the lifecycle policy after creation.
    
    See Also:
    
    SettablePolicyStateValues
  - withState
```
public CreateLifecyclePolicyRequest withState(String state)
```
    The activation state of the lifecycle policy after creation.
    
    Parameters:
    
    state - The 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
  - withState
```
public CreateLifecyclePolicyRequest withState(SettablePolicyStateValues state)
```
    The activation state of the lifecycle policy after creation.
    
    Parameters:
    
    state - The 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
  - setPolicyDetails
```
public void setPolicyDetails(PolicyDetails 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.
    
    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.
  - getPolicyDetails
```
public PolicyDetails getPolicyDetails()
```
    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:
    
    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.
  - withPolicyDetails
```
public CreateLifecyclePolicyRequest withPolicyDetails(PolicyDetails 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags to apply to the lifecycle policy during creation.
    
    Returns:
    
    The tags to apply to the lifecycle policy during creation.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags to apply to the lifecycle policy during creation.
    
    Parameters:
    
    tags - The tags to apply to the lifecycle policy during creation.
  - withTags
```
public CreateLifecyclePolicyRequest withTags(Map<String,String> tags)
```
    The tags to apply to the lifecycle policy during creation.
    
    Parameters:
    
    tags - The tags to apply to the lifecycle policy during creation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateLifecyclePolicyRequest addTagsEntry(String key,
                                                 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateLifecyclePolicyRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultPolicy
```
public void setDefaultPolicy(String 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.
    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.
    See Also:
    
    DefaultPolicyTypeValues
  - getDefaultPolicy
```
public String getDefaultPolicy()
```
    [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:
    [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.
    See Also:
    
    DefaultPolicyTypeValues
  - withDefaultPolicy
```
public CreateLifecyclePolicyRequest withDefaultPolicy(String 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.
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DefaultPolicyTypeValues
  - withDefaultPolicy
```
public CreateLifecyclePolicyRequest withDefaultPolicy(DefaultPolicyTypeValues 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.
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DefaultPolicyTypeValues
  - 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. If you do not specify a value, the default is 1.
    
    Default: 1
    
    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
  - 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. If you do not specify a value, the default is 1.
    
    Default: 1
    
    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. If you do not specify a value, the default is 1.
    
    Default: 1
  - withCreateInterval
```
public CreateLifecyclePolicyRequest 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. If you do not specify a value, the default is 1.
    
    Default: 1
    
    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:
    
    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. If you do not specify a value, the default is 7.
    
    Default: 7
    
    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
  - 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. If you do not specify a value, the default is 7.
    
    Default: 7
    
    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. If you do not specify a value, the default is 7.
    
    Default: 7
  - withRetainInterval
```
public CreateLifecyclePolicyRequest 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. If you do not specify a value, the default is 7.
    
    Default: 7
    
    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:
    
    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. If you do not specify a value, the default is false.
    
    Default: false
    
    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
  - getCopyTags
```
public Boolean getCopyTags()
```
    [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:
    
    [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
  - withCopyTags
```
public CreateLifecyclePolicyRequest withCopyTags(Boolean 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
    
    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:
    
    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. If you do not specify a value, the default is false.
    
    Default: false
    
    Returns:
    
    [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
  - 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.
    
    If you do not specify a value, the default is false.
    
    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.
    
    If you do not specify a value, the default is false.
    
    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.
    
    If you do not specify a value, the default is false.
    
    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.
    
    If you do not specify a value, the default is false.
    
    Default: false
  - withExtendDeletion
```
public CreateLifecyclePolicyRequest 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.
    
    If you do not specify a value, the default is false.
    
    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.
    
    If you do not specify a value, the default is false.
    
    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.
    
    If you do not specify a value, the default is false.
    
    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.
    
    If you do not specify a value, the default is false.
    
    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 CreateLifecyclePolicyRequest 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 CreateLifecyclePolicyRequest 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 CreateLifecyclePolicyRequest 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateLifecyclePolicyRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.619

Class CreateLifecyclePolicyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateLifecyclePolicyRequest

Method Detail

setExecutionRoleArn

getExecutionRoleArn

withExecutionRoleArn

setDescription

getDescription

withDescription

setState

getState

withState

withState

setPolicyDetails

getPolicyDetails

withPolicyDetails

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setDefaultPolicy

getDefaultPolicy

withDefaultPolicy

withDefaultPolicy

setCreateInterval

getCreateInterval

withCreateInterval

setRetainInterval

getRetainInterval

withRetainInterval

setCopyTags

getCopyTags

withCopyTags

isCopyTags

setExtendDeletion

getExtendDeletion

withExtendDeletion

isExtendDeletion

getCrossRegionCopyTargets

setCrossRegionCopyTargets

withCrossRegionCopyTargets

withCrossRegionCopyTargets

setExclusions

getExclusions

withExclusions

toString

equals

hashCode

clone