software.amazon.awssdk.services.dlm.model

Class PolicyDetails

java.lang.Object

software.amazon.awssdk.services.dlm.model.PolicyDetails

All Implemented Interfaces:

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

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

[All policy types] Specifies the configuration of a lifecycle policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PolicyDetails.Builder

Method Summary

Modifier and Type	Method and Description
List<Action>	actions() [Event-based policies only] The actions to be performed when the event-based policy is activated.
static PolicyDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventSource	eventSource() [Event-based policies only] The event that activates the event-based policy.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActions() For responses, this returns true if the service returned a value for the Actions property.
int	hashCode()
boolean	hasResourceLocations() For responses, this returns true if the service returned a value for the ResourceLocations property.
boolean	hasResourceTypes() For responses, this returns true if the service returned a value for the ResourceTypes property.
boolean	hasSchedules() For responses, this returns true if the service returned a value for the Schedules property.
boolean	hasTargetTags() For responses, this returns true if the service returned a value for the TargetTags property.
Parameters	parameters() [Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
PolicyTypeValues	policyType() [All policy types] The valid target resource types and actions a policy can manage.
String	policyTypeAsString() [All policy types] The valid target resource types and actions a policy can manage.
List<ResourceLocationValues>	resourceLocations() [Snapshot and AMI policies only] The location of the resources to backup.
List<String>	resourceLocationsAsStrings() [Snapshot and AMI policies only] The location of the resources to backup.
List<ResourceTypeValues>	resourceTypes() [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
List<String>	resourceTypesAsStrings() [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
List<Schedule>	schedules() [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
List<SdkField<?>>	sdkFields()
static Class<? extends PolicyDetails.Builder>	serializableBuilderClass()
List<Tag>	targetTags() [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
PolicyDetails.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

policyType

public final PolicyTypeValues policyType()

[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

Returns:

[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

See Also:

PolicyTypeValues

policyTypeAsString

public final String policyTypeAsString()

[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

Returns:

[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

See Also:

PolicyTypeValues

resourceTypes

public final List<ResourceTypeValues> resourceTypes()

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

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 hasResourceTypes() method.

Returns:

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

hasResourceTypes

public final boolean hasResourceTypes()

For responses, this returns true if the service returned a value for the ResourceTypes 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.

resourceTypesAsStrings

public final List<String> resourceTypesAsStrings()

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

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 hasResourceTypes() method.

Returns:

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

resourceLocations

public final List<ResourceLocationValues> resourceLocations()

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

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 hasResourceLocations() method.

Returns:

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

hasResourceLocations

public final boolean hasResourceLocations()

For responses, this returns true if the service returned a value for the ResourceLocations 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.

resourceLocationsAsStrings

public final List<String> resourceLocationsAsStrings()

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

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 hasResourceLocations() method.

Returns:

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

hasTargetTags

public final boolean hasTargetTags()

For responses, this returns true if the service returned a value for the TargetTags 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.

targetTags

public final List<Tag> targetTags()

[Snapshot and AMI policies only] The single tag that identifies targeted resources for this 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 hasTargetTags() method.

Returns:

[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

hasSchedules

public final boolean hasSchedules()

For responses, this returns true if the service returned a value for the Schedules 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.

schedules

public final List<Schedule> schedules()

[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

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 hasSchedules() method.

Returns:

[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

parameters

public final Parameters parameters()

[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

Returns:

[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

eventSource

public final EventSource eventSource()

[Event-based policies only] The event that activates the event-based policy.

Returns:

[Event-based policies only] The event that activates the event-based policy.

hasActions

public final boolean hasActions()

For responses, this returns true if the service returned a value for the Actions 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.

actions

public final List<Action> actions()

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per 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 hasActions() method.

Returns:

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

toBuilder

public PolicyDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PolicyDetails.Builder,PolicyDetails>

builder

public static PolicyDetails.Builder builder()

serializableBuilderClass

public static Class<? extends PolicyDetails.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