Interface StartCapacityTaskRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartCapacityTaskRequest.Builder,
,StartCapacityTaskRequest> OutpostsRequest.Builder
,SdkBuilder<StartCapacityTaskRequest.Builder,
,StartCapacityTaskRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartCapacityTaskRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe ID of the Outpost asset.You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity.instancePools
(Collection<InstanceTypeCapacity> instancePools) The instance pools specified in the capacity task.instancePools
(Consumer<InstanceTypeCapacity.Builder>... instancePools) The instance pools specified in the capacity task.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.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.The ID of the Amazon Web Services Outposts order associated with the specified capacity task.outpostIdentifier
(String outpostIdentifier) The ID or ARN of the Outposts associated with the specified capacity task.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.taskActionOnBlockingInstances
(String taskActionOnBlockingInstances) Specify one of the following options in case an instance is blocking the capacity task from running.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 Details
-
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
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.
-
assetId
The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
- Parameters:
assetId
- The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 theInstanceTypeCapacity.Builder
avoiding the need to create one manually viaInstanceTypeCapacity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstancePools(List<InstanceTypeCapacity>)
.- Parameters:
instancePools
- a consumer that will call methods onInstanceTypeCapacity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theInstancesToExclude.Builder
avoiding the need to create one manually viaInstancesToExclude.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstancesToExclude(InstancesToExclude)
.- Parameters:
instancesToExclude
- a consumer that will call methods onInstancesToExclude.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-
-
overrideConfiguration
StartCapacityTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartCapacityTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-