AWS SDK Version 3 for .NET
API Reference

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.

Container for the parameters to the GetScalingPlanResourceForecastData operation. Retrieves the forecast data for a scalable resource.

Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AutoScalingPlans.AmazonAutoScalingPlansRequest
      Amazon.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataRequest

Namespace: Amazon.AutoScalingPlans.Model
Assembly: AWSSDK.AutoScalingPlans.dll
Version: 3.x.y.z

Syntax

C#
public class GetScalingPlanResourceForecastDataRequest : AmazonAutoScalingPlansRequest
         IAmazonWebServiceRequest

The GetScalingPlanResourceForecastDataRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property EndTime System.DateTime

Gets and sets the property 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.

Public Property ForecastDataType Amazon.AutoScalingPlans.ForecastDataType

Gets and sets the property 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.

Public Property ResourceId System.String

Gets and sets the property 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.

Public Property ScalableDimension Amazon.AutoScalingPlans.ScalableDimension

Gets and sets the property ScalableDimension.

The scalable dimension for the resource.

Public Property ScalingPlanName System.String

Gets and sets the property ScalingPlanName.

The name of the scaling plan.

Public Property ScalingPlanVersion System.Int64

Gets and sets the property ScalingPlanVersion.

The version number of the scaling plan.

Public Property ServiceNamespace Amazon.AutoScalingPlans.ServiceNamespace

Gets and sets the property ServiceNamespace.

The namespace of the AWS service.

Public Property StartTime System.DateTime

Gets and sets the property 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.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms