Package software.amazon.awssdk.services.imagebuilder.model

Class CreateLifecyclePolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest
software.amazon.awssdk.services.imagebuilder.model.CreateLifecyclePolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateLifecyclePolicyRequest.Builder,CreateLifecyclePolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLifecyclePolicyRequest extends ImagebuilderRequest implements ToCopyableBuilder<CreateLifecyclePolicyRequest.Builder,CreateLifecyclePolicyRequest>

  • Method Details

    • name

      public final String name()

      The name of the lifecycle policy to create.

      Returns:
      The name of the lifecycle policy to create.

    • 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) for the IAM role you create that grants Image Builder access to run lifecycle actions.

      Returns:
      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.

    • resourceType

      public final LifecyclePolicyResourceType resourceType()

      The type of Image Builder resource that the lifecycle policy applies to.

      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 Image Builder resource that the lifecycle policy applies to.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of Image Builder resource that the lifecycle policy applies to.

      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 Image Builder resource that the lifecycle policy applies to.
      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()

      Configuration details for the lifecycle policy rules.

      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:
      Configuration details for the lifecycle policy rules.

    • resourceSelection

      public final LifecyclePolicyResourceSelection resourceSelection()

      Selection criteria for the resources that the lifecycle policy applies to.

      Returns:
      Selection criteria for the resources that the lifecycle policy applies to.

    • 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()

      Tags to apply to the 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 hasTags() method.

      Returns:
      Tags to apply to the lifecycle policy resource.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Returns:
      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

    • toBuilder

      public CreateLifecyclePolicyRequest.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<CreateLifecyclePolicyRequest.Builder,CreateLifecyclePolicyRequest>
      Specified by:
      toBuilder in class ImagebuilderRequest
      Returns:
      a builder for type T

    • builder

      public static CreateLifecyclePolicyRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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