software.amazon.awssdk.services.autoscalingplans.model

Interface GetScalingPlanResourceForecastDataRequest.Builder

All Superinterfaces:

AutoScalingPlansRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<GetScalingPlanResourceForecastDataRequest.Builder,GetScalingPlanResourceForecastDataRequest>, SdkBuilder<GetScalingPlanResourceForecastDataRequest.Builder,GetScalingPlanResourceForecastDataRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetScalingPlanResourceForecastDataRequest

public static interface GetScalingPlanResourceForecastDataRequest.Builder
extends AutoScalingPlansRequest.Builder, SdkPojo, CopyableBuilder<GetScalingPlanResourceForecastDataRequest.Builder,GetScalingPlanResourceForecastDataRequest>

Method Summary

Modifier and Type	Method and Description
GetScalingPlanResourceForecastDataRequest.Builder	endTime(Instant endTime) The exclusive end time of the time range for the forecast data to get.
GetScalingPlanResourceForecastDataRequest.Builder	forecastDataType(ForecastDataType forecastDataType) The type of forecast data to get.
GetScalingPlanResourceForecastDataRequest.Builder	forecastDataType(String forecastDataType) The type of forecast data to get.
GetScalingPlanResourceForecastDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetScalingPlanResourceForecastDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetScalingPlanResourceForecastDataRequest.Builder	resourceId(String resourceId) The ID of the resource.
GetScalingPlanResourceForecastDataRequest.Builder	scalableDimension(ScalableDimension scalableDimension) The scalable dimension for the resource.
GetScalingPlanResourceForecastDataRequest.Builder	scalableDimension(String scalableDimension) The scalable dimension for the resource.
GetScalingPlanResourceForecastDataRequest.Builder	scalingPlanName(String scalingPlanName) The name of the scaling plan.
GetScalingPlanResourceForecastDataRequest.Builder	scalingPlanVersion(Long scalingPlanVersion) The version number of the scaling plan.
GetScalingPlanResourceForecastDataRequest.Builder	serviceNamespace(ServiceNamespace serviceNamespace) The namespace of the AWS service.
GetScalingPlanResourceForecastDataRequest.Builder	serviceNamespace(String serviceNamespace) The namespace of the AWS service.
GetScalingPlanResourceForecastDataRequest.Builder	startTime(Instant startTime) The inclusive start time of the time range for the forecast data to get.

Methods inherited from interface software.amazon.awssdk.services.autoscalingplans.model.AutoScalingPlansRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

scalingPlanName

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

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

serviceNamespace

GetScalingPlanResourceForecastDataRequest.Builder serviceNamespace(String serviceNamespace)

The namespace of the AWS service.

Parameters:

serviceNamespace - The namespace of the AWS service.

Returns:

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

See Also:

ServiceNamespace, ServiceNamespace

serviceNamespace

GetScalingPlanResourceForecastDataRequest.Builder serviceNamespace(ServiceNamespace serviceNamespace)

The namespace of the AWS service.

Parameters:

serviceNamespace - The namespace of the AWS service.

Returns:

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

See Also:

ServiceNamespace, ServiceNamespace

resourceId

GetScalingPlanResourceForecastDataRequest.Builder resourceId(String resourceId)

The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

Parameters:

resourceId - The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

Returns:

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

scalableDimension

GetScalingPlanResourceForecastDataRequest.Builder scalableDimension(String scalableDimension)

The scalable dimension for the resource.

Parameters:

scalableDimension - The scalable dimension for the resource.

Returns:

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

See Also:

ScalableDimension, ScalableDimension

scalableDimension

GetScalingPlanResourceForecastDataRequest.Builder scalableDimension(ScalableDimension scalableDimension)

The scalable dimension for the resource.

Parameters:

scalableDimension - The scalable dimension for the resource.

Returns:

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

See Also:

ScalableDimension, ScalableDimension

forecastDataType

GetScalingPlanResourceForecastDataRequest.Builder forecastDataType(String forecastDataType)

The type of forecast data to get.

• LoadForecast: The load metric forecast.

• CapacityForecast: The capacity forecast.

• ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.

• ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.

Parameters:

forecastDataType - The type of forecast data to get.

• LoadForecast: The load metric forecast.

• CapacityForecast: The capacity forecast.

• ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.

• ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.

Returns:

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

See Also:

ForecastDataType, ForecastDataType

forecastDataType

GetScalingPlanResourceForecastDataRequest.Builder forecastDataType(ForecastDataType forecastDataType)

The type of forecast data to get.

• LoadForecast: The load metric forecast.

• CapacityForecast: The capacity forecast.

• ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.

• ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.

Parameters:

forecastDataType - The type of forecast data to get.

• LoadForecast: The load metric forecast.

• CapacityForecast: The capacity forecast.

• ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.

• ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.

Returns:

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

See Also:

ForecastDataType, ForecastDataType

startTime

GetScalingPlanResourceForecastDataRequest.Builder startTime(Instant startTime)

The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.

Parameters:

startTime - The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.

Returns:

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

endTime

GetScalingPlanResourceForecastDataRequest.Builder endTime(Instant endTime)

The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days.

Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.

Parameters:

endTime - The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days.

Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.

Returns:

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

overrideConfiguration

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

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