Parameters (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Parameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
[Snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.

If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Parameters()

Constructors
Constructor and Description
`Parameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Parameters`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getExcludeBootVolume()` [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.
`List<Tag>`	`getExcludeDataVolumeTags()` [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
`Boolean`	`getNoReboot()` [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.
`int`	`hashCode()`
`Boolean`	`isExcludeBootVolume()` [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.
`Boolean`	`isNoReboot()` [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setExcludeBootVolume(Boolean excludeBootVolume)` [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.
`void`	`setExcludeDataVolumeTags(Collection<Tag> excludeDataVolumeTags)` [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
`void`	`setNoReboot(Boolean noReboot)` [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.
`String`	`toString()` Returns a string representation of this object.
`Parameters`	`withExcludeBootVolume(Boolean excludeBootVolume)` [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.
`Parameters`	`withExcludeDataVolumeTags(Collection<Tag> excludeDataVolumeTags)` [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
`Parameters`	`withExcludeDataVolumeTags(Tag... excludeDataVolumeTags)` [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
`Parameters`	`withNoReboot(Boolean noReboot)` [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.

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

- Constructor Detail
  - Parameters
```
public Parameters()
```
- Method Detail
  - setExcludeBootVolume
```
public void setExcludeBootVolume(Boolean excludeBootVolume)
```
    [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Parameters:
    
    excludeBootVolume - [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
  - getExcludeBootVolume
```
public Boolean getExcludeBootVolume()
```
    [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Returns:
    
    [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
  - withExcludeBootVolume
```
public Parameters withExcludeBootVolume(Boolean excludeBootVolume)
```
    [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Parameters:
    
    excludeBootVolume - [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludeBootVolume
```
public Boolean isExcludeBootVolume()
```
    [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Returns:
    
    [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
  - setNoReboot
```
public void setNoReboot(Boolean noReboot)
```
    [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
    
    Parameters:
    
    noReboot - [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
  - getNoReboot
```
public Boolean getNoReboot()
```
    [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
    
    Returns:
    
    [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
  - withNoReboot
```
public Parameters withNoReboot(Boolean noReboot)
```
    [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
    
    Parameters:
    
    noReboot - [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isNoReboot
```
public Boolean isNoReboot()
```
    [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
    
    Returns:
    
    [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
  - getExcludeDataVolumeTags
```
public List<Tag> getExcludeDataVolumeTags()
```
    [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
    
    If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Returns:
    
    [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
    
    If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
  - setExcludeDataVolumeTags
```
public void setExcludeDataVolumeTags(Collection<Tag> excludeDataVolumeTags)
```
    [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
    
    If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Parameters:
    
    excludeDataVolumeTags - [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
    
    If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
  - withExcludeDataVolumeTags
```
public Parameters withExcludeDataVolumeTags(Tag... excludeDataVolumeTags)
```
    [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
    
    If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    NOTE: This method appends the values to the existing list (if any). Use setExcludeDataVolumeTags(java.util.Collection) or withExcludeDataVolumeTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    excludeDataVolumeTags - [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
    
    If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludeDataVolumeTags
```
public Parameters withExcludeDataVolumeTags(Collection<Tag> excludeDataVolumeTags)
```
    [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
    
    If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    Parameters:
    
    excludeDataVolumeTags - [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
    
    If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
    
    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 Parameters 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.

Did this page help you?

Class Parameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Parameters

Method Detail

setExcludeBootVolume

getExcludeBootVolume

withExcludeBootVolume

isExcludeBootVolume

setNoReboot

getNoReboot

withNoReboot

isNoReboot

getExcludeDataVolumeTags

setExcludeDataVolumeTags

withExcludeDataVolumeTags

withExcludeDataVolumeTags

toString

equals

hashCode

clone

marshall