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 Details

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

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