/ 
Paws-0.43
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::AutoScalingPlans::GetScalingPlanResourceForecastData

NAME

Paws::AutoScalingPlans::GetScalingPlanResourceForecastData - Arguments for method GetScalingPlanResourceForecastData on Paws::AutoScalingPlans

DESCRIPTION

This class represents the parameters used for calling the method GetScalingPlanResourceForecastData on the AWS Auto Scaling Plans service. Use the attributes of this class as arguments to method GetScalingPlanResourceForecastData.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetScalingPlanResourceForecastData.

SYNOPSIS

my $autoscaling-plans = Paws->service('AutoScalingPlans');
my $GetScalingPlanResourceForecastDataResponse =
  $autoscaling -plans->GetScalingPlanResourceForecastData(
  EndTime            => '1970-01-01T01:00:00',
  ForecastDataType   => 'CapacityForecast',
  ResourceId         => 'MyXmlString',
  ScalableDimension  => 'autoscaling:autoScalingGroup:DesiredCapacity',
  ScalingPlanName    => 'MyScalingPlanName',
  ScalingPlanVersion => 1,
  ServiceNamespace   => 'autoscaling',
  StartTime          => '1970-01-01T01:00:00',

  );

# Results:
my $Datapoints = $GetScalingPlanResourceForecastDataResponse->Datapoints;

# Returns a Paws::AutoScalingPlans::GetScalingPlanResourceForecastDataResponse object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans/GetScalingPlanResourceForecastData

ATTRIBUTES

REQUIRED EndTime => Str

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.

REQUIRED ForecastDataType => Str

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.

Valid values are: "CapacityForecast", "LoadForecast", "ScheduledActionMinCapacity", "ScheduledActionMaxCapacity"

REQUIRED ResourceId => Str

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.

REQUIRED ScalableDimension => Str

The scalable dimension for the resource.

Valid values are: "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"

REQUIRED ScalingPlanName => Str

The name of the scaling plan.

REQUIRED ScalingPlanVersion => Int

The version number of the scaling plan.

REQUIRED ServiceNamespace => Str

The namespace of the AWS service.

Valid values are: "autoscaling", "ecs", "ec2", "rds", "dynamodb"

REQUIRED StartTime => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetScalingPlanResourceForecastData in Paws::AutoScalingPlans

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues