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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb

Overview

Note:

When making an API call, you may pass GetScalingPlanResourceForecastDataRequest data as a 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)


586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 586

class GetScalingPlanResourceForecastDataRequest < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :forecast_data_type,
  :start_time,
  :end_time)
  include Aws::Structure
end

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

Returns:

  • (String)


586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 586

class GetScalingPlanResourceForecastDataRequest < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :forecast_data_type,
  :start_time,
  :end_time)
  include Aws::Structure
end

#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)


586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 586

class GetScalingPlanResourceForecastDataRequest < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :forecast_data_type,
  :start_time,
  :end_time)
  include Aws::Structure
end

#scalable_dimensionString

The scalable dimension for the resource.

Returns:

  • (String)


586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 586

class GetScalingPlanResourceForecastDataRequest < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :forecast_data_type,
  :start_time,
  :end_time)
  include Aws::Structure
end

#scaling_plan_nameString

The name of the scaling plan.

Returns:

  • (String)


586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 586

class GetScalingPlanResourceForecastDataRequest < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :forecast_data_type,
  :start_time,
  :end_time)
  include Aws::Structure
end

#scaling_plan_versionInteger

The version number of the scaling plan.

Returns:

  • (Integer)


586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 586

class GetScalingPlanResourceForecastDataRequest < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :forecast_data_type,
  :start_time,
  :end_time)
  include Aws::Structure
end

#service_namespaceString

The namespace of the AWS service.

Returns:

  • (String)


586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 586

class GetScalingPlanResourceForecastDataRequest < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :forecast_data_type,
  :start_time,
  :end_time)
  include Aws::Structure
end

#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)


586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 586

class GetScalingPlanResourceForecastDataRequest < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :forecast_data_type,
  :start_time,
  :end_time)
  include Aws::Structure
end