Interface UpdateLifecyclePolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>, ImagebuilderRequest.Builder, SdkBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateLifecyclePolicyRequest

@Mutable
@NotThreadSafe
public static interface UpdateLifecyclePolicyRequest.Builder
extends ImagebuilderRequest.Builder, SdkPojo, CopyableBuilder<UpdateLifecyclePolicyRequest.Builder,UpdateLifecyclePolicyRequest>

Method Summary

Modifier and Type	Method	Description
UpdateLifecyclePolicyRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time.
UpdateLifecyclePolicyRequest.Builder	description(String description)	Optional description for the lifecycle policy.
UpdateLifecyclePolicyRequest.Builder	executionRole(String executionRole)	The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.
UpdateLifecyclePolicyRequest.Builder	lifecyclePolicyArn(String lifecyclePolicyArn)	The Amazon Resource Name (ARN) of the lifecycle policy resource.
UpdateLifecyclePolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateLifecyclePolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateLifecyclePolicyRequest.Builder	policyDetails(Collection<LifecyclePolicyDetail> policyDetails)	The configuration details for a lifecycle policy resource.
UpdateLifecyclePolicyRequest.Builder	policyDetails(Consumer<LifecyclePolicyDetail.Builder>... policyDetails)	The configuration details for a lifecycle policy resource.
UpdateLifecyclePolicyRequest.Builder	policyDetails(LifecyclePolicyDetail... policyDetails)	The configuration details for a lifecycle policy resource.
default UpdateLifecyclePolicyRequest.Builder	resourceSelection(Consumer<LifecyclePolicyResourceSelection.Builder> resourceSelection)	Selection criteria for resources that the lifecycle policy applies to.
UpdateLifecyclePolicyRequest.Builder	resourceSelection(LifecyclePolicyResourceSelection resourceSelection)	Selection criteria for resources that the lifecycle policy applies to.
UpdateLifecyclePolicyRequest.Builder	resourceType(String resourceType)	The type of image resource that the lifecycle policy applies to.
UpdateLifecyclePolicyRequest.Builder	resourceType(LifecyclePolicyResourceType resourceType)	The type of image resource that the lifecycle policy applies to.
UpdateLifecyclePolicyRequest.Builder	status(String status)	Indicates whether the lifecycle policy resource is enabled.
UpdateLifecyclePolicyRequest.Builder	status(LifecyclePolicyStatus status)	Indicates whether the lifecycle policy resource is enabled.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

lifecyclePolicyArn

UpdateLifecyclePolicyRequest.Builder lifecyclePolicyArn(String lifecyclePolicyArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

description

UpdateLifecyclePolicyRequest.Builder description(String description)

Optional description for the lifecycle policy. Because the update replaces the entire configuration, omitting this property removes any existing description.

Parameters:

description - Optional description for the lifecycle policy. Because the update replaces the entire configuration, omitting this property removes any existing description.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

UpdateLifecyclePolicyRequest.Builder status(String status)

Indicates whether the lifecycle policy resource is enabled. Defaults to ENABLED when omitted, so updating a disabled policy without setting this property re-enables it.

Parameters:

status - Indicates whether the lifecycle policy resource is enabled. Defaults to ENABLED when omitted, so updating a disabled policy without setting this property re-enables it.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• LifecyclePolicyStatus
• LifecyclePolicyStatus

status

UpdateLifecyclePolicyRequest.Builder status(LifecyclePolicyStatus status)

Indicates whether the lifecycle policy resource is enabled. Defaults to ENABLED when omitted, so updating a disabled policy without setting this property re-enables it.

Parameters:

status - Indicates whether the lifecycle policy resource is enabled. Defaults to ENABLED when omitted, so updating a disabled policy without setting this property re-enables it.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• LifecyclePolicyStatus
• LifecyclePolicyStatus

executionRole

UpdateLifecyclePolicyRequest.Builder executionRole(String executionRole)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceType

UpdateLifecyclePolicyRequest.Builder resourceType(String resourceType)

The type of image resource that the lifecycle policy applies to. The value must match the policy's existing resource type. You can't change the resource type of an existing lifecycle policy.

Parameters:

resourceType - The type of image resource that the lifecycle policy applies to. The value must match the policy's existing resource type. You can't change the resource type of an existing lifecycle policy.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• LifecyclePolicyResourceType
• LifecyclePolicyResourceType

resourceType

UpdateLifecyclePolicyRequest.Builder resourceType(LifecyclePolicyResourceType resourceType)

The type of image resource that the lifecycle policy applies to. The value must match the policy's existing resource type. You can't change the resource type of an existing lifecycle policy.

Parameters:

resourceType - The type of image resource that the lifecycle policy applies to. The value must match the policy's existing resource type. You can't change the resource type of an existing lifecycle policy.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• LifecyclePolicyResourceType
• LifecyclePolicyResourceType

policyDetails

UpdateLifecyclePolicyRequest.Builder policyDetails(Collection<LifecyclePolicyDetail> policyDetails)

The configuration details for a lifecycle policy resource.

Parameters:

policyDetails - The configuration details for a lifecycle policy resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

policyDetails

UpdateLifecyclePolicyRequest.Builder policyDetails(LifecyclePolicyDetail... policyDetails)

The configuration details for a lifecycle policy resource.

Parameters:

policyDetails - The configuration details for a lifecycle policy resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

policyDetails

UpdateLifecyclePolicyRequest.Builder policyDetails(Consumer<LifecyclePolicyDetail.Builder>... policyDetails)

The configuration details for a lifecycle policy resource.

This is a convenience method that creates an instance of the LifecyclePolicyDetail.Builder avoiding the need to create one manually via LifecyclePolicyDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to policyDetails(List<LifecyclePolicyDetail>).

Parameters:

policyDetails - a consumer that will call methods on LifecyclePolicyDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• policyDetails(java.util.Collection<LifecyclePolicyDetail>)

resourceSelection

UpdateLifecyclePolicyRequest.Builder resourceSelection(LifecyclePolicyResourceSelection resourceSelection)

Selection criteria for resources that the lifecycle policy applies to. You must specify exactly one selection criteria: either recipes or a tag map, not both.

Parameters:

resourceSelection - Selection criteria for resources that the lifecycle policy applies to. You must specify exactly one selection criteria: either recipes or a tag map, not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceSelection

default UpdateLifecyclePolicyRequest.Builder resourceSelection(Consumer<LifecyclePolicyResourceSelection.Builder> resourceSelection)

Selection criteria for resources that the lifecycle policy applies to. You must specify exactly one selection criteria: either recipes or a tag map, not both.

This is a convenience method that creates an instance of the LifecyclePolicyResourceSelection.Builder avoiding the need to create one manually via LifecyclePolicyResourceSelection.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceSelection(LifecyclePolicyResourceSelection).

Parameters:

resourceSelection - a consumer that will call methods on LifecyclePolicyResourceSelection.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• resourceSelection(LifecyclePolicyResourceSelection)

clientToken

UpdateLifecyclePolicyRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Parameters:

clientToken - A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateLifecyclePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateLifecyclePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.