Class LifecyclePolicy

java.lang.Object
software.amazon.awssdk.services.imagebuilder.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>

The configuration details for a lifecycle policy resource.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the lifecycle policy resource.

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

    • name

      public final String name()

      The name of the lifecycle policy.

      Returns:
      The name of the lifecycle policy.

    • description

      public final String description()

      Optional description for the lifecycle policy.

      Returns:
      Optional description for the lifecycle policy.

    • status

      public final LifecyclePolicyStatus status()

      Indicates whether the lifecycle policy resource is enabled.

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

      Returns:
      Indicates whether the lifecycle policy resource is enabled.
      See Also:

    • statusAsString

      public final String statusAsString()

      Indicates whether the lifecycle policy resource is enabled.

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

      Returns:
      Indicates whether the lifecycle policy resource is enabled.
      See Also:

    • executionRole

      public final String executionRole()

      The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.

      Returns:
      The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.

    • resourceType

      public final LifecyclePolicyResourceType resourceType()

      The type of resources the lifecycle policy targets.

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

      Returns:
      The type of resources the lifecycle policy targets.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resources the lifecycle policy targets.

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

      Returns:
      The type of resources the lifecycle policy targets.
      See Also:

    • hasPolicyDetails

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

    • policyDetails

      public final List<LifecyclePolicyDetail> policyDetails()

      The configuration details for a lifecycle policy resource.

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

      Returns:
      The configuration details for a lifecycle policy resource.

    • resourceSelection

      public final LifecyclePolicyResourceSelection resourceSelection()

      Resource selection criteria used to run the lifecycle policy.

      Returns:
      Resource selection criteria used to run the lifecycle policy.

    • dateCreated

      public final Instant dateCreated()

      The timestamp when Image Builder created the lifecycle policy resource.

      Returns:
      The timestamp when Image Builder created the lifecycle policy resource.

    • dateUpdated

      public final Instant dateUpdated()

      The timestamp when Image Builder updated the lifecycle policy resource.

      Returns:
      The timestamp when Image Builder updated the lifecycle policy resource.

    • dateLastRun

      public final Instant dateLastRun()

      The timestamp for the last time Image Builder ran the lifecycle policy.

      Returns:
      The timestamp for the last time Image Builder ran 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()

      To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.

      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:
      To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.