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

Class UpdateLifecyclePolicyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateLifecyclePolicyRequest
extends ImagebuilderRequest
implements ToCopyableBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateLifecyclePolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateLifecyclePolicyRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier you provide to ensure idempotency of the request.
String	description()	Optional description for the lifecycle policy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRole()	The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the lifecycle policy.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolicyDetails()	For responses, this returns true if the service returned a value for the PolicyDetails property.
String	lifecyclePolicyArn()	The Amazon Resource Name (ARN) of the lifecycle policy resource.
List<LifecyclePolicyDetail>	policyDetails()	The configuration details for a lifecycle policy resource.
LifecyclePolicyResourceSelection	resourceSelection()	Selection criteria for resources that the lifecycle policy applies to.
LifecyclePolicyResourceType	resourceType()	The type of image resource that the lifecycle policy applies to.
String	resourceTypeAsString()	The type of image resource that the lifecycle policy applies to.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateLifecyclePolicyRequest.Builder>	serializableBuilderClass()
LifecyclePolicyStatus	status()	Indicates whether the lifecycle policy resource is enabled.
String	statusAsString()	Indicates whether the lifecycle policy resource is enabled.
UpdateLifecyclePolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

lifecyclePolicyArn

public final String lifecyclePolicyArn()

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

Returns:

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

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:

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, 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:

LifecyclePolicyStatus

executionRole

public final String executionRole()

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the lifecycle policy.

Returns:

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the lifecycle policy.

resourceType

public final LifecyclePolicyResourceType resourceType()

The type of image 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 resource that the lifecycle policy applies to.

See Also:

LifecyclePolicyResourceType

resourceTypeAsString

public final String resourceTypeAsString()

The type of image 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 resource that the lifecycle policy applies to.

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

Selection criteria for resources that the lifecycle policy applies to.

Returns:

Selection criteria for resources that the lifecycle policy applies to.

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 UpdateLifecyclePolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>

Specified by:

toBuilder in class ImagebuilderRequest

builder

public static UpdateLifecyclePolicyRequest.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo