root
/
gl-store-s3.js
mirror of https://github.com/cderche/greenlock-storage-s3
2
0
Fork 0
Code Issues 1 Releases Wiki Activity
gl-store-s3.js/node_modules/aws-sdk/clients/autoscaling.d.ts

2470 lines
142 KiB
TypeScript
Raw Normal View History

version 1
2019-05-08 10:43:08 +00:00
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class AutoScaling extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AutoScaling.Types.ClientConfiguration)
config: Config & AutoScaling.Types.ClientConfiguration;
/**
* Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups. For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachInstances(params: AutoScaling.Types.AttachInstancesQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups. For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attaches one or more target groups to the specified Auto Scaling group. To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups. With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachLoadBalancerTargetGroups(params: AutoScaling.Types.AttachLoadBalancerTargetGroupsType, callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType) => void): Request<AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType, AWSError>;
/**
* Attaches one or more target groups to the specified Auto Scaling group. To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups. With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType) => void): Request<AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType, AWSError>;
/**
* Attaches one or more Classic Load Balancers to the specified Auto Scaling group. To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups. To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachLoadBalancers(params: AutoScaling.Types.AttachLoadBalancersType, callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancersResultType) => void): Request<AutoScaling.Types.AttachLoadBalancersResultType, AWSError>;
/**
* Attaches one or more Classic Load Balancers to the specified Auto Scaling group. To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups. To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancersResultType) => void): Request<AutoScaling.Types.AttachLoadBalancersResultType, AWSError>;
/**
* Deletes one or more scheduled actions for the specified Auto Scaling group.
*/
batchDeleteScheduledAction(params: AutoScaling.Types.BatchDeleteScheduledActionType, callback?: (err: AWSError, data: AutoScaling.Types.BatchDeleteScheduledActionAnswer) => void): Request<AutoScaling.Types.BatchDeleteScheduledActionAnswer, AWSError>;
/**
* Deletes one or more scheduled actions for the specified Auto Scaling group.
*/
batchDeleteScheduledAction(callback?: (err: AWSError, data: AutoScaling.Types.BatchDeleteScheduledActionAnswer) => void): Request<AutoScaling.Types.BatchDeleteScheduledActionAnswer, AWSError>;
/**
* Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
*/
batchPutScheduledUpdateGroupAction(params: AutoScaling.Types.BatchPutScheduledUpdateGroupActionType, callback?: (err: AWSError, data: AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer) => void): Request<AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer, AWSError>;
/**
* Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
*/
batchPutScheduledUpdateGroupAction(callback?: (err: AWSError, data: AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer) => void): Request<AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer, AWSError>;
/**
* Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.
*/
completeLifecycleAction(params: AutoScaling.Types.CompleteLifecycleActionType, callback?: (err: AWSError, data: AutoScaling.Types.CompleteLifecycleActionAnswer) => void): Request<AutoScaling.Types.CompleteLifecycleActionAnswer, AWSError>;
/**
* Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.
*/
completeLifecycleAction(callback?: (err: AWSError, data: AutoScaling.Types.CompleteLifecycleActionAnswer) => void): Request<AutoScaling.Types.CompleteLifecycleActionAnswer, AWSError>;
/**
* Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.
*/
createAutoScalingGroup(params: AutoScaling.Types.CreateAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.
*/
createAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.
*/
createLaunchConfiguration(params: AutoScaling.Types.CreateLaunchConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.
*/
createLaunchConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
createOrUpdateTags(params: AutoScaling.Types.CreateOrUpdateTagsType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
createOrUpdateTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances. To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.
*/
deleteAutoScalingGroup(params: AutoScaling.Types.DeleteAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances. To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.
*/
deleteAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
*/
deleteLaunchConfiguration(params: AutoScaling.Types.LaunchConfigurationNameType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
*/
deleteLaunchConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
*/
deleteLifecycleHook(params: AutoScaling.Types.DeleteLifecycleHookType, callback?: (err: AWSError, data: AutoScaling.Types.DeleteLifecycleHookAnswer) => void): Request<AutoScaling.Types.DeleteLifecycleHookAnswer, AWSError>;
/**
* Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
*/
deleteLifecycleHook(callback?: (err: AWSError, data: AutoScaling.Types.DeleteLifecycleHookAnswer) => void): Request<AutoScaling.Types.DeleteLifecycleHookAnswer, AWSError>;
/**
* Deletes the specified notification.
*/
deleteNotificationConfiguration(params: AutoScaling.Types.DeleteNotificationConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified notification.
*/
deleteNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified scaling policy. Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
*/
deletePolicy(params: AutoScaling.Types.DeletePolicyType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified scaling policy. Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
*/
deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified scheduled action.
*/
deleteScheduledAction(params: AutoScaling.Types.DeleteScheduledActionType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified scheduled action.
*/
deleteScheduledAction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified tags.
*/
deleteTags(params: AutoScaling.Types.DeleteTagsType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified tags.
*/
deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Describes the current Amazon EC2 Auto Scaling resource limits for your AWS account. For information about requesting an increase in these limits, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.
*/
describeAccountLimits(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAccountLimitsAnswer) => void): Request<AutoScaling.Types.DescribeAccountLimitsAnswer, AWSError>;
/**
* Describes the policy adjustment types for use with PutScalingPolicy.
*/
describeAdjustmentTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAdjustmentTypesAnswer) => void): Request<AutoScaling.Types.DescribeAdjustmentTypesAnswer, AWSError>;
/**
* Describes one or more Auto Scaling groups.
*/
describeAutoScalingGroups(params: AutoScaling.Types.AutoScalingGroupNamesType, callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingGroupsType) => void): Request<AutoScaling.Types.AutoScalingGroupsType, AWSError>;
/**
* Describes one or more Auto Scaling groups.
*/
describeAutoScalingGroups(callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingGroupsType) => void): Request<AutoScaling.Types.AutoScalingGroupsType, AWSError>;
/**
* Describes one or more Auto Scaling instances.
*/
describeAutoScalingInstances(params: AutoScaling.Types.DescribeAutoScalingInstancesType, callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingInstancesType) => void): Request<AutoScaling.Types.AutoScalingInstancesType, AWSError>;
/**
* Describes one or more Auto Scaling instances.
*/
describeAutoScalingInstances(callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingInstancesType) => void): Request<AutoScaling.Types.AutoScalingInstancesType, AWSError>;
/**
* Describes the notification types that are supported by Amazon EC2 Auto Scaling.
*/
describeAutoScalingNotificationTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAutoScalingNotificationTypesAnswer) => void): Request<AutoScaling.Types.DescribeAutoScalingNotificationTypesAnswer, AWSError>;
/**
* Describes one or more launch configurations.
*/
describeLaunchConfigurations(params: AutoScaling.Types.LaunchConfigurationNamesType, callback?: (err: AWSError, data: AutoScaling.Types.LaunchConfigurationsType) => void): Request<AutoScaling.Types.LaunchConfigurationsType, AWSError>;
/**
* Describes one or more launch configurations.
*/
describeLaunchConfigurations(callback?: (err: AWSError, data: AutoScaling.Types.LaunchConfigurationsType) => void): Request<AutoScaling.Types.LaunchConfigurationsType, AWSError>;
/**
* Describes the available types of lifecycle hooks. The following hook types are supported: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING
*/
describeLifecycleHookTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHookTypesAnswer) => void): Request<AutoScaling.Types.DescribeLifecycleHookTypesAnswer, AWSError>;
/**
* Describes the lifecycle hooks for the specified Auto Scaling group.
*/
describeLifecycleHooks(params: AutoScaling.Types.DescribeLifecycleHooksType, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHooksAnswer) => void): Request<AutoScaling.Types.DescribeLifecycleHooksAnswer, AWSError>;
/**
* Describes the lifecycle hooks for the specified Auto Scaling group.
*/
describeLifecycleHooks(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHooksAnswer) => void): Request<AutoScaling.Types.DescribeLifecycleHooksAnswer, AWSError>;
/**
* Describes the target groups for the specified Auto Scaling group.
*/
describeLoadBalancerTargetGroups(params: AutoScaling.Types.DescribeLoadBalancerTargetGroupsRequest, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse) => void): Request<AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse, AWSError>;
/**
* Describes the target groups for the specified Auto Scaling group.
*/
describeLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse) => void): Request<AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse, AWSError>;
/**
* Describes the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead.
*/
describeLoadBalancers(params: AutoScaling.Types.DescribeLoadBalancersRequest, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancersResponse) => void): Request<AutoScaling.Types.DescribeLoadBalancersResponse, AWSError>;
/**
* Describes the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead.
*/
describeLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancersResponse) => void): Request<AutoScaling.Types.DescribeLoadBalancersResponse, AWSError>;
/**
* Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling. The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.
*/
describeMetricCollectionTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeMetricCollectionTypesAnswer) => void): Request<AutoScaling.Types.DescribeMetricCollectionTypesAnswer, AWSError>;
/**
* Describes the notification actions associated with the specified Auto Scaling group.
*/
describeNotificationConfigurations(params: AutoScaling.Types.DescribeNotificationConfigurationsType, callback?: (err: AWSError, data: AutoScaling.Types.DescribeNotificationConfigurationsAnswer) => void): Request<AutoScaling.Types.DescribeNotificationConfigurationsAnswer, AWSError>;
/**
* Describes the notification actions associated with the specified Auto Scaling group.
*/
describeNotificationConfigurations(callback?: (err: AWSError, data: AutoScaling.Types.DescribeNotificationConfigurationsAnswer) => void): Request<AutoScaling.Types.DescribeNotificationConfigurationsAnswer, AWSError>;
/**
* Describes the policies for the specified Auto Scaling group.
*/
describePolicies(params: AutoScaling.Types.DescribePoliciesType, callback?: (err: AWSError, data: AutoScaling.Types.PoliciesType) => void): Request<AutoScaling.Types.PoliciesType, AWSError>;
/**
* Describes the policies for the specified Auto Scaling group.
*/
describePolicies(callback?: (err: AWSError, data: AutoScaling.Types.PoliciesType) => void): Request<AutoScaling.Types.PoliciesType, AWSError>;
/**
* Describes one or more scaling activities for the specified Auto Scaling group.
*/
describeScalingActivities(params: AutoScaling.Types.DescribeScalingActivitiesType, callback?: (err: AWSError, data: AutoScaling.Types.ActivitiesType) => void): Request<AutoScaling.Types.ActivitiesType, AWSError>;
/**
* Describes one or more scaling activities for the specified Auto Scaling group.
*/
describeScalingActivities(callback?: (err: AWSError, data: AutoScaling.Types.ActivitiesType) => void): Request<AutoScaling.Types.ActivitiesType, AWSError>;
/**
* Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
*/
describeScalingProcessTypes(callback?: (err: AWSError, data: AutoScaling.Types.ProcessesType) => void): Request<AutoScaling.Types.ProcessesType, AWSError>;
/**
* Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
*/
describeScheduledActions(params: AutoScaling.Types.DescribeScheduledActionsType, callback?: (err: AWSError, data: AutoScaling.Types.ScheduledActionsType) => void): Request<AutoScaling.Types.ScheduledActionsType, AWSError>;
/**
* Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
*/
describeScheduledActions(callback?: (err: AWSError, data: AutoScaling.Types.ScheduledActionsType) => void): Request<AutoScaling.Types.ScheduledActionsType, AWSError>;
/**
* Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
*/
describeTags(params: AutoScaling.Types.DescribeTagsType, callback?: (err: AWSError, data: AutoScaling.Types.TagsType) => void): Request<AutoScaling.Types.TagsType, AWSError>;
/**
* Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
*/
describeTags(callback?: (err: AWSError, data: AutoScaling.Types.TagsType) => void): Request<AutoScaling.Types.TagsType, AWSError>;
/**
* Describes the termination policies supported by Amazon EC2 Auto Scaling. For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.
*/
describeTerminationPolicyTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeTerminationPolicyTypesAnswer) => void): Request<AutoScaling.Types.DescribeTerminationPolicyTypesAnswer, AWSError>;
/**
* Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
detachInstances(params: AutoScaling.Types.DetachInstancesQuery, callback?: (err: AWSError, data: AutoScaling.Types.DetachInstancesAnswer) => void): Request<AutoScaling.Types.DetachInstancesAnswer, AWSError>;
/**
* Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
detachInstances(callback?: (err: AWSError, data: AutoScaling.Types.DetachInstancesAnswer) => void): Request<AutoScaling.Types.DetachInstancesAnswer, AWSError>;
/**
* Detaches one or more target groups from the specified Auto Scaling group.
*/
detachLoadBalancerTargetGroups(params: AutoScaling.Types.DetachLoadBalancerTargetGroupsType, callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType) => void): Request<AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType, AWSError>;
/**
* Detaches one or more target groups from the specified Auto Scaling group.
*/
detachLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType) => void): Request<AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType, AWSError>;
/**
* Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running.
*/
detachLoadBalancers(params: AutoScaling.Types.DetachLoadBalancersType, callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancersResultType) => void): Request<AutoScaling.Types.DetachLoadBalancersResultType, AWSError>;
/**
* Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running.
*/
detachLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancersResultType) => void): Request<AutoScaling.Types.DetachLoadBalancersResultType, AWSError>;
/**
* Disables group metrics for the specified Auto Scaling group.
*/
disableMetricsCollection(params: AutoScaling.Types.DisableMetricsCollectionQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disables group metrics for the specified Auto Scaling group.
*/
disableMetricsCollection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
enableMetricsCollection(params: AutoScaling.Types.EnableMetricsCollectionQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
enableMetricsCollection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Moves the specified instances into the standby state. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
enterStandby(params: AutoScaling.Types.EnterStandbyQuery, callback?: (err: AWSError, data: AutoScaling.Types.EnterStandbyAnswer) => void): Request<AutoScaling.Types.EnterStandbyAnswer, AWSError>;
/**
* Moves the specified instances into the standby state. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
enterStandby(callback?: (err: AWSError, data: AutoScaling.Types.EnterStandbyAnswer) => void): Request<AutoScaling.Types.EnterStandbyAnswer, AWSError>;
/**
* Executes the specified policy.
*/
executePolicy(params: AutoScaling.Types.ExecutePolicyType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Executes the specified policy.
*/
executePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Moves the specified instances out of the standby state. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
exitStandby(params: AutoScaling.Types.ExitStandbyQuery, callback?: (err: AWSError, data: AutoScaling.Types.ExitStandbyAnswer) => void): Request<AutoScaling.Types.ExitStandbyAnswer, AWSError>;
/**
* Moves the specified instances out of the standby state. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
exitStandby(callback?: (err: AWSError, data: AutoScaling.Types.ExitStandbyAnswer) => void): Request<AutoScaling.Types.ExitStandbyAnswer, AWSError>;
/**
* Creates or updates a lifecycle hook for the specified Auto Scaling group. A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated). This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.
*/
putLifecycleHook(params: AutoScaling.Types.PutLifecycleHookType, callback?: (err: AWSError, data: AutoScaling.Types.PutLifecycleHookAnswer) => void): Request<AutoScaling.Types.PutLifecycleHookAnswer, AWSError>;
/**
* Creates or updates a lifecycle hook for the specified Auto Scaling group. A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated). This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.
*/
putLifecycleHook(callback?: (err: AWSError, data: AutoScaling.Types.PutLifecycleHookAnswer) => void): Request<AutoScaling.Types.PutLifecycleHookAnswer, AWSError>;
/**
* Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.
*/
putNotificationConfiguration(params: AutoScaling.Types.PutNotificationConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.
*/
putNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
*/
putScalingPolicy(params: AutoScaling.Types.PutScalingPolicyType, callback?: (err: AWSError, data: AutoScaling.Types.PolicyARNType) => void): Request<AutoScaling.Types.PolicyARNType, AWSError>;
/**
* Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
*/
putScalingPolicy(callback?: (err: AWSError, data: AutoScaling.Types.PolicyARNType) => void): Request<AutoScaling.Types.PolicyARNType, AWSError>;
/**
* Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.
*/
putScheduledUpdateGroupAction(params: AutoScaling.Types.PutScheduledUpdateGroupActionType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.
*/
putScheduledUpdateGroupAction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.
*/
recordLifecycleActionHeartbeat(params: AutoScaling.Types.RecordLifecycleActionHeartbeatType, callback?: (err: AWSError, data: AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer) => void): Request<AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer, AWSError>;
/**
* Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.
*/
recordLifecycleActionHeartbeat(callback?: (err: AWSError, data: AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer) => void): Request<AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer, AWSError>;
/**
* Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
*/
resumeProcesses(params: AutoScaling.Types.ScalingProcessQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
*/
resumeProcesses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the size of the specified Auto Scaling group. For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.
*/
setDesiredCapacity(params: AutoScaling.Types.SetDesiredCapacityType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the size of the specified Auto Scaling group. For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.
*/
setDesiredCapacity(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the health status of the specified instance. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
*/
setInstanceHealth(params: AutoScaling.Types.SetInstanceHealthQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the health status of the specified instance. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
*/
setInstanceHealth(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the instance protection settings of the specified instances. For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
*/
setInstanceProtection(params: AutoScaling.Types.SetInstanceProtectionQuery, callback?: (err: AWSError, data: AutoScaling.Types.SetInstanceProtectionAnswer) => void): Request<AutoScaling.Types.SetInstanceProtectionAnswer, AWSError>;
/**
* Updates the instance protection settings of the specified instances. For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
*/
setInstanceProtection(callback?: (err: AWSError, data: AutoScaling.Types.SetInstanceProtectionAnswer) => void): Request<AutoScaling.Types.SetInstanceProtectionAnswer, AWSError>;
/**
* Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group. If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. To resume processes that have been suspended, use ResumeProcesses. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
*/
suspendProcesses(params: AutoScaling.Types.ScalingProcessQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group. If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. To resume processes that have been suspended, use ResumeProcesses. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
*/
suspendProcesses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Terminates the specified instance and optionally adjusts the desired group size. This call simply makes a termination request. The instance is not terminated immediately.
*/
terminateInstanceInAutoScalingGroup(params: AutoScaling.Types.TerminateInstanceInAutoScalingGroupType, callback?: (err: AWSError, data: AutoScaling.Types.ActivityType) => void): Request<AutoScaling.Types.ActivityType, AWSError>;
/**
* Terminates the specified instance and optionally adjusts the desired group size. This call simply makes a termination request. The instance is not terminated immediately.
*/
terminateInstanceInAutoScalingGroup(callback?: (err: AWSError, data: AutoScaling.Types.ActivityType) => void): Request<AutoScaling.Types.ActivityType, AWSError>;
/**
* Updates the configuration for the specified Auto Scaling group. The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected. To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection. Note the following: If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize. If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize. All other optional parameters are left unchanged if not specified.
*/
updateAutoScalingGroup(params: AutoScaling.Types.UpdateAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the configuration for the specified Auto Scaling group. The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected. To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection. Note the following: If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize. If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize. All other optional parameters are left unchanged if not specified.
*/
updateAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace AutoScaling {
export type Activities = Activity[];
export interface ActivitiesType {
/**
* The scaling activities. Activities are sorted by start time. Activities still in progress are described first.
*/
Activities: Activities;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface Activity {
/**
* The ID of the activity.
*/
ActivityId: XmlString;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: XmlStringMaxLen255;
/**
* A friendly, more verbose description of the activity.
*/
Description?: XmlString;
/**
* The reason the activity began.
*/
Cause: XmlStringMaxLen1023;
/**
* The start time of the activity.
*/
StartTime: TimestampType;
/**
* The end time of the activity.
*/
EndTime?: TimestampType;
/**
* The current status of the activity.
*/
StatusCode: ScalingActivityStatusCode;
/**
* A friendly, more verbose description of the activity status.
*/
StatusMessage?: XmlStringMaxLen255;
/**
* A value between 0 and 100 that indicates the progress of the activity.
*/
Progress?: Progress;
/**
* The details about the activity.
*/
Details?: XmlString;
}
export type ActivityIds = XmlString[];
export interface ActivityType {
/**
* A scaling activity.
*/
Activity?: Activity;
}
export interface AdjustmentType {
/**
* The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
*/
AdjustmentType?: XmlStringMaxLen255;
}
export type AdjustmentTypes = AdjustmentType[];
export interface Alarm {
/**
* The name of the alarm.
*/
AlarmName?: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the alarm.
*/
AlarmARN?: ResourceName;
}
export type Alarms = Alarm[];
export type AsciiStringMaxLen255 = string;
export type AssociatePublicIpAddress = boolean;
export interface AttachInstancesQuery {
/**
* The IDs of the instances. You can specify up to 20 instances.
*/
InstanceIds?: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
}
export interface AttachLoadBalancerTargetGroupsResultType {
}
export interface AttachLoadBalancerTargetGroupsType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
*/
TargetGroupARNs: TargetGroupARNs;
}
export interface AttachLoadBalancersResultType {
}
export interface AttachLoadBalancersType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The names of the load balancers. You can specify up to 10 load balancers.
*/
LoadBalancerNames: LoadBalancerNames;
}
export interface AutoScalingGroup {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the Auto Scaling group.
*/
AutoScalingGroupARN?: ResourceName;
/**
* The name of the associated launch configuration.
*/
LaunchConfigurationName?: XmlStringMaxLen255;
/**
* The launch template for the group.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* The mixed instances policy for the group.
*/
MixedInstancesPolicy?: MixedInstancesPolicy;
/**
* The minimum size of the group.
*/
MinSize: AutoScalingGroupMinSize;
/**
* The maximum size of the group.
*/
MaxSize: AutoScalingGroupMaxSize;
/**
* The desired size of the group.
*/
DesiredCapacity: AutoScalingGroupDesiredCapacity;
/**
* The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
*/
DefaultCooldown: Cooldown;
/**
* One or more Availability Zones for the group.
*/
AvailabilityZones: AvailabilityZones;
/**
* One or more load balancers associated with the group.
*/
LoadBalancerNames?: LoadBalancerNames;
/**
* The Amazon Resource Names (ARN) of the target groups for your load balancer.
*/
TargetGroupARNs?: TargetGroupARNs;
/**
* The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
*/
HealthCheckType: XmlStringMaxLen32;
/**
* The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
*/
HealthCheckGracePeriod?: HealthCheckGracePeriod;
/**
* The EC2 instances associated with the group.
*/
Instances?: Instances;
/**
* The date and time the group was created.
*/
CreatedTime: TimestampType;
/**
* The suspended processes associated with the group.
*/
SuspendedProcesses?: SuspendedProcesses;
/**
* The name of the placement group into which to launch your instances, if any.
*/
PlacementGroup?: XmlStringMaxLen255;
/**
* One or more subnet IDs, if applicable, separated by commas.
*/
VPCZoneIdentifier?: XmlStringMaxLen2047;
/**
* The metrics enabled for the group.
*/
EnabledMetrics?: EnabledMetrics;
/**
* The current state of the group when DeleteAutoScalingGroup is in progress.
*/
Status?: XmlStringMaxLen255;
/**
* The tags for the group.
*/
Tags?: TagDescriptionList;
/**
* The termination policies for the group.
*/
TerminationPolicies?: TerminationPolicies;
/**
* Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
*/
NewInstancesProtectedFromScaleIn?: InstanceProtected;
/**
* The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
*/
ServiceLinkedRoleARN?: ResourceName;
}
export type AutoScalingGroupDesiredCapacity = number;
export type AutoScalingGroupMaxSize = number;
export type AutoScalingGroupMinSize = number;
export type AutoScalingGroupNames = ResourceName[];
export interface AutoScalingGroupNamesType {
/**
* The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter. If you omit this parameter, all Auto Scaling groups are described.
*/
AutoScalingGroupNames?: AutoScalingGroupNames;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export type AutoScalingGroups = AutoScalingGroup[];
export interface AutoScalingGroupsType {
/**
* The groups.
*/
AutoScalingGroups: AutoScalingGroups;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface AutoScalingInstanceDetails {
/**
* The ID of the instance.
*/
InstanceId: XmlStringMaxLen19;
/**
* The name of the Auto Scaling group for the instance.
*/
AutoScalingGroupName: XmlStringMaxLen255;
/**
* The Availability Zone for the instance.
*/
AvailabilityZone: XmlStringMaxLen255;
/**
* The lifecycle state for the instance.
*/
LifecycleState: XmlStringMaxLen32;
/**
* The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
*/
HealthStatus: XmlStringMaxLen32;
/**
* The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
*/
LaunchConfigurationName?: XmlStringMaxLen255;
/**
* The launch template for the instance.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
*/
ProtectedFromScaleIn: InstanceProtected;
}
export type AutoScalingInstances = AutoScalingInstanceDetails[];
export interface AutoScalingInstancesType {
/**
* The instances.
*/
AutoScalingInstances?: AutoScalingInstances;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export type AutoScalingNotificationTypes = XmlStringMaxLen255[];
export type AvailabilityZones = XmlStringMaxLen255[];
export interface BatchDeleteScheduledActionAnswer {
/**
* The names of the scheduled actions that could not be deleted, including an error message.
*/
FailedScheduledActions?: FailedScheduledUpdateGroupActionRequests;
}
export interface BatchDeleteScheduledActionType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The names of the scheduled actions to delete. The maximum number allowed is 50.
*/
ScheduledActionNames: ScheduledActionNames;
}
export interface BatchPutScheduledUpdateGroupActionAnswer {
/**
* The names of the scheduled actions that could not be created or updated, including an error message.
*/
FailedScheduledUpdateGroupActions?: FailedScheduledUpdateGroupActionRequests;
}
export interface BatchPutScheduledUpdateGroupActionType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* One or more scheduled actions. The maximum number allowed is 50.
*/
ScheduledUpdateGroupActions: ScheduledUpdateGroupActionRequests;
}
export type BlockDeviceEbsDeleteOnTermination = boolean;
export type BlockDeviceEbsEncrypted = boolean;
export type BlockDeviceEbsIops = number;
export type BlockDeviceEbsVolumeSize = number;
export type BlockDeviceEbsVolumeType = string;
export interface BlockDeviceMapping {
/**
* The name of the virtual device (for example, ephemeral0).
*/
VirtualName?: XmlStringMaxLen255;
/**
* The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances.
*/
DeviceName: XmlStringMaxLen255;
/**
* The information about the Amazon EBS volume.
*/
Ebs?: Ebs;
/**
* Suppresses a device mapping. If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.
*/
NoDevice?: NoDevice;
}
export type BlockDeviceMappings = BlockDeviceMapping[];
export type ClassicLinkVPCSecurityGroups = XmlStringMaxLen255[];
export interface CompleteLifecycleActionAnswer {
}
export interface CompleteLifecycleActionType {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
*/
LifecycleActionToken?: LifecycleActionToken;
/**
* The action for the group to take. This parameter can be either CONTINUE or ABANDON.
*/
LifecycleActionResult: LifecycleActionResult;
/**
* The ID of the instance.
*/
InstanceId?: XmlStringMaxLen19;
}
export type Cooldown = number;
export interface CreateAutoScalingGroupType {
/**
* The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.
*/
AutoScalingGroupName: XmlStringMaxLen255;
/**
* The name of the launch configuration. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified. For more information, see Creating an Auto Scaling Group Using a Launch Configuration in the Amazon EC2 Auto Scaling User Guide.
*/
LaunchConfigurationName?: ResourceName;
/**
* The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified. For more information, see Creating an Auto Scaling Group Using a Launch Template in the Amazon EC2 Auto Scaling User Guide.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified. For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.
*/
MixedInstancesPolicy?: MixedInstancesPolicy;
/**
* The ID of the instance used to create a launch configuration for the group. This parameter, a launch configuration, a launch template, or a mixed instances policy must be specified. When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping. For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.
*/
InstanceId?: XmlStringMaxLen19;
/**
* The minimum size of the group.
*/
MinSize: AutoScalingGroupMinSize;
/**
* The maximum size of the group.
*/
MaxSize: AutoScalingGroupMaxSize;
/**
* The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
/**
* The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
*/
DefaultCooldown?: Cooldown;
/**
* One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier. Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
*/
AvailabilityZones?: AvailabilityZones;
/**
* One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use TargetGroupARNs instead. For more information, see Using a Load Balancer With an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
LoadBalancerNames?: LoadBalancerNames;
/**
* The Amazon Resource Names (ARN) of the target groups.
*/
TargetGroupARNs?: TargetGroupARNs;
/**
* The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
*/
HealthCheckType?: XmlStringMaxLen32;
/**
* The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is 0. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you are adding an ELB health check.
*/
HealthCheckGracePeriod?: HealthCheckGracePeriod;
/**
* The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
*/
PlacementGroup?: XmlStringMaxLen255;
/**
* A comma-separated list of subnet IDs for your virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones. Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
*/
VPCZoneIdentifier?: XmlStringMaxLen2047;
/**
* One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed. For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
*/
TerminationPolicies?: TerminationPolicies;
/**
* Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
*/
NewInstancesProtectedFromScaleIn?: InstanceProtected;
/**
* One or more lifecycle hooks.
*/
LifecycleHookSpecificationList?: LifecycleHookSpecifications;
/**
* One or more tags. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
Tags?: Tags;
/**
* The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
*/
ServiceLinkedRoleARN?: ResourceName;
}
export interface CreateLaunchConfigurationType {
/**
* The name of the launch configuration. This name must be unique within the scope of your AWS account.
*/
LaunchConfigurationName: XmlStringMaxLen255;
/**
* The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. If you do not specify InstanceId, you must specify ImageId. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
*/
ImageId?: XmlStringMaxLen255;
/**
* The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
*/
KeyName?: XmlStringMaxLen255;
/**
* One or more security groups with which to associate the instances. If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances. If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
*/
SecurityGroups?: SecurityGroups;
/**
* The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
*/
ClassicLinkVPCId?: XmlStringMaxLen255;
/**
* The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise.
*/
ClassicLinkVPCSecurityGroups?: ClassicLinkVPCSecurityGroups;
/**
* The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.
*/
UserData?: XmlStringUserData;
/**
* The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping. If you do not specify InstanceId, you must specify both ImageId and InstanceType. To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request. For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.
*/
InstanceId?: XmlStringMaxLen19;
/**
* The instance type of the EC2 instance. If you do not specify InstanceId, you must specify InstanceType. For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
*/
InstanceType?: XmlStringMaxLen255;
/**
* The ID of the kernel associated with the AMI.
*/
KernelId?: XmlStringMaxLen255;
/**
* The ID of the RAM disk associated with the AMI.
*/
RamdiskId?: XmlStringMaxLen255;
/**
* One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
*/
BlockDeviceMappings?: BlockDeviceMappings;
/**
* Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default value is true.
*/
InstanceMonitoring?: InstanceMonitoring;
/**
* The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
SpotPrice?: SpotPrice;
/**
* The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Use an IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.
*/
IamInstanceProfile?: XmlStringMaxLen1600;
/**
* Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.
*/
EbsOptimized?: EbsOptimized;
/**
* Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide. If you specify this parameter, be sure to specify at least one subnet when you create your group. Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.
*/
AssociatePublicIpAddress?: AssociatePublicIpAddress;
/**
* The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC. To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated. If you specify this parameter, be sure to specify at least one subnet when you create your group. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide. Valid values: default | dedicated
*/
PlacementTenancy?: XmlStringMaxLen64;
}
export interface CreateOrUpdateTagsType {
/**
* One or more tags.
*/
Tags: Tags;
}
export interface CustomizedMetricSpecification {
/**
* The name of the metric.
*/
MetricName: MetricName;
/**
* The namespace of the metric.
*/
Namespace: MetricNamespace;
/**
* The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
*/
Dimensions?: MetricDimensions;
/**
* The statistic of the metric.
*/
Statistic: MetricStatistic;
/**
* The unit of the metric.
*/
Unit?: MetricUnit;
}
export interface DeleteAutoScalingGroupType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
*/
ForceDelete?: ForceDelete;
}
export interface DeleteLifecycleHookAnswer {
}
export interface DeleteLifecycleHookType {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
}
export interface DeleteNotificationConfigurationType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
*/
TopicARN: ResourceName;
}
export interface DeletePolicyType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The name or Amazon Resource Name (ARN) of the policy.
*/
PolicyName: ResourceName;
}
export interface DeleteScheduledActionType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The name of the action to delete.
*/
ScheduledActionName: ResourceName;
}
export interface DeleteTagsType {
/**
* One or more tags.
*/
Tags: Tags;
}
export interface DescribeAccountLimitsAnswer {
/**
* The maximum number of groups allowed for your AWS account. The default limit is 200 per region.
*/
MaxNumberOfAutoScalingGroups?: MaxNumberOfAutoScalingGroups;
/**
* The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per region.
*/
MaxNumberOfLaunchConfigurations?: MaxNumberOfLaunchConfigurations;
/**
* The current number of groups for your AWS account.
*/
NumberOfAutoScalingGroups?: NumberOfAutoScalingGroups;
/**
* The current number of launch configurations for your AWS account.
*/
NumberOfLaunchConfigurations?: NumberOfLaunchConfigurations;
}
export interface DescribeAdjustmentTypesAnswer {
/**
* The policy adjustment types.
*/
AdjustmentTypes?: AdjustmentTypes;
}
export interface DescribeAutoScalingInstancesType {
/**
* The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
*/
InstanceIds?: InstanceIds;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.
*/
MaxRecords?: MaxRecords;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
}
export interface DescribeAutoScalingNotificationTypesAnswer {
/**
* The notification types.
*/
AutoScalingNotificationTypes?: AutoScalingNotificationTypes;
}
export interface DescribeLifecycleHookTypesAnswer {
/**
* The lifecycle hook types.
*/
LifecycleHookTypes?: AutoScalingNotificationTypes;
}
export interface DescribeLifecycleHooksAnswer {
/**
* The lifecycle hooks for the specified group.
*/
LifecycleHooks?: LifecycleHooks;
}
export interface DescribeLifecycleHooksType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.
*/
LifecycleHookNames?: LifecycleHookNames;
}
export interface DescribeLoadBalancerTargetGroupsRequest {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeLoadBalancerTargetGroupsResponse {
/**
* Information about the target groups.
*/
LoadBalancerTargetGroups?: LoadBalancerTargetGroupStates;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface DescribeLoadBalancersRequest {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeLoadBalancersResponse {
/**
* The load balancers.
*/
LoadBalancers?: LoadBalancerStates;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface DescribeMetricCollectionTypesAnswer {
/**
* One or more metrics.
*/
Metrics?: MetricCollectionTypes;
/**
* The granularities for the metrics.
*/
Granularities?: MetricGranularityTypes;
}
export interface DescribeNotificationConfigurationsAnswer {
/**
* The notification configurations.
*/
NotificationConfigurations: NotificationConfigurations;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface DescribeNotificationConfigurationsType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupNames?: AutoScalingGroupNames;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribePoliciesType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.
*/
PolicyNames?: PolicyNames;
/**
* One or more policy types. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
*/
PolicyTypes?: PolicyTypes;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeScalingActivitiesType {
/**
* The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
*/
ActivityIds?: ActivityIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
}
export interface DescribeScheduledActionsType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
*/
ScheduledActionNames?: ScheduledActionNames;
/**
* The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
*/
StartTime?: TimestampType;
/**
* The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
*/
EndTime?: TimestampType;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeTagsType {
/**
* One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.
*/
Filters?: Filters;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeTerminationPolicyTypesAnswer {
/**
* The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy.
*/
TerminationPolicyTypes?: TerminationPolicies;
}
export interface DetachInstancesAnswer {
/**
* The activities related to detaching the instances from the Auto Scaling group.
*/
Activities?: Activities;
}
export interface DetachInstancesQuery {
/**
* The IDs of the instances. You can specify up to 20 instances.
*/
InstanceIds?: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.
*/
ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity;
}
export interface DetachLoadBalancerTargetGroupsResultType {
}
export interface DetachLoadBalancerTargetGroupsType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
*/
TargetGroupARNs: TargetGroupARNs;
}
export interface DetachLoadBalancersResultType {
}
export interface DetachLoadBalancersType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The names of the load balancers. You can specify up to 10 load balancers.
*/
LoadBalancerNames: LoadBalancerNames;
}
export interface DisableMetricsCollectionQuery {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* One or more of the following metrics. If you omit this parameter, all metrics are disabled. GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances
*/
Metrics?: Metrics;
}
export type DisableScaleIn = boolean;
export interface Ebs {
/**
* The ID of the snapshot. This parameter is optional if you specify a volume size.
*/
SnapshotId?: XmlStringMaxLen255;
/**
* The volume size, in GiB. Constraints: 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size. At least one of VolumeSize or SnapshotId is required.
*/
VolumeSize?: BlockDeviceEbsVolumeSize;
/**
* The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances. Valid values: standard | io1 | gp2 | st1 | sc1
*/
VolumeType?: BlockDeviceEbsVolumeType;
/**
* Indicates whether the volume is deleted on instance termination. The default value is true.
*/
DeleteOnTermination?: BlockDeviceEbsDeleteOnTermination;
/**
* The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances. Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)
*/
Iops?: BlockDeviceEbsIops;
/**
* Specifies whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.
*/
Encrypted?: BlockDeviceEbsEncrypted;
}
export type EbsOptimized = boolean;
export interface EnableMetricsCollectionQuery {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* One or more of the following metrics. If you omit this parameter, all metrics are enabled. GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances
*/
Metrics?: Metrics;
/**
* The granularity to associate with the metrics to collect. The only valid value is 1Minute.
*/
Granularity: XmlStringMaxLen255;
}
export interface EnabledMetric {
/**
* One of the following metrics: GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances
*/
Metric?: XmlStringMaxLen255;
/**
* The granularity of the metric. The only valid value is 1Minute.
*/
Granularity?: XmlStringMaxLen255;
}
export type EnabledMetrics = EnabledMetric[];
export interface EnterStandbyAnswer {
/**
* The activities related to moving instances into Standby mode.
*/
Activities?: Activities;
}
export interface EnterStandbyQuery {
/**
* The IDs of the instances. You can specify up to 20 instances.
*/
InstanceIds?: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.
*/
ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity;
}
export type EstimatedInstanceWarmup = number;
export interface ExecutePolicyType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The name or ARN of the policy.
*/
PolicyName: ResourceName;
/**
* Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy. This parameter is not supported if the policy type is StepScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
*/
HonorCooldown?: HonorCooldown;
/**
* The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59. If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error. Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.
*/
MetricValue?: MetricScale;
/**
* The breach threshold for the alarm. Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.
*/
BreachThreshold?: MetricScale;
}
export interface ExitStandbyAnswer {
/**
* The activities related to moving instances out of Standby mode.
*/
Activities?: Activities;
}
export interface ExitStandbyQuery {
/**
* The IDs of the instances. You can specify up to 20 instances.
*/
InstanceIds?: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
}
export interface FailedScheduledUpdateGroupActionRequest {
/**
* The name of the scheduled action.
*/
ScheduledActionName: XmlStringMaxLen255;
/**
* The error code.
*/
ErrorCode?: XmlStringMaxLen64;
/**
* The error message accompanying the error code.
*/
ErrorMessage?: XmlString;
}
export type FailedScheduledUpdateGroupActionRequests = FailedScheduledUpdateGroupActionRequest[];
export interface Filter {
/**
* The name of the filter. The valid values are: "auto-scaling-group", "key", "value", and "propagate-at-launch".
*/
Name?: XmlString;
/**
* The value of the filter.
*/
Values?: Values;
}
export type Filters = Filter[];
export type ForceDelete = boolean;
export type GlobalTimeout = number;
export type HealthCheckGracePeriod = number;
export type HeartbeatTimeout = number;
export type HonorCooldown = boolean;
export interface Instance {
/**
* The ID of the instance.
*/
InstanceId: XmlStringMaxLen19;
/**
* The Availability Zone in which the instance is running.
*/
AvailabilityZone: XmlStringMaxLen255;
/**
* A description of the current lifecycle state. The Quarantined state is not used.
*/
LifecycleState: LifecycleState;
/**
* The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
*/
HealthStatus: XmlStringMaxLen32;
/**
* The launch configuration associated with the instance.
*/
LaunchConfigurationName?: XmlStringMaxLen255;
/**
* The launch template for the instance.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
*/
ProtectedFromScaleIn: InstanceProtected;
}
export type InstanceIds = XmlStringMaxLen19[];
export interface InstanceMonitoring {
/**
* If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
*/
Enabled?: MonitoringEnabled;
}
export type InstanceProtected = boolean;
export type Instances = Instance[];
export interface InstancesDistribution {
/**
* Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.
*/
OnDemandAllocationStrategy?: XmlString;
/**
* The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales. The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.
*/
OnDemandBaseCapacity?: OnDemandBaseCapacity;
/**
* Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.
*/
OnDemandPercentageAboveBaseCapacity?: OnDemandPercentageAboveBaseCapacity;
/**
* Indicates how to allocate Spot capacity across Spot pools. The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.
*/
SpotAllocationStrategy?: XmlString;
/**
* The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate. The range is 1–20 and the default is 2.
*/
SpotInstancePools?: SpotInstancePools;
/**
* The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price. To remove a value that you previously set, include the parameter but leave the value blank.
*/
SpotMaxPrice?: MixedInstanceSpotPrice;
}
export interface LaunchConfiguration {
/**
* The name of the launch configuration.
*/
LaunchConfigurationName: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the launch configuration.
*/
LaunchConfigurationARN?: ResourceName;
/**
* The ID of the Amazon Machine Image (AMI).
*/
ImageId: XmlStringMaxLen255;
/**
* The name of the key pair.
*/
KeyName?: XmlStringMaxLen255;
/**
* The security groups to associate with the instances.
*/
SecurityGroups?: SecurityGroups;
/**
* The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
*/
ClassicLinkVPCId?: XmlStringMaxLen255;
/**
* The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise.
*/
ClassicLinkVPCSecurityGroups?: ClassicLinkVPCSecurityGroups;
/**
* The user data available to the instances.
*/
UserData?: XmlStringUserData;
/**
* The instance type for the instances.
*/
InstanceType: XmlStringMaxLen255;
/**
* The ID of the kernel associated with the AMI.
*/
KernelId?: XmlStringMaxLen255;
/**
* The ID of the RAM disk associated with the AMI.
*/
RamdiskId?: XmlStringMaxLen255;
/**
* A block device mapping, which specifies the block devices for the instance.
*/
BlockDeviceMappings?: BlockDeviceMappings;
/**
* Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
*/
InstanceMonitoring?: InstanceMonitoring;
/**
* The price to bid when launching Spot Instances.
*/
SpotPrice?: SpotPrice;
/**
* The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
*/
IamInstanceProfile?: XmlStringMaxLen1600;
/**
* The creation date and time for the launch configuration.
*/
CreatedTime: TimestampType;
/**
* Controls whether the instance is optimized for EBS I/O (true) or not (false).
*/
EbsOptimized?: EbsOptimized;
/**
* [EC2-VPC] Indicates whether to assign a public IP address to each instance.
*/
AssociatePublicIpAddress?: AssociatePublicIpAddress;
/**
* The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.
*/
PlacementTenancy?: XmlStringMaxLen64;
}
export interface LaunchConfigurationNameType {
/**
* The name of the launch configuration.
*/
LaunchConfigurationName: ResourceName;
}
export type LaunchConfigurationNames = ResourceName[];
export interface LaunchConfigurationNamesType {
/**
* The launch configuration names. If you omit this parameter, all launch configurations are described.
*/
LaunchConfigurationNames?: LaunchConfigurationNames;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export type LaunchConfigurations = LaunchConfiguration[];
export interface LaunchConfigurationsType {
/**
* The launch configurations.
*/
LaunchConfigurations: LaunchConfigurations;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface LaunchTemplate {
/**
* The launch template to use. You must specify either the launch template ID or launch template name in the request.
*/
LaunchTemplateSpecification?: LaunchTemplateSpecification;
/**
* Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You must specify between 2 and 20 overrides.
*/
Overrides?: Overrides;
}
export type LaunchTemplateName = string;
export interface LaunchTemplateOverrides {
/**
* The instance type. For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
*/
InstanceType?: XmlStringMaxLen255;
}
export interface LaunchTemplateSpecification {
/**
* The ID of the launch template. You must specify either a template ID or a template name.
*/
LaunchTemplateId?: XmlStringMaxLen255;
/**
* The name of the launch template. You must specify either a template name or a template ID.
*/
LaunchTemplateName?: LaunchTemplateName;
/**
* The version number, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
*/
Version?: XmlStringMaxLen255;
}
export type LifecycleActionResult = string;
export type LifecycleActionToken = string;
export interface LifecycleHook {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName?: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group for the lifecycle hook.
*/
AutoScalingGroupName?: ResourceName;
/**
* The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING
*/
LifecycleTransition?: LifecycleTransition;
/**
* The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
*/
NotificationTargetARN?: ResourceName;
/**
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
*/
RoleARN?: ResourceName;
/**
* Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
NotificationMetadata?: XmlStringMaxLen1023;
/**
* The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.
*/
HeartbeatTimeout?: HeartbeatTimeout;
/**
* The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.
*/
GlobalTimeout?: GlobalTimeout;
/**
* Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.
*/
DefaultResult?: LifecycleActionResult;
}
export type LifecycleHookNames = AsciiStringMaxLen255[];
export interface LifecycleHookSpecification {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING
*/
LifecycleTransition: LifecycleTransition;
/**
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
NotificationMetadata?: XmlStringMaxLen1023;
/**
* The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
*/
HeartbeatTimeout?: HeartbeatTimeout;
/**
* Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is ABANDON.
*/
DefaultResult?: LifecycleActionResult;
/**
* The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
*/
NotificationTargetARN?: NotificationTargetResourceName;
/**
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
*/
RoleARN?: ResourceName;
}
export type LifecycleHookSpecifications = LifecycleHookSpecification[];
export type LifecycleHooks = LifecycleHook[];
export type LifecycleState = "Pending"|"Pending:Wait"|"Pending:Proceed"|"Quarantined"|"InService"|"Terminating"|"Terminating:Wait"|"Terminating:Proceed"|"Terminated"|"Detaching"|"Detached"|"EnteringStandby"|"Standby"|string;
export type LifecycleTransition = string;
export type LoadBalancerNames = XmlStringMaxLen255[];
export interface LoadBalancerState {
/**
* The name of the load balancer.
*/
LoadBalancerName?: XmlStringMaxLen255;
/**
* One of the following load balancer states: Adding - The instances in the group are being registered with the load balancer. Added - All instances in the group are registered with the load balancer. InService - At least one instance in the group passed an ELB health check. Removing - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances. Removed - All instances in the group are deregistered from the load balancer.
*/
State?: XmlStringMaxLen255;
}
export type LoadBalancerStates = LoadBalancerState[];
export interface LoadBalancerTargetGroupState {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
LoadBalancerTargetGroupARN?: XmlStringMaxLen511;
/**
* The state of the target group. Adding - The Auto Scaling instances are being registered with the target group. Added - All Auto Scaling instances are registered with the target group. InService - At least one Auto Scaling instance passed an ELB health check. Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances. Removed - All Auto Scaling instances are deregistered from the target group.
*/
State?: XmlStringMaxLen255;
}
export type LoadBalancerTargetGroupStates = LoadBalancerTargetGroupState[];
export type MaxNumberOfAutoScalingGroups = number;
export type MaxNumberOfLaunchConfigurations = number;
export type MaxRecords = number;
export interface MetricCollectionType {
/**
* One of the following metrics: GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances
*/
Metric?: XmlStringMaxLen255;
}
export type MetricCollectionTypes = MetricCollectionType[];
export interface MetricDimension {
/**
* The name of the dimension.
*/
Name: MetricDimensionName;
/**
* The value of the dimension.
*/
Value: MetricDimensionValue;
}
export type MetricDimensionName = string;
export type MetricDimensionValue = string;
export type MetricDimensions = MetricDimension[];
export interface MetricGranularityType {
/**
* The granularity. The only valid value is 1Minute.
*/
Granularity?: XmlStringMaxLen255;
}
export type MetricGranularityTypes = MetricGranularityType[];
export type MetricName = string;
export type MetricNamespace = string;
export type MetricScale = number;
export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string;
export type MetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"ALBRequestCountPerTarget"|string;
export type MetricUnit = string;
export type Metrics = XmlStringMaxLen255[];
export type MinAdjustmentMagnitude = number;
export type MinAdjustmentStep = number;
export type MixedInstanceSpotPrice = string;
export interface MixedInstancesPolicy {
/**
* The launch template and overrides. This parameter is required when creating an Auto Scaling group with a mixed instances policy, but is not required when updating the group.
*/
LaunchTemplate?: LaunchTemplate;
/**
* The instances distribution to use. If you leave this parameter unspecified when creating the group, the default values are used.
*/
InstancesDistribution?: InstancesDistribution;
}
export type MonitoringEnabled = boolean;
export type NoDevice = boolean;
export interface NotificationConfiguration {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
*/
TopicARN?: ResourceName;
/**
* One of the following event notification types: autoscaling:EC2_INSTANCE_LAUNCH autoscaling:EC2_INSTANCE_LAUNCH_ERROR autoscaling:EC2_INSTANCE_TERMINATE autoscaling:EC2_INSTANCE_TERMINATE_ERROR autoscaling:TEST_NOTIFICATION
*/
NotificationType?: XmlStringMaxLen255;
}
export type NotificationConfigurations = NotificationConfiguration[];
export type NotificationTargetResourceName = string;
export type NumberOfAutoScalingGroups = number;
export type NumberOfLaunchConfigurations = number;
export type OnDemandBaseCapacity = number;
export type OnDemandPercentageAboveBaseCapacity = number;
export type Overrides = LaunchTemplateOverrides[];
export interface PoliciesType {
/**
* The scaling policies.
*/
ScalingPolicies?: ScalingPolicies;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface PolicyARNType {
/**
* The Amazon Resource Name (ARN) of the policy.
*/
PolicyARN?: ResourceName;
/**
* The CloudWatch alarms created for the target tracking scaling policy.
*/
Alarms?: Alarms;
}
export type PolicyIncrement = number;
export type PolicyNames = ResourceName[];
export type PolicyTypes = XmlStringMaxLen64[];
export interface PredefinedMetricSpecification {
/**
* The metric type.
*/
PredefinedMetricType: MetricType;
/**
* Identifies the resource associated with the metric type. The following predefined metrics are available: ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group. ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group. ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group. ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer or a Network Load Balancer target group. For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: 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, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
*/
ResourceLabel?: XmlStringMaxLen1023;
}
export type ProcessNames = XmlStringMaxLen255[];
export interface ProcessType {
/**
* One of the following processes: Launch Terminate AddToLoadBalancer AlarmNotification AZRebalance HealthCheck ReplaceUnhealthy ScheduledActions
*/
ProcessName: XmlStringMaxLen255;
}
export type Processes = ProcessType[];
export interface ProcessesType {
/**
* The names of the process types.
*/
Processes?: Processes;
}
export type Progress = number;
export type PropagateAtLaunch = boolean;
export type ProtectedFromScaleIn = boolean;
export interface PutLifecycleHookAnswer {
}
export interface PutLifecycleHookType {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The instance state to which you want to attach the lifecycle hook. The valid values are: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
*/
LifecycleTransition?: LifecycleTransition;
/**
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
*/
RoleARN?: ResourceName;
/**
* The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN. This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic. When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".
*/
NotificationTargetARN?: NotificationTargetResourceName;
/**
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
NotificationMetadata?: XmlStringMaxLen1023;
/**
* The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
*/
HeartbeatTimeout?: HeartbeatTimeout;
/**
* Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.
*/
DefaultResult?: LifecycleActionResult;
}
export interface PutNotificationConfigurationType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
*/
TopicARN: ResourceName;
/**
* The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes.
*/
NotificationTypes: AutoScalingNotificationTypes;
}
export interface PutScalingPolicyType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The name of the policy.
*/
PolicyName: XmlStringMaxLen255;
/**
* The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
*/
PolicyType?: XmlStringMaxLen64;
/**
* The adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. This parameter is supported if the policy type is SimpleScaling or StepScaling. For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.
*/
AdjustmentType?: XmlStringMaxLen255;
/**
* Available for backward compatibility. Use MinAdjustmentMagnitude instead.
*/
MinAdjustmentStep?: MinAdjustmentStep;
/**
* The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError. This parameter is supported if the policy type is SimpleScaling or StepScaling.
*/
MinAdjustmentMagnitude?: MinAdjustmentMagnitude;
/**
* The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. Conditional: This parameter is required if the policy type is SimpleScaling and not supported otherwise.
*/
ScalingAdjustment?: PolicyIncrement;
/**
* The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies. This parameter is supported if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
*/
Cooldown?: Cooldown;
/**
* The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. This parameter is supported if the policy type is StepScaling.
*/
MetricAggregationType?: XmlStringMaxLen32;
/**
* A set of adjustments that enable you to scale based on the size of the alarm breach. Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.
*/
StepAdjustments?: StepAdjustments;
/**
* The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group. This parameter is supported if the policy type is StepScaling or TargetTrackingScaling.
*/
EstimatedInstanceWarmup?: EstimatedInstanceWarmup;
/**
* A target tracking scaling policy. Includes support for predefined or customized metrics. Conditional: This parameter is required if the policy type is TargetTrackingScaling and not supported otherwise.
*/
TargetTrackingConfiguration?: TargetTrackingConfiguration;
}
export interface PutScheduledUpdateGroupActionType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The name of this scaling action.
*/
ScheduledActionName: XmlStringMaxLen255;
/**
* This parameter is deprecated.
*/
Time?: TimestampType;
/**
* The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence. If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
*/
StartTime?: TimestampType;
/**
* The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
*/
EndTime?: TimestampType;
/**
* The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.
*/
Recurrence?: XmlStringMaxLen255;
/**
* The minimum size for the Auto Scaling group.
*/
MinSize?: AutoScalingGroupMinSize;
/**
* The maximum size for the Auto Scaling group.
*/
MaxSize?: AutoScalingGroupMaxSize;
/**
* The number of EC2 instances that should be running in the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
}
export interface RecordLifecycleActionHeartbeatAnswer {
}
export interface RecordLifecycleActionHeartbeatType {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.
*/
LifecycleActionToken?: LifecycleActionToken;
/**
* The ID of the instance.
*/
InstanceId?: XmlStringMaxLen19;
}
export type ResourceName = string;
export type ScalingActivityStatusCode = "PendingSpotBidPlacement"|"WaitingForSpotInstanceRequestId"|"WaitingForSpotInstanceId"|"WaitingForInstanceId"|"PreInService"|"InProgress"|"WaitingForELBConnectionDraining"|"MidLifecycleAction"|"WaitingForInstanceWarmup"|"Successful"|"Failed"|"Cancelled"|string;
export type ScalingPolicies = ScalingPolicy[];
export interface ScalingPolicy {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: XmlStringMaxLen255;
/**
* The name of the scaling policy.
*/
PolicyName?: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the policy.
*/
PolicyARN?: ResourceName;
/**
* The policy type. The valid values are SimpleScaling and StepScaling.
*/
PolicyType?: XmlStringMaxLen64;
/**
* The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
*/
AdjustmentType?: XmlStringMaxLen255;
/**
* Available for backward compatibility. Use MinAdjustmentMagnitude instead.
*/
MinAdjustmentStep?: MinAdjustmentStep;
/**
* The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
*/
MinAdjustmentMagnitude?: MinAdjustmentMagnitude;
/**
* The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
*/
ScalingAdjustment?: PolicyIncrement;
/**
* The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
*/
Cooldown?: Cooldown;
/**
* A set of adjustments that enable you to scale based on the size of the alarm breach.
*/
StepAdjustments?: StepAdjustments;
/**
* The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
*/
MetricAggregationType?: XmlStringMaxLen32;
/**
* The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
*/
EstimatedInstanceWarmup?: EstimatedInstanceWarmup;
/**
* The CloudWatch alarms related to the policy.
*/
Alarms?: Alarms;
/**
* A target tracking scaling policy.
*/
TargetTrackingConfiguration?: TargetTrackingConfiguration;
}
export interface ScalingProcessQuery {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* One or more of the following processes. If you omit this parameter, all processes are specified. Launch Terminate HealthCheck ReplaceUnhealthy AZRebalance AlarmNotification ScheduledActions AddToLoadBalancer
*/
ScalingProcesses?: ProcessNames;
}
export type ScheduledActionNames = ResourceName[];
export interface ScheduledActionsType {
/**
* The scheduled actions.
*/
ScheduledUpdateGroupActions?: ScheduledUpdateGroupActions;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface ScheduledUpdateGroupAction {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: XmlStringMaxLen255;
/**
* The name of the scheduled action.
*/
ScheduledActionName?: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the scheduled action.
*/
ScheduledActionARN?: ResourceName;
/**
* This parameter is deprecated.
*/
Time?: TimestampType;
/**
* The date and time that the action is scheduled to begin. When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
*/
StartTime?: TimestampType;
/**
* The date and time that the action is scheduled to end.
*/
EndTime?: TimestampType;
/**
* The recurring schedule for the action.
*/
Recurrence?: XmlStringMaxLen255;
/**
* The minimum size of the group.
*/
MinSize?: AutoScalingGroupMinSize;
/**
* The maximum size of the group.
*/
MaxSize?: AutoScalingGroupMaxSize;
/**
* The number of instances you prefer to maintain in the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
}
export interface ScheduledUpdateGroupActionRequest {
/**
* The name of the scaling action.
*/
ScheduledActionName: XmlStringMaxLen255;
/**
* The time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence. If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.
*/
StartTime?: TimestampType;
/**
* The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
*/
EndTime?: TimestampType;
/**
* The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.
*/
Recurrence?: XmlStringMaxLen255;
/**
* The minimum size of the group.
*/
MinSize?: AutoScalingGroupMinSize;
/**
* The maximum size of the group.
*/
MaxSize?: AutoScalingGroupMaxSize;
/**
* The number of EC2 instances that should be running in the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
}
export type ScheduledUpdateGroupActionRequests = ScheduledUpdateGroupActionRequest[];
export type ScheduledUpdateGroupActions = ScheduledUpdateGroupAction[];
export type SecurityGroups = XmlString[];
export interface SetDesiredCapacityType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The number of EC2 instances that should be running in the Auto Scaling group.
*/
DesiredCapacity: AutoScalingGroupDesiredCapacity;
/**
* Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.
*/
HonorCooldown?: HonorCooldown;
}
export interface SetInstanceHealthQuery {
/**
* The ID of the instance.
*/
InstanceId: XmlStringMaxLen19;
/**
* The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
*/
HealthStatus: XmlStringMaxLen32;
/**
* If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group. For more information about the health check grace period, see CreateAutoScalingGroup.
*/
ShouldRespectGracePeriod?: ShouldRespectGracePeriod;
}
export interface SetInstanceProtectionAnswer {
}
export interface SetInstanceProtectionQuery {
/**
* One or more instance IDs.
*/
InstanceIds: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
*/
ProtectedFromScaleIn: ProtectedFromScaleIn;
}
export type ShouldDecrementDesiredCapacity = boolean;
export type ShouldRespectGracePeriod = boolean;
export type SpotInstancePools = number;
export type SpotPrice = string;
export interface StepAdjustment {
/**
* The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
*/
MetricIntervalLowerBound?: MetricScale;
/**
* The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound.
*/
MetricIntervalUpperBound?: MetricScale;
/**
* The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
*/
ScalingAdjustment: PolicyIncrement;
}
export type StepAdjustments = StepAdjustment[];
export interface SuspendedProcess {
/**
* The name of the suspended process.
*/
ProcessName?: XmlStringMaxLen255;
/**
* The reason that the process was suspended.
*/
SuspensionReason?: XmlStringMaxLen255;
}
export type SuspendedProcesses = SuspendedProcess[];
export interface Tag {
/**
* The name of the group.
*/
ResourceId?: XmlString;
/**
* The type of resource. The only supported value is auto-scaling-group.
*/
ResourceType?: XmlString;
/**
* The tag key.
*/
Key: TagKey;
/**
* The tag value.
*/
Value?: TagValue;
/**
* Determines whether the tag is added to new instances as they are launched in the group.
*/
PropagateAtLaunch?: PropagateAtLaunch;
}
export interface TagDescription {
/**
* The name of the group.
*/
ResourceId?: XmlString;
/**
* The type of resource. The only supported value is auto-scaling-group.
*/
ResourceType?: XmlString;
/**
* The tag key.
*/
Key?: TagKey;
/**
* The tag value.
*/
Value?: TagValue;
/**
* Determines whether the tag is added to new instances as they are launched in the group.
*/
PropagateAtLaunch?: PropagateAtLaunch;
}
export type TagDescriptionList = TagDescription[];
export type TagKey = string;
export type TagValue = string;
export type Tags = Tag[];
export interface TagsType {
/**
* One or more tags.
*/
Tags?: TagDescriptionList;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export type TargetGroupARNs = XmlStringMaxLen511[];
export interface TargetTrackingConfiguration {
/**
* A predefined metric. You can specify either a predefined metric or a customized metric.
*/
PredefinedMetricSpecification?: PredefinedMetricSpecification;
/**
* A customized metric. You can specify either a predefined metric or a customized metric.
*/
CustomizedMetricSpecification?: CustomizedMetricSpecification;
/**
* The target value for the metric.
*/
TargetValue: MetricScale;
/**
* Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is disabled.
*/
DisableScaleIn?: DisableScaleIn;
}
export interface TerminateInstanceInAutoScalingGroupType {
/**
* The ID of the instance.
*/
InstanceId: XmlStringMaxLen19;
/**
* Indicates whether terminating the instance also decrements the size of the Auto Scaling group.
*/
ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity;
}
export type TerminationPolicies = XmlStringMaxLen1600[];
export type TimestampType = Date;
export interface UpdateAutoScalingGroupType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The name of the launch configuration. If you specify this parameter, you can't specify a launch template or a mixed instances policy.
*/
LaunchConfigurationName?: ResourceName;
/**
* The launch template and version to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a mixed instances policy.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* The mixed instances policy to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a launch template. For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.
*/
MixedInstancesPolicy?: MixedInstancesPolicy;
/**
* The minimum size of the Auto Scaling group.
*/
MinSize?: AutoScalingGroupMinSize;
/**
* The maximum size of the Auto Scaling group.
*/
MaxSize?: AutoScalingGroupMaxSize;
/**
* The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
/**
* The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
*/
DefaultCooldown?: Cooldown;
/**
* One or more Availability Zones for the group.
*/
AvailabilityZones?: AvailabilityZones;
/**
* The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
*/
HealthCheckType?: XmlStringMaxLen32;
/**
* The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you are adding an ELB health check.
*/
HealthCheckGracePeriod?: HealthCheckGracePeriod;
/**
* The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
*/
PlacementGroup?: XmlStringMaxLen255;
/**
* A comma-separated list of subnet IDs, if you are launching into a VPC. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.
*/
VPCZoneIdentifier?: XmlStringMaxLen2047;
/**
* A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed. For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
*/
TerminationPolicies?: TerminationPolicies;
/**
* Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
*/
NewInstancesProtectedFromScaleIn?: InstanceProtected;
/**
* The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
*/
ServiceLinkedRoleARN?: ResourceName;
}
export type Values = XmlString[];
export type XmlString = string;
export type XmlStringMaxLen1023 = string;
export type XmlStringMaxLen1600 = string;
export type XmlStringMaxLen19 = string;
export type XmlStringMaxLen2047 = string;
export type XmlStringMaxLen255 = string;
export type XmlStringMaxLen32 = string;
export type XmlStringMaxLen511 = string;
export type XmlStringMaxLen64 = string;
export type XmlStringUserData = string;
/**
* 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.
*/
export type apiVersion = "2011-01-01"|"latest"|string;
export interface ClientApiVersions {
/**
* 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.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the AutoScaling client.
*/
export import Types = AutoScaling;
}
export = AutoScaling;