RetentionArchiveTier (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dlm.model.RetentionArchiveTier

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RetentionArchiveTier
extends Object
implements Serializable, Cloneable, StructuredPojo
```
[Custom snapshot policies only] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.

The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.

For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RetentionArchiveTier()

Constructors
Constructor and Description
`RetentionArchiveTier()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RetentionArchiveTier`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getCount()` The maximum number of snapshots to retain in the archive storage tier for each volume.
`Integer`	`getInterval()` Specifies the period of time to retain snapshots in the archive tier.
`String`	`getIntervalUnit()` The unit of time in which to measure the Interval.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCount(Integer count)` The maximum number of snapshots to retain in the archive storage tier for each volume.
`void`	`setInterval(Integer interval)` Specifies the period of time to retain snapshots in the archive tier.
`void`	`setIntervalUnit(String intervalUnit)` The unit of time in which to measure the Interval.
`String`	`toString()` Returns a string representation of this object.
`RetentionArchiveTier`	`withCount(Integer count)` The maximum number of snapshots to retain in the archive storage tier for each volume.
`RetentionArchiveTier`	`withInterval(Integer interval)` Specifies the period of time to retain snapshots in the archive tier.
`RetentionArchiveTier`	`withIntervalUnit(RetentionIntervalUnitValues intervalUnit)` The unit of time in which to measure the Interval.
`RetentionArchiveTier`	`withIntervalUnit(String intervalUnit)` The unit of time in which to measure the Interval.

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

- Constructor Detail
  - RetentionArchiveTier
```
public RetentionArchiveTier()
```
- Method Detail
  - setCount
```
public void setCount(Integer count)
```
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
    
    Parameters:
    
    count - The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
  - getCount
```
public Integer getCount()
```
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
    
    Returns:
    
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
  - withCount
```
public RetentionArchiveTier withCount(Integer count)
```
    The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
    
    Parameters:
    
    count - The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInterval
```
public void setInterval(Integer interval)
```
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    
    Parameters:
    
    interval - Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
  - getInterval
```
public Integer getInterval()
```
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    
    Returns:
    
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
  - withInterval
```
public RetentionArchiveTier withInterval(Integer interval)
```
    Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    
    Parameters:
    
    interval - Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIntervalUnit
```
public void setIntervalUnit(String intervalUnit)
```
    The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    
    Parameters:
    
    intervalUnit - The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    
    See Also:
    
    RetentionIntervalUnitValues
  - getIntervalUnit
```
public String getIntervalUnit()
```
    The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    
    Returns:
    
    The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    
    See Also:
    
    RetentionIntervalUnitValues
  - withIntervalUnit
```
public RetentionArchiveTier withIntervalUnit(String intervalUnit)
```
    The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    
    Parameters:
    
    intervalUnit - The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RetentionIntervalUnitValues
  - withIntervalUnit
```
public RetentionArchiveTier withIntervalUnit(RetentionIntervalUnitValues intervalUnit)
```
    The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    
    Parameters:
    
    intervalUnit - The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RetentionIntervalUnitValues
  - 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 RetentionArchiveTier clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class RetentionArchiveTier

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RetentionArchiveTier

Method Detail

setCount

getCount

withCount

setInterval

getInterval

withInterval

setIntervalUnit

getIntervalUnit

withIntervalUnit

withIntervalUnit

toString

equals

hashCode

clone

marshall