Package software.amazon.awssdk.services.autoscalingplans.model

Interface ScalingPlan.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ScalingPlan.Builder,ScalingPlan>, SdkBuilder<ScalingPlan.Builder,ScalingPlan>, SdkPojo

Enclosing class:

ScalingPlan

public static interface ScalingPlan.Builder
extends SdkPojo, CopyableBuilder<ScalingPlan.Builder,ScalingPlan>

Method Summary

Modifier and Type	Method	Description
default ScalingPlan.Builder	applicationSource(Consumer<ApplicationSource.Builder> applicationSource)	A CloudFormation stack or a set of tags.
ScalingPlan.Builder	applicationSource(ApplicationSource applicationSource)	A CloudFormation stack or a set of tags.
ScalingPlan.Builder	creationTime(Instant creationTime)	The Unix time stamp when the scaling plan was created.
ScalingPlan.Builder	scalingInstructions(Collection<ScalingInstruction> scalingInstructions)	The scaling instructions.
ScalingPlan.Builder	scalingInstructions(Consumer<ScalingInstruction.Builder>... scalingInstructions)	The scaling instructions.
ScalingPlan.Builder	scalingInstructions(ScalingInstruction... scalingInstructions)	The scaling instructions.
ScalingPlan.Builder	scalingPlanName(String scalingPlanName)	The name of the scaling plan.
ScalingPlan.Builder	scalingPlanVersion(Long scalingPlanVersion)	The version number of the scaling plan.
ScalingPlan.Builder	statusCode(String statusCode)	The status of the scaling plan.
ScalingPlan.Builder	statusCode(ScalingPlanStatusCode statusCode)	The status of the scaling plan.
ScalingPlan.Builder	statusMessage(String statusMessage)	A simple message about the current status of the scaling plan.
ScalingPlan.Builder	statusStartTime(Instant statusStartTime)	The Unix time stamp when the scaling plan entered the current status.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

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

scalingPlanName

ScalingPlan.Builder scalingPlanName(String scalingPlanName)

The name of the scaling plan.

Parameters:

scalingPlanName - The name of the scaling plan.

Returns:

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

scalingPlanVersion

ScalingPlan.Builder scalingPlanVersion(Long scalingPlanVersion)

The version number of the scaling plan.

Parameters:

scalingPlanVersion - The version number of the scaling plan.

Returns:

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

applicationSource

ScalingPlan.Builder applicationSource(ApplicationSource applicationSource)

A CloudFormation stack or a set of tags. You can create one scaling plan per application source.

Parameters:

applicationSource - A CloudFormation stack or a set of tags. You can create one scaling plan per application source.

Returns:

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

applicationSource

default ScalingPlan.Builder applicationSource(Consumer<ApplicationSource.Builder> applicationSource)

A CloudFormation stack or a set of tags. You can create one scaling plan per application source.

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

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

Parameters:

applicationSource - a consumer that will call methods on ApplicationSource.Builder

Returns:

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

See Also:

applicationSource(ApplicationSource)

scalingInstructions

ScalingPlan.Builder scalingInstructions(Collection<ScalingInstruction> scalingInstructions)

The scaling instructions.

Parameters:

scalingInstructions - The scaling instructions.

Returns:

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

scalingInstructions

ScalingPlan.Builder scalingInstructions(ScalingInstruction... scalingInstructions)

The scaling instructions.

Parameters:

scalingInstructions - The scaling instructions.

Returns:

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

scalingInstructions

ScalingPlan.Builder scalingInstructions(Consumer<ScalingInstruction.Builder>... scalingInstructions)

The scaling instructions.

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

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

Parameters:

scalingInstructions - a consumer that will call methods on ScalingInstruction.Builder

Returns:

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

See Also:

#scalingInstructions(java.util.Collection)

statusCode

ScalingPlan.Builder statusCode(String statusCode)

The status of the scaling plan.

• Active - The scaling plan is active.

• ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

• CreationInProgress - The scaling plan is being created.

• CreationFailed - The scaling plan could not be created.

• DeletionInProgress - The scaling plan is being deleted.

• DeletionFailed - The scaling plan could not be deleted.

• UpdateInProgress - The scaling plan is being updated.

• UpdateFailed - The scaling plan could not be updated.

Parameters:

statusCode - The status of the scaling plan.

• Active - The scaling plan is active.

• ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

• CreationInProgress - The scaling plan is being created.

• CreationFailed - The scaling plan could not be created.

• DeletionInProgress - The scaling plan is being deleted.

• DeletionFailed - The scaling plan could not be deleted.

• UpdateInProgress - The scaling plan is being updated.

• UpdateFailed - The scaling plan could not be updated.

Returns:

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

See Also:

ScalingPlanStatusCode, ScalingPlanStatusCode

statusCode

ScalingPlan.Builder statusCode(ScalingPlanStatusCode statusCode)

The status of the scaling plan.

• Active - The scaling plan is active.

• ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

• CreationInProgress - The scaling plan is being created.

• CreationFailed - The scaling plan could not be created.

• DeletionInProgress - The scaling plan is being deleted.

• DeletionFailed - The scaling plan could not be deleted.

• UpdateInProgress - The scaling plan is being updated.

• UpdateFailed - The scaling plan could not be updated.

Parameters:

statusCode - The status of the scaling plan.

• Active - The scaling plan is active.

• ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

• CreationInProgress - The scaling plan is being created.

• CreationFailed - The scaling plan could not be created.

• DeletionInProgress - The scaling plan is being deleted.

• DeletionFailed - The scaling plan could not be deleted.

• UpdateInProgress - The scaling plan is being updated.

• UpdateFailed - The scaling plan could not be updated.

Returns:

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

See Also:

ScalingPlanStatusCode, ScalingPlanStatusCode

statusMessage

ScalingPlan.Builder statusMessage(String statusMessage)

A simple message about the current status of the scaling plan.

Parameters:

statusMessage - A simple message about the current status of the scaling plan.

Returns:

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

statusStartTime

ScalingPlan.Builder statusStartTime(Instant statusStartTime)

The Unix time stamp when the scaling plan entered the current status.

Parameters:

statusStartTime - The Unix time stamp when the scaling plan entered the current status.

Returns:

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

creationTime

ScalingPlan.Builder creationTime(Instant creationTime)

The Unix time stamp when the scaling plan was created.

Parameters:

creationTime - The Unix time stamp when the scaling plan was created.

Returns:

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