software.amazon.awssdk.services.lightsail.model

Interface StopInstanceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<StopInstanceRequest.Builder,StopInstanceRequest>, LightsailRequest.Builder, SdkBuilder<StopInstanceRequest.Builder,StopInstanceRequest>, SdkRequest.Builder

Enclosing class:

StopInstanceRequest

public static interface StopInstanceRequest.Builder
extends LightsailRequest.Builder, CopyableBuilder<StopInstanceRequest.Builder,StopInstanceRequest>

Method Summary

Modifier and Type	Method and Description
StopInstanceRequest.Builder	force(Boolean force) When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.
StopInstanceRequest.Builder	instanceName(String instanceName) The name of the instance (a virtual private server) to stop.
StopInstanceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StopInstanceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder

build

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.utils.builder.SdkBuilder

applyMutation, build

Method Detail

instanceName

StopInstanceRequest.Builder instanceName(String instanceName)

The name of the instance (a virtual private server) to stop.

Parameters:

instanceName - The name of the instance (a virtual private server) to stop.

Returns:

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

force

StopInstanceRequest.Builder force(Boolean force)

When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

Parameters:

force - When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

Returns:

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

overrideConfiguration

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

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