Class: Aws::AutoScalingPlans::Types::GetScalingPlanResourceForecastDataRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AutoScalingPlans::Types::GetScalingPlanResourceForecastDataRequest
- Defined in:
- gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb
Overview
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
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#end_time ⇒ Time
The exclusive end time of the time range for the forecast data to get.
-
#forecast_data_type ⇒ String
The type of forecast data to get.
-
#resource_id ⇒ String
The ID of the resource.
-
#scalable_dimension ⇒ String
The scalable dimension for the resource.
-
#scaling_plan_name ⇒ String
The name of the scaling plan.
-
#scaling_plan_version ⇒ Integer
The version number of the scaling plan.
-
#service_namespace ⇒ String
The namespace of the AWS service.
-
#start_time ⇒ Time
The inclusive start time of the time range for the forecast data to get.
Instance Attribute Details
#end_time ⇒ Time
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.
612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 612 class GetScalingPlanResourceForecastDataRequest < Struct.new( :scaling_plan_name, :scaling_plan_version, :service_namespace, :resource_id, :scalable_dimension, :forecast_data_type, :start_time, :end_time) SENSITIVE = [] include Aws::Structure end |
#forecast_data_type ⇒ String
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.
612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 612 class GetScalingPlanResourceForecastDataRequest < Struct.new( :scaling_plan_name, :scaling_plan_version, :service_namespace, :resource_id, :scalable_dimension, :forecast_data_type, :start_time, :end_time) SENSITIVE = [] include Aws::Structure end |
#resource_id ⇒ String
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
.
612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 612 class GetScalingPlanResourceForecastDataRequest < Struct.new( :scaling_plan_name, :scaling_plan_version, :service_namespace, :resource_id, :scalable_dimension, :forecast_data_type, :start_time, :end_time) SENSITIVE = [] include Aws::Structure end |
#scalable_dimension ⇒ String
The scalable dimension for the resource. The only valid value is
autoscaling:autoScalingGroup:DesiredCapacity
.
612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 612 class GetScalingPlanResourceForecastDataRequest < Struct.new( :scaling_plan_name, :scaling_plan_version, :service_namespace, :resource_id, :scalable_dimension, :forecast_data_type, :start_time, :end_time) SENSITIVE = [] include Aws::Structure end |
#scaling_plan_name ⇒ String
The name of the scaling plan.
612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 612 class GetScalingPlanResourceForecastDataRequest < Struct.new( :scaling_plan_name, :scaling_plan_version, :service_namespace, :resource_id, :scalable_dimension, :forecast_data_type, :start_time, :end_time) SENSITIVE = [] include Aws::Structure end |
#scaling_plan_version ⇒ Integer
The version number of the scaling plan. Currently, the only valid
value is 1
.
612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 612 class GetScalingPlanResourceForecastDataRequest < Struct.new( :scaling_plan_name, :scaling_plan_version, :service_namespace, :resource_id, :scalable_dimension, :forecast_data_type, :start_time, :end_time) SENSITIVE = [] include Aws::Structure end |
#service_namespace ⇒ String
The namespace of the AWS service. The only valid value is
autoscaling
.
612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 612 class GetScalingPlanResourceForecastDataRequest < Struct.new( :scaling_plan_name, :scaling_plan_version, :service_namespace, :resource_id, :scalable_dimension, :forecast_data_type, :start_time, :end_time) SENSITIVE = [] include Aws::Structure end |
#start_time ⇒ Time
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.
612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 612 class GetScalingPlanResourceForecastDataRequest < Struct.new( :scaling_plan_name, :scaling_plan_version, :service_namespace, :resource_id, :scalable_dimension, :forecast_data_type, :start_time, :end_time) SENSITIVE = [] include Aws::Structure end |