AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AutoScalingPlans::Types::GetScalingPlanResourceForecastDataRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetScalingPlanResourceForecastDataRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  scaling_plan_name: "ScalingPlanName", # required
  scaling_plan_version: 1, # required
  service_namespace: "autoscaling", # required, accepts autoscaling, ecs, ec2, rds, dynamodb
  resource_id: "XmlString", # required
  scalable_dimension: "autoscaling:autoScalingGroup:DesiredCapacity", # required, accepts autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits
  forecast_data_type: "CapacityForecast", # required, accepts CapacityForecast, LoadForecast, ScheduledActionMinCapacity, ScheduledActionMaxCapacity
  start_time: Time.now, # required
  end_time: Time.now, # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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:

  • (Time)

    The exclusive end time of the time range for the forecast data to get.

#forecast_data_typeString

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.

    Possible values:

    • CapacityForecast
    • LoadForecast
    • ScheduledActionMinCapacity
    • ScheduledActionMaxCapacity

Returns:

  • (String)

    The type of forecast data to get.

#resource_idString

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:

  • (String)

    The ID of the resource.

#scalable_dimensionString

The scalable dimension for the resource.

Possible values:

  • autoscaling:autoScalingGroup:DesiredCapacity
  • ecs:service:DesiredCount
  • ec2:spot-fleet-request:TargetCapacity
  • rds:cluster:ReadReplicaCount
  • dynamodb:table:ReadCapacityUnits
  • dynamodb:table:WriteCapacityUnits
  • dynamodb:index:ReadCapacityUnits
  • dynamodb:index:WriteCapacityUnits

Returns:

  • (String)

    The scalable dimension for the resource.

#scaling_plan_nameString

The name of the scaling plan.

Returns:

  • (String)

    The name of the scaling plan.

#scaling_plan_versionInteger

The version number of the scaling plan.

Returns:

  • (Integer)

    The version number of the scaling plan.

#service_namespaceString

The namespace of the AWS service.

Possible values:

  • autoscaling
  • ecs
  • ec2
  • rds
  • dynamodb

Returns:

  • (String)

    The namespace of the AWS service.

#start_timeTime

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:

  • (Time)

    The inclusive start time of the time range for the forecast data to get.