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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceLifecyclePolicy.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the lifecycle policy resource.static LifecyclePolicy.Builderbuilder()InstantdateCreated()The timestamp when Image Builder created the lifecycle policy resource.InstantdateLastRun()The timestamp for the last time Image Builder ran the lifecycle policy.InstantdateUpdated()The timestamp when Image Builder updated the lifecycle policy resource.Stringdescription()Optional description for the lifecycle policy.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexecutionRole()The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasPolicyDetails()For responses, this returns true if the service returned a value for the PolicyDetails property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringname()The name of the lifecycle policy.List<LifecyclePolicyDetail>policyDetails()The configuration details for a lifecycle policy resource.LifecyclePolicyResourceSelectionresourceSelection()Resource selection criteria used to run the lifecycle policy.LifecyclePolicyResourceTyperesourceType()The type of resources the lifecycle policy targets.StringresourceTypeAsString()The type of resources the lifecycle policy targets.List<SdkField<?>>sdkFields()static Class<? extends LifecyclePolicy.Builder>serializableBuilderClass()LifecyclePolicyStatusstatus()Indicates whether the lifecycle policy resource is enabled.StringstatusAsString()Indicates whether the lifecycle policy resource is enabled.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.LifecyclePolicy.BuildertoBuilder()StringtoString()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
-
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,
statuswill returnLifecyclePolicyStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Indicates whether the lifecycle policy resource is enabled.
- See Also:
LifecyclePolicyStatus
-
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,
statuswill returnLifecyclePolicyStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Indicates whether the lifecycle policy resource is enabled.
- See Also:
LifecyclePolicyStatus
-
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,
resourceTypewill returnLifecyclePolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- The type of resources the lifecycle policy targets.
- See Also:
LifecyclePolicyResourceType
-
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,
resourceTypewill returnLifecyclePolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- The type of resources the lifecycle policy targets.
- See Also:
LifecyclePolicyResourceType
-
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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>
-
builder
public static LifecyclePolicy.Builder builder()
-
serializableBuilderClass
public static Class<? extends LifecyclePolicy.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-