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

Interface GetScalingPlanResourceForecastDataRequest.Builder

    • 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. Currently, the only valid value is 1.

        Parameters:
        scalingPlanVersion - The version number of the scaling plan. Currently, the only valid value is 1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceId

        GetScalingPlanResourceForecastDataRequest.Builder resourceId​(String resourceId)

        The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.

        Parameters:
        resourceId - The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
        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. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.

        Parameters:
        scalableDimension - The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
        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. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.

        Parameters:
        scalableDimension - The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
        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.