/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / autoscalingplans.d.ts
autoscalingplans.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class AutoScalingPlans extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: AutoScalingPlans.Types.ClientConfiguration) 13 config: Config & AutoScalingPlans.Types.ClientConfiguration; 14 /** 15 * Creates a scaling plan. 16 */ 17 createScalingPlan(params: AutoScalingPlans.Types.CreateScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.CreateScalingPlanResponse) => void): Request<AutoScalingPlans.Types.CreateScalingPlanResponse, AWSError>; 18 /** 19 * Creates a scaling plan. 20 */ 21 createScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.CreateScalingPlanResponse) => void): Request<AutoScalingPlans.Types.CreateScalingPlanResponse, AWSError>; 22 /** 23 * Deletes the specified scaling plan. Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan. If the plan has launched resources or has scaling activities in progress, you must delete those resources separately. 24 */ 25 deleteScalingPlan(params: AutoScalingPlans.Types.DeleteScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DeleteScalingPlanResponse) => void): Request<AutoScalingPlans.Types.DeleteScalingPlanResponse, AWSError>; 26 /** 27 * Deletes the specified scaling plan. Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan. If the plan has launched resources or has scaling activities in progress, you must delete those resources separately. 28 */ 29 deleteScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.DeleteScalingPlanResponse) => void): Request<AutoScalingPlans.Types.DeleteScalingPlanResponse, AWSError>; 30 /** 31 * Describes the scalable resources in the specified scaling plan. 32 */ 33 describeScalingPlanResources(params: AutoScalingPlans.Types.DescribeScalingPlanResourcesRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse) => void): Request<AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse, AWSError>; 34 /** 35 * Describes the scalable resources in the specified scaling plan. 36 */ 37 describeScalingPlanResources(callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse) => void): Request<AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse, AWSError>; 38 /** 39 * Describes one or more of your scaling plans. 40 */ 41 describeScalingPlans(params: AutoScalingPlans.Types.DescribeScalingPlansRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlansResponse) => void): Request<AutoScalingPlans.Types.DescribeScalingPlansResponse, AWSError>; 42 /** 43 * Describes one or more of your scaling plans. 44 */ 45 describeScalingPlans(callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlansResponse) => void): Request<AutoScalingPlans.Types.DescribeScalingPlansResponse, AWSError>; 46 /** 47 * 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. 48 */ 49 getScalingPlanResourceForecastData(params: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse) => void): Request<AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse, AWSError>; 50 /** 51 * 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. 52 */ 53 getScalingPlanResourceForecastData(callback?: (err: AWSError, data: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse) => void): Request<AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse, AWSError>; 54 /** 55 * Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted. 56 */ 57 updateScalingPlan(params: AutoScalingPlans.Types.UpdateScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.UpdateScalingPlanResponse) => void): Request<AutoScalingPlans.Types.UpdateScalingPlanResponse, AWSError>; 58 /** 59 * Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted. 60 */ 61 updateScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.UpdateScalingPlanResponse) => void): Request<AutoScalingPlans.Types.UpdateScalingPlanResponse, AWSError>; 62 } 63 declare namespace AutoScalingPlans { 64 export interface ApplicationSource { 65 /** 66 * The Amazon Resource Name (ARN) of a AWS CloudFormation stack. 67 */ 68 CloudFormationStackARN?: XmlString; 69 /** 70 * A set of tags (up to 50). 71 */ 72 TagFilters?: TagFilters; 73 } 74 export type ApplicationSources = ApplicationSource[]; 75 export type Cooldown = number; 76 export interface CreateScalingPlanRequest { 77 /** 78 * The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes. 79 */ 80 ScalingPlanName: ScalingPlanName; 81 /** 82 * A CloudFormation stack or set of tags. You can create one scaling plan per application source. For more information, see ApplicationSource in the AWS Auto Scaling API Reference. 83 */ 84 ApplicationSource: ApplicationSource; 85 /** 86 * The scaling instructions. For more information, see ScalingInstruction in the AWS Auto Scaling API Reference. 87 */ 88 ScalingInstructions: ScalingInstructions; 89 } 90 export interface CreateScalingPlanResponse { 91 /** 92 * The version number of the scaling plan. This value is always 1. Currently, you cannot have multiple scaling plan versions. 93 */ 94 ScalingPlanVersion: ScalingPlanVersion; 95 } 96 export interface CustomizedLoadMetricSpecification { 97 /** 98 * The name of the metric. 99 */ 100 MetricName: MetricName; 101 /** 102 * The namespace of the metric. 103 */ 104 Namespace: MetricNamespace; 105 /** 106 * The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification. 107 */ 108 Dimensions?: MetricDimensions; 109 /** 110 * The statistic of the metric. The only valid value is Sum. 111 */ 112 Statistic: MetricStatistic; 113 /** 114 * The unit of the metric. 115 */ 116 Unit?: MetricUnit; 117 } 118 export interface CustomizedScalingMetricSpecification { 119 /** 120 * The name of the metric. 121 */ 122 MetricName: MetricName; 123 /** 124 * The namespace of the metric. 125 */ 126 Namespace: MetricNamespace; 127 /** 128 * The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification. 129 */ 130 Dimensions?: MetricDimensions; 131 /** 132 * The statistic of the metric. 133 */ 134 Statistic: MetricStatistic; 135 /** 136 * The unit of the metric. 137 */ 138 Unit?: MetricUnit; 139 } 140 export interface Datapoint { 141 /** 142 * The time stamp for the data point in UTC format. 143 */ 144 Timestamp?: TimestampType; 145 /** 146 * The value of the data point. 147 */ 148 Value?: MetricScale; 149 } 150 export type Datapoints = Datapoint[]; 151 export interface DeleteScalingPlanRequest { 152 /** 153 * The name of the scaling plan. 154 */ 155 ScalingPlanName: ScalingPlanName; 156 /** 157 * The version number of the scaling plan. Currently, the only valid value is 1. 158 */ 159 ScalingPlanVersion: ScalingPlanVersion; 160 } 161 export interface DeleteScalingPlanResponse { 162 } 163 export interface DescribeScalingPlanResourcesRequest { 164 /** 165 * The name of the scaling plan. 166 */ 167 ScalingPlanName: ScalingPlanName; 168 /** 169 * The version number of the scaling plan. Currently, the only valid value is 1. 170 */ 171 ScalingPlanVersion: ScalingPlanVersion; 172 /** 173 * The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50. 174 */ 175 MaxResults?: MaxResults; 176 /** 177 * The token for the next set of results. 178 */ 179 NextToken?: NextToken; 180 } 181 export interface DescribeScalingPlanResourcesResponse { 182 /** 183 * Information about the scalable resources. 184 */ 185 ScalingPlanResources?: ScalingPlanResources; 186 /** 187 * The token required to get the next set of results. This value is null if there are no more results to return. 188 */ 189 NextToken?: NextToken; 190 } 191 export interface DescribeScalingPlansRequest { 192 /** 193 * The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names. 194 */ 195 ScalingPlanNames?: ScalingPlanNames; 196 /** 197 * The version number of the scaling plan. Currently, the only valid value is 1. If you specify a scaling plan version, you must also specify a scaling plan name. 198 */ 199 ScalingPlanVersion?: ScalingPlanVersion; 200 /** 201 * The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources. 202 */ 203 ApplicationSources?: ApplicationSources; 204 /** 205 * The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50. 206 */ 207 MaxResults?: MaxResults; 208 /** 209 * The token for the next set of results. 210 */ 211 NextToken?: NextToken; 212 } 213 export interface DescribeScalingPlansResponse { 214 /** 215 * Information about the scaling plans. 216 */ 217 ScalingPlans?: ScalingPlans; 218 /** 219 * The token required to get the next set of results. This value is null if there are no more results to return. 220 */ 221 NextToken?: NextToken; 222 } 223 export type DisableDynamicScaling = boolean; 224 export type DisableScaleIn = boolean; 225 export type ForecastDataType = "CapacityForecast"|"LoadForecast"|"ScheduledActionMinCapacity"|"ScheduledActionMaxCapacity"|string; 226 export interface GetScalingPlanResourceForecastDataRequest { 227 /** 228 * The name of the scaling plan. 229 */ 230 ScalingPlanName: ScalingPlanName; 231 /** 232 * The version number of the scaling plan. Currently, the only valid value is 1. 233 */ 234 ScalingPlanVersion: ScalingPlanVersion; 235 /** 236 * The namespace of the AWS service. The only valid value is autoscaling. 237 */ 238 ServiceNamespace: ServiceNamespace; 239 /** 240 * 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. 241 */ 242 ResourceId: XmlString; 243 /** 244 * The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity. 245 */ 246 ScalableDimension: ScalableDimension; 247 /** 248 * 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. 249 */ 250 ForecastDataType: ForecastDataType; 251 /** 252 * 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. 253 */ 254 StartTime: TimestampType; 255 /** 256 * 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. 257 */ 258 EndTime: TimestampType; 259 } 260 export interface GetScalingPlanResourceForecastDataResponse { 261 /** 262 * The data points to return. 263 */ 264 Datapoints: Datapoints; 265 } 266 export type LoadMetricType = "ASGTotalCPUUtilization"|"ASGTotalNetworkIn"|"ASGTotalNetworkOut"|"ALBTargetGroupRequestCount"|string; 267 export type MaxResults = number; 268 export interface MetricDimension { 269 /** 270 * The name of the dimension. 271 */ 272 Name: MetricDimensionName; 273 /** 274 * The value of the dimension. 275 */ 276 Value: MetricDimensionValue; 277 } 278 export type MetricDimensionName = string; 279 export type MetricDimensionValue = string; 280 export type MetricDimensions = MetricDimension[]; 281 export type MetricName = string; 282 export type MetricNamespace = string; 283 export type MetricScale = number; 284 export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string; 285 export type MetricUnit = string; 286 export type NextToken = string; 287 export type PolicyName = string; 288 export type PolicyType = "TargetTrackingScaling"|string; 289 export interface PredefinedLoadMetricSpecification { 290 /** 291 * The metric type. 292 */ 293 PredefinedLoadMetricType: LoadMetricType; 294 /** 295 * Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where: app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN. This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d. To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation. 296 */ 297 ResourceLabel?: ResourceLabel; 298 } 299 export interface PredefinedScalingMetricSpecification { 300 /** 301 * The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services. 302 */ 303 PredefinedScalingMetricType: ScalingMetricType; 304 /** 305 * Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where: app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN. This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d. To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation. 306 */ 307 ResourceLabel?: ResourceLabel; 308 } 309 export type PredictiveScalingMaxCapacityBehavior = "SetForecastCapacityToMaxCapacity"|"SetMaxCapacityToForecastCapacity"|"SetMaxCapacityAboveForecastCapacity"|string; 310 export type PredictiveScalingMode = "ForecastAndScale"|"ForecastOnly"|string; 311 export type ResourceCapacity = number; 312 export type ResourceIdMaxLen1600 = string; 313 export type ResourceLabel = string; 314 export type ScalableDimension = "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"|string; 315 export interface ScalingInstruction { 316 /** 317 * The namespace of the AWS service. 318 */ 319 ServiceNamespace: ServiceNamespace; 320 /** 321 * 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. 322 */ 323 ResourceId: ResourceIdMaxLen1600; 324 /** 325 * The scalable dimension associated with the resource. autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. 326 */ 327 ScalableDimension: ScalableDimension; 328 /** 329 * The minimum capacity of the resource. 330 */ 331 MinCapacity: ResourceCapacity; 332 /** 333 * The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior. 334 */ 335 MaxCapacity: ResourceCapacity; 336 /** 337 * The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric. 338 */ 339 TargetTrackingConfigurations: TargetTrackingConfigurations; 340 /** 341 * The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise. 342 */ 343 PredefinedLoadMetricSpecification?: PredefinedLoadMetricSpecification; 344 /** 345 * The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise. 346 */ 347 CustomizedLoadMetricSpecification?: CustomizedLoadMetricSpecification; 348 /** 349 * The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Only valid when configuring predictive scaling. 350 */ 351 ScheduledActionBufferTime?: ScheduledActionBufferTime; 352 /** 353 * Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity. The following are possible values: SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit. SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity. SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs. Only valid when configuring predictive scaling. 354 */ 355 PredictiveScalingMaxCapacityBehavior?: PredictiveScalingMaxCapacityBehavior; 356 /** 357 * The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise. The range is 1-100. 358 */ 359 PredictiveScalingMaxCapacityBuffer?: ResourceCapacity; 360 /** 361 * The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast. 362 */ 363 PredictiveScalingMode?: PredictiveScalingMode; 364 /** 365 * Controls whether a resource's externally created scaling policies are kept or replaced. The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created. Only valid when configuring dynamic scaling. Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones. 366 */ 367 ScalingPolicyUpdateBehavior?: ScalingPolicyUpdateBehavior; 368 /** 369 * Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false). 370 */ 371 DisableDynamicScaling?: DisableDynamicScaling; 372 } 373 export type ScalingInstructions = ScalingInstruction[]; 374 export type ScalingMetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|string; 375 export interface ScalingPlan { 376 /** 377 * The name of the scaling plan. 378 */ 379 ScalingPlanName: ScalingPlanName; 380 /** 381 * The version number of the scaling plan. 382 */ 383 ScalingPlanVersion: ScalingPlanVersion; 384 /** 385 * A CloudFormation stack or a set of tags. You can create one scaling plan per application source. 386 */ 387 ApplicationSource: ApplicationSource; 388 /** 389 * The scaling instructions. 390 */ 391 ScalingInstructions: ScalingInstructions; 392 /** 393 * The status of the scaling plan. Active - The scaling plan is active. ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied. CreationInProgress - The scaling plan is being created. CreationFailed - The scaling plan could not be created. DeletionInProgress - The scaling plan is being deleted. DeletionFailed - The scaling plan could not be deleted. UpdateInProgress - The scaling plan is being updated. UpdateFailed - The scaling plan could not be updated. 394 */ 395 StatusCode: ScalingPlanStatusCode; 396 /** 397 * A simple message about the current status of the scaling plan. 398 */ 399 StatusMessage?: XmlString; 400 /** 401 * The Unix time stamp when the scaling plan entered the current status. 402 */ 403 StatusStartTime?: TimestampType; 404 /** 405 * The Unix time stamp when the scaling plan was created. 406 */ 407 CreationTime?: TimestampType; 408 } 409 export type ScalingPlanName = string; 410 export type ScalingPlanNames = ScalingPlanName[]; 411 export interface ScalingPlanResource { 412 /** 413 * The name of the scaling plan. 414 */ 415 ScalingPlanName: ScalingPlanName; 416 /** 417 * The version number of the scaling plan. 418 */ 419 ScalingPlanVersion: ScalingPlanVersion; 420 /** 421 * The namespace of the AWS service. 422 */ 423 ServiceNamespace: ServiceNamespace; 424 /** 425 * 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. 426 */ 427 ResourceId: ResourceIdMaxLen1600; 428 /** 429 * The scalable dimension for the resource. autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. 430 */ 431 ScalableDimension: ScalableDimension; 432 /** 433 * The scaling policies. 434 */ 435 ScalingPolicies?: ScalingPolicies; 436 /** 437 * The scaling status of the resource. Active - The scaling configuration is active. Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information. 438 */ 439 ScalingStatusCode: ScalingStatusCode; 440 /** 441 * A simple message about the current scaling status of the resource. 442 */ 443 ScalingStatusMessage?: XmlString; 444 } 445 export type ScalingPlanResources = ScalingPlanResource[]; 446 export type ScalingPlanStatusCode = "Active"|"ActiveWithProblems"|"CreationInProgress"|"CreationFailed"|"DeletionInProgress"|"DeletionFailed"|"UpdateInProgress"|"UpdateFailed"|string; 447 export type ScalingPlanVersion = number; 448 export type ScalingPlans = ScalingPlan[]; 449 export type ScalingPolicies = ScalingPolicy[]; 450 export interface ScalingPolicy { 451 /** 452 * The name of the scaling policy. 453 */ 454 PolicyName: PolicyName; 455 /** 456 * The type of scaling policy. 457 */ 458 PolicyType: PolicyType; 459 /** 460 * The target tracking scaling policy. Includes support for predefined or customized metrics. 461 */ 462 TargetTrackingConfiguration?: TargetTrackingConfiguration; 463 } 464 export type ScalingPolicyUpdateBehavior = "KeepExternalPolicies"|"ReplaceExternalPolicies"|string; 465 export type ScalingStatusCode = "Inactive"|"PartiallyActive"|"Active"|string; 466 export type ScheduledActionBufferTime = number; 467 export type ServiceNamespace = "autoscaling"|"ecs"|"ec2"|"rds"|"dynamodb"|string; 468 export interface TagFilter { 469 /** 470 * The tag key. 471 */ 472 Key?: XmlStringMaxLen128; 473 /** 474 * The tag values (0 to 20). 475 */ 476 Values?: TagValues; 477 } 478 export type TagFilters = TagFilter[]; 479 export type TagValues = XmlStringMaxLen256[]; 480 export interface TargetTrackingConfiguration { 481 /** 482 * A predefined metric. You can specify either a predefined metric or a customized metric. 483 */ 484 PredefinedScalingMetricSpecification?: PredefinedScalingMetricSpecification; 485 /** 486 * A customized metric. You can specify either a predefined metric or a customized metric. 487 */ 488 CustomizedScalingMetricSpecification?: CustomizedScalingMetricSpecification; 489 /** 490 * The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. 491 */ 492 TargetValue: MetricScale; 493 /** 494 * Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false. 495 */ 496 DisableScaleIn?: DisableScaleIn; 497 /** 498 * The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group. With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. 499 */ 500 ScaleOutCooldown?: Cooldown; 501 /** 502 * The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group. With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete. 503 */ 504 ScaleInCooldown?: Cooldown; 505 /** 506 * The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group. 507 */ 508 EstimatedInstanceWarmup?: Cooldown; 509 } 510 export type TargetTrackingConfigurations = TargetTrackingConfiguration[]; 511 export type TimestampType = Date; 512 export interface UpdateScalingPlanRequest { 513 /** 514 * The name of the scaling plan. 515 */ 516 ScalingPlanName: ScalingPlanName; 517 /** 518 * The version number of the scaling plan. The only valid value is 1. Currently, you cannot have multiple scaling plan versions. 519 */ 520 ScalingPlanVersion: ScalingPlanVersion; 521 /** 522 * A CloudFormation stack or set of tags. For more information, see ApplicationSource in the AWS Auto Scaling API Reference. 523 */ 524 ApplicationSource?: ApplicationSource; 525 /** 526 * The scaling instructions. For more information, see ScalingInstruction in the AWS Auto Scaling API Reference. 527 */ 528 ScalingInstructions?: ScalingInstructions; 529 } 530 export interface UpdateScalingPlanResponse { 531 } 532 export type XmlString = string; 533 export type XmlStringMaxLen128 = string; 534 export type XmlStringMaxLen256 = string; 535 /** 536 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 537 */ 538 export type apiVersion = "2018-01-06"|"latest"|string; 539 export interface ClientApiVersions { 540 /** 541 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 542 */ 543 apiVersion?: apiVersion; 544 } 545 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 546 /** 547 * Contains interfaces for use with the AutoScalingPlans client. 548 */ 549 export import Types = AutoScalingPlans; 550 } 551 export = AutoScalingPlans;