Package software.amazon.awssdk.services.ec2.model

Interface StopInstancesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StopInstancesRequest.Builder,StopInstancesRequest>, Ec2Request.Builder, SdkBuilder<StopInstancesRequest.Builder,StopInstancesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StopInstancesRequest

@Mutable
@NotThreadSafe
public static interface StopInstancesRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<StopInstancesRequest.Builder,StopInstancesRequest>

Method Summary

Modifier and Type	Method	Description
StopInstancesRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response.
StopInstancesRequest.Builder	force(Boolean force)	Forces the instance to stop.
StopInstancesRequest.Builder	hibernate(Boolean hibernate)	Hibernates the instance if the instance was enabled for hibernation at launch.
StopInstancesRequest.Builder	instanceIds(String... instanceIds)	The IDs of the instances.
StopInstancesRequest.Builder	instanceIds(Collection<String> instanceIds)	The IDs of the instances.
StopInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StopInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

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.ec2.model.Ec2Request.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

instanceIds

StopInstancesRequest.Builder instanceIds(Collection<String> instanceIds)

The IDs of the instances.

Parameters:

instanceIds - The IDs of the instances.

Returns:

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

instanceIds

StopInstancesRequest.Builder instanceIds(String... instanceIds)

The IDs of the instances.

Parameters:

instanceIds - The IDs of the instances.

Returns:

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

hibernate

StopInstancesRequest.Builder hibernate(Boolean hibernate)

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

Parameters:

hibernate - Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

Returns:

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

dryRun

StopInstancesRequest.Builder dryRun(Boolean dryRun)

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Parameters:

dryRun - Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

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

force

StopInstancesRequest.Builder force(Boolean force)

Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.

After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.

Default: false

Parameters:

force - Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.

After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.

Default: false

Returns:

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

overrideConfiguration

StopInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder