Package software.amazon.awssdk.services.outposts.model

Interface StartCapacityTaskRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartCapacityTaskRequest.Builder,StartCapacityTaskRequest>, OutpostsRequest.Builder, SdkBuilder<StartCapacityTaskRequest.Builder,StartCapacityTaskRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartCapacityTaskRequest

public static interface StartCapacityTaskRequest.Builder
extends OutpostsRequest.Builder, SdkPojo, CopyableBuilder<StartCapacityTaskRequest.Builder,StartCapacityTaskRequest>

Method Summary

Modifier and Type	Method	Description
StartCapacityTaskRequest.Builder	dryRun(Boolean dryRun)	You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity.
StartCapacityTaskRequest.Builder	instancePools(Collection<InstanceTypeCapacity> instancePools)	The instance pools specified in the capacity task.
StartCapacityTaskRequest.Builder	instancePools(Consumer<InstanceTypeCapacity.Builder>... instancePools)	The instance pools specified in the capacity task.
StartCapacityTaskRequest.Builder	instancePools(InstanceTypeCapacity... instancePools)	The instance pools specified in the capacity task.
default StartCapacityTaskRequest.Builder	instancesToExclude(Consumer<InstancesToExclude.Builder> instancesToExclude)	List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.
StartCapacityTaskRequest.Builder	instancesToExclude(InstancesToExclude instancesToExclude)	List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.
StartCapacityTaskRequest.Builder	orderId(String orderId)	The ID of the Amazon Web Services Outposts order associated with the specified capacity task.
StartCapacityTaskRequest.Builder	outpostIdentifier(String outpostIdentifier)	The ID or ARN of the Outposts associated with the specified capacity task.
StartCapacityTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartCapacityTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartCapacityTaskRequest.Builder	taskActionOnBlockingInstances(String taskActionOnBlockingInstances)	Specify one of the following options in case an instance is blocking the capacity task from running.
StartCapacityTaskRequest.Builder	taskActionOnBlockingInstances(TaskActionOnBlockingInstances taskActionOnBlockingInstances)	Specify one of the following options in case an instance is blocking the capacity task from running.

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.outposts.model.OutpostsRequest.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 Detail

outpostIdentifier

StartCapacityTaskRequest.Builder outpostIdentifier(String outpostIdentifier)

The ID or ARN of the Outposts associated with the specified capacity task.

Parameters:

outpostIdentifier - The ID or ARN of the Outposts associated with the specified capacity task.

Returns:

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

orderId

StartCapacityTaskRequest.Builder orderId(String orderId)

The ID of the Amazon Web Services Outposts order associated with the specified capacity task.

Parameters:

orderId - The ID of the Amazon Web Services Outposts order associated with the specified capacity task.

Returns:

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

instancePools

StartCapacityTaskRequest.Builder instancePools(Collection<InstanceTypeCapacity> instancePools)

The instance pools specified in the capacity task.

Parameters:

instancePools - The instance pools specified in the capacity task.

Returns:

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

instancePools

StartCapacityTaskRequest.Builder instancePools(InstanceTypeCapacity... instancePools)

The instance pools specified in the capacity task.

Parameters:

instancePools - The instance pools specified in the capacity task.

Returns:

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

instancePools

StartCapacityTaskRequest.Builder instancePools(Consumer<InstanceTypeCapacity.Builder>... instancePools)

The instance pools specified in the capacity task.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instancePools(List).

Parameters:

instancePools - a consumer that will call methods on InstanceTypeCapacity.Builder

Returns:

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

See Also:

#instancePools(java.util.Collection)

instancesToExclude

StartCapacityTaskRequest.Builder instancesToExclude(InstancesToExclude instancesToExclude)

List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.

Parameters:

instancesToExclude - List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.

Returns:

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

instancesToExclude

default StartCapacityTaskRequest.Builder instancesToExclude(Consumer<InstancesToExclude.Builder> instancesToExclude)

List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.

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

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

Parameters:

instancesToExclude - a consumer that will call methods on InstancesToExclude.Builder

Returns:

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

See Also:

instancesToExclude(InstancesToExclude)

dryRun

StartCapacityTaskRequest.Builder dryRun(Boolean dryRun)

You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.

Parameters:

dryRun - You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.

Returns:

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

taskActionOnBlockingInstances

StartCapacityTaskRequest.Builder taskActionOnBlockingInstances(String taskActionOnBlockingInstances)

Specify one of the following options in case an instance is blocking the capacity task from running.

• WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

• FAIL_TASK - The capacity task fails.

Parameters:

taskActionOnBlockingInstances - Specify one of the following options in case an instance is blocking the capacity task from running.

• WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

• FAIL_TASK - The capacity task fails.

Returns:

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

See Also:

TaskActionOnBlockingInstances, TaskActionOnBlockingInstances

taskActionOnBlockingInstances

StartCapacityTaskRequest.Builder taskActionOnBlockingInstances(TaskActionOnBlockingInstances taskActionOnBlockingInstances)

Specify one of the following options in case an instance is blocking the capacity task from running.

• WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

• FAIL_TASK - The capacity task fails.

Parameters:

taskActionOnBlockingInstances - Specify one of the following options in case an instance is blocking the capacity task from running.

• WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

• FAIL_TASK - The capacity task fails.

Returns:

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

See Also:

TaskActionOnBlockingInstances, TaskActionOnBlockingInstances

overrideConfiguration

StartCapacityTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder