Class LifecyclePolicy

java.lang.Object
software.amazon.awssdk.services.dlm.model.LifecyclePolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>
@Generated("software.amazon.awssdk:codegen") public final class LifecyclePolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>

[Custom policies only] Detailed information about a snapshot, AMI, or event-based lifecycle policy.

See Also:

  • Method Details

    • policyId

      public final String policyId()

      The identifier of the lifecycle policy.

      Returns:
      The identifier of the lifecycle policy.

    • description

      public final String description()

      The description of the lifecycle policy.

      Returns:
      The description of the lifecycle policy.

    • state

      public final GettablePolicyStateValues state()

      The activation state of the lifecycle policy.

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

      Returns:
      The activation state of the lifecycle policy.
      See Also:

    • stateAsString

      public final String stateAsString()

      The activation state of the lifecycle policy.

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

      Returns:
      The activation state of the lifecycle policy.
      See Also:

    • statusMessage

      public final String statusMessage()

      The description of the status.

      Returns:
      The description of the status.

    • executionRoleArn

      public final String executionRoleArn()

      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.

    • dateCreated

      public final Instant dateCreated()

      The local date and time when the lifecycle policy was created.

      Returns:
      The local date and time when the lifecycle policy was created.

    • dateModified

      public final Instant dateModified()

      The local date and time when the lifecycle policy was last modified.

      Returns:
      The local date and time when the lifecycle policy was last modified.

    • policyDetails

      public final PolicyDetails policyDetails()

      The configuration of the lifecycle policy

      Returns:
      The configuration of the lifecycle policy

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The tags.

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

      Returns:
      The tags.

    • policyArn

      public final String policyArn()

      The Amazon Resource Name (ARN) of the policy.

      Returns:
      The Amazon Resource Name (ARN) of the policy.

    • defaultPolicy

      public final Boolean defaultPolicy()

      [Default policies only] The type of default policy. Values include:

      • VOLUME - Default policy for EBS snapshots

      • INSTANCE - Default policy for EBS-backed AMIs

      Returns:
      [Default policies only] The type of default policy. Values include:

      • VOLUME - Default policy for EBS snapshots

      • INSTANCE - Default policy for EBS-backed AMIs

    • toBuilder

      public LifecyclePolicy.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>
      Returns:
      a builder for type T

    • builder

      public static LifecyclePolicy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LifecyclePolicy.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.