software.amazon.awssdk.services.dlm.model

Class Parameters

java.lang.Object

software.amazon.awssdk.services.dlm.model.Parameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Parameters.Builder,Parameters>

@Generated(value="software.amazon.awssdk:codegen")
public final class Parameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Parameters.Builder,Parameters>

[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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Parameters.Builder

Method Summary

Modifier and Type	Method and Description
static Parameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	excludeBootVolume() [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.
List<Tag>	excludeDataVolumeTags() [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExcludeDataVolumeTags() For responses, this returns true if the service returned a value for the ExcludeDataVolumeTags property.
int	hashCode()
Boolean	noReboot() [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.
List<SdkField<?>>	sdkFields()
static Class<? extends Parameters.Builder>	serializableBuilderClass()
Parameters.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

excludeBootVolume

public final 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.

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.

noReboot

public final 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).

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).

hasExcludeDataVolumeTags

public final boolean hasExcludeDataVolumeTags()

For responses, this returns true if the service returned a value for the ExcludeDataVolumeTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

excludeDataVolumeTags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludeDataVolumeTags() method.

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.

toBuilder

public Parameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Parameters.Builder,Parameters>

builder

public static Parameters.Builder builder()

serializableBuilderClass

public static Class<? extends Parameters.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo