@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonAutoScaling extends Object implements AmazonAutoScaling
AmazonAutoScaling. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAmazonAutoScaling() |
| Modifier and Type | Method and Description |
|---|---|
AttachInstancesResult |
attachInstances(AttachInstancesRequest request)
Attaches one or more EC2 instances to the specified Auto Scaling group.
|
AttachLoadBalancersResult |
attachLoadBalancers()
Simplified method form for invoking the AttachLoadBalancers operation.
|
AttachLoadBalancersResult |
attachLoadBalancers(AttachLoadBalancersRequest request)
|
AttachLoadBalancerTargetGroupsResult |
attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest request)
Attaches one or more target groups to the specified Auto Scaling group.
|
BatchDeleteScheduledActionResult |
batchDeleteScheduledAction(BatchDeleteScheduledActionRequest request)
Deletes one or more scheduled actions for the specified Auto Scaling group.
|
BatchPutScheduledUpdateGroupActionResult |
batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest request)
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
|
CancelInstanceRefreshResult |
cancelInstanceRefresh(CancelInstanceRefreshRequest request)
Cancels an instance refresh operation in progress.
|
CompleteLifecycleActionResult |
completeLifecycleAction(CompleteLifecycleActionRequest request)
Completes the lifecycle action for the specified token or instance with the specified result.
|
CreateAutoScalingGroupResult |
createAutoScalingGroup(CreateAutoScalingGroupRequest request)
We strongly recommend using a launch template when calling this operation to ensure full functionality for
Amazon EC2 Auto Scaling and Amazon EC2.
|
CreateLaunchConfigurationResult |
createLaunchConfiguration(CreateLaunchConfigurationRequest request)
Creates a launch configuration.
|
CreateOrUpdateTagsResult |
createOrUpdateTags(CreateOrUpdateTagsRequest request)
Creates or updates tags for the specified Auto Scaling group.
|
DeleteAutoScalingGroupResult |
deleteAutoScalingGroup(DeleteAutoScalingGroupRequest request)
Deletes the specified Auto Scaling group.
|
DeleteLaunchConfigurationResult |
deleteLaunchConfiguration(DeleteLaunchConfigurationRequest request)
Deletes the specified launch configuration.
|
DeleteLifecycleHookResult |
deleteLifecycleHook(DeleteLifecycleHookRequest request)
Deletes the specified lifecycle hook.
|
DeleteNotificationConfigurationResult |
deleteNotificationConfiguration(DeleteNotificationConfigurationRequest request)
Deletes the specified notification.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest request)
Deletes the specified scaling policy.
|
DeleteScheduledActionResult |
deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes the specified scheduled action.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest request)
Deletes the specified tags.
|
DescribeAccountLimitsResult |
describeAccountLimits()
Simplified method form for invoking the DescribeAccountLimits operation.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest request)
Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes()
Simplified method form for invoking the DescribeAdjustmentTypes operation.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes(DescribeAdjustmentTypesRequest request)
Describes the available adjustment types for Amazon EC2 Auto Scaling scaling policies.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups()
Simplified method form for invoking the DescribeAutoScalingGroups operation.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups(DescribeAutoScalingGroupsRequest request)
Describes one or more Auto Scaling groups.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances()
Simplified method form for invoking the DescribeAutoScalingInstances operation.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances(DescribeAutoScalingInstancesRequest request)
Describes one or more Auto Scaling instances.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes()
Simplified method form for invoking the DescribeAutoScalingNotificationTypes operation.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest request)
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
|
DescribeInstanceRefreshesResult |
describeInstanceRefreshes(DescribeInstanceRefreshesRequest request)
Describes one or more instance refreshes.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations()
Simplified method form for invoking the DescribeLaunchConfigurations operation.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations(DescribeLaunchConfigurationsRequest request)
Describes one or more launch configurations.
|
DescribeLifecycleHooksResult |
describeLifecycleHooks(DescribeLifecycleHooksRequest request)
Describes the lifecycle hooks for the specified Auto Scaling group.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes()
Simplified method form for invoking the DescribeLifecycleHookTypes operation.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest request)
Describes the available types of lifecycle hooks.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest request)
Describes the load balancers for the specified Auto Scaling group.
|
DescribeLoadBalancerTargetGroupsResult |
describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest request)
Describes the target groups for the specified Auto Scaling group.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes()
Simplified method form for invoking the DescribeMetricCollectionTypes operation.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest request)
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations()
Simplified method form for invoking the DescribeNotificationConfigurations operation.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations(DescribeNotificationConfigurationsRequest request)
Describes the notification actions associated with the specified Auto Scaling group.
|
DescribePoliciesResult |
describePolicies()
Simplified method form for invoking the DescribePolicies operation.
|
DescribePoliciesResult |
describePolicies(DescribePoliciesRequest request)
Describes the policies for the specified Auto Scaling group.
|
DescribeScalingActivitiesResult |
describeScalingActivities()
Simplified method form for invoking the DescribeScalingActivities operation.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest request)
Describes one or more scaling activities for the specified Auto Scaling group.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes()
Simplified method form for invoking the DescribeScalingProcessTypes operation.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes(DescribeScalingProcessTypesRequest request)
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
|
DescribeScheduledActionsResult |
describeScheduledActions()
Simplified method form for invoking the DescribeScheduledActions operation.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest request)
Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end
time.
|
DescribeTagsResult |
describeTags()
Simplified method form for invoking the DescribeTags operation.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Describes the specified tags.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes()
Simplified method form for invoking the DescribeTerminationPolicyTypes operation.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest request)
Describes the termination policies supported by Amazon EC2 Auto Scaling.
|
DetachInstancesResult |
detachInstances(DetachInstancesRequest request)
Removes one or more instances from the specified Auto Scaling group.
|
DetachLoadBalancersResult |
detachLoadBalancers()
Simplified method form for invoking the DetachLoadBalancers operation.
|
DetachLoadBalancersResult |
detachLoadBalancers(DetachLoadBalancersRequest request)
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
|
DetachLoadBalancerTargetGroupsResult |
detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest request)
Detaches one or more target groups from the specified Auto Scaling group.
|
DisableMetricsCollectionResult |
disableMetricsCollection(DisableMetricsCollectionRequest request)
Disables group metrics for the specified Auto Scaling group.
|
EnableMetricsCollectionResult |
enableMetricsCollection(EnableMetricsCollectionRequest request)
Enables group metrics for the specified Auto Scaling group.
|
EnterStandbyResult |
enterStandby(EnterStandbyRequest request)
Moves the specified instances into the standby state.
|
ExecutePolicyResult |
executePolicy(ExecutePolicyRequest request)
Executes the specified policy.
|
ExitStandbyResult |
exitStandby(ExitStandbyRequest request)
Moves the specified instances out of the standby state.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
PutLifecycleHookResult |
putLifecycleHook(PutLifecycleHookRequest request)
Creates or updates a lifecycle hook for the specified Auto Scaling group.
|
PutNotificationConfigurationResult |
putNotificationConfiguration(PutNotificationConfigurationRequest request)
Configures an Auto Scaling group to send notifications when specified events take place.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a scaling policy for an Auto Scaling group.
|
PutScheduledUpdateGroupActionResult |
putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest request)
Creates or updates a scheduled scaling action for an Auto Scaling group.
|
RecordLifecycleActionHeartbeatResult |
recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest request)
Records a heartbeat for the lifecycle action associated with the specified token or instance.
|
ResumeProcessesResult |
resumeProcesses(ResumeProcessesRequest request)
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling
group.
|
SetDesiredCapacityResult |
setDesiredCapacity(SetDesiredCapacityRequest request)
Sets the size of the specified Auto Scaling group.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com").
|
SetInstanceHealthResult |
setInstanceHealth(SetInstanceHealthRequest request)
Sets the health status of the specified instance.
|
SetInstanceProtectionResult |
setInstanceProtection(SetInstanceProtectionRequest request)
Updates the instance protection settings of the specified instances.
|
void |
setRegion(Region region)
An alternative to
AmazonAutoScaling.setEndpoint(String), sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartInstanceRefreshResult |
startInstanceRefresh(StartInstanceRefreshRequest request)
Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched
instances in the Auto Scaling group with a new group of instances.
|
SuspendProcessesResult |
suspendProcesses(SuspendProcessesRequest request)
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
|
TerminateInstanceInAutoScalingGroupResult |
terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest request)
Terminates the specified instance and optionally adjusts the desired group size.
|
UpdateAutoScalingGroupResult |
updateAutoScalingGroup(UpdateAutoScalingGroupRequest request)
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for
Amazon EC2 Auto Scaling and Amazon EC2.
|
AmazonAutoScalingWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonAutoScaling
Callers can pass in just the endpoint (ex: "autoscaling.amazonaws.com") or a full URL, including the protocol
(ex: "https://autoscaling.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonAutoScalingendpoint - The endpoint (ex: "autoscaling.amazonaws.com") or a full URL, including the protocol (ex:
"https://autoscaling.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonAutoScalingAmazonAutoScaling.setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonAutoScalingregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AttachInstancesResult attachInstances(AttachInstancesRequest request)
AmazonAutoScalingAttaches 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 in interface AmazonAutoScalingpublic AttachLoadBalancerTargetGroupsResult attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest request)
AmazonAutoScalingAttaches one or more target groups to the specified Auto Scaling group.
This operation is used with the following load balancer types:
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
Gateway Load Balancer - Operates at the network layer (layer 3).
To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
attachLoadBalancerTargetGroups in interface AmazonAutoScalingpublic AttachLoadBalancersResult attachLoadBalancers(AttachLoadBalancersRequest request)
AmazonAutoScalingTo attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.
Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.
To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
attachLoadBalancers in interface AmazonAutoScalingpublic AttachLoadBalancersResult attachLoadBalancers()
AmazonAutoScalingattachLoadBalancers in interface AmazonAutoScalingAmazonAutoScaling.attachLoadBalancers(AttachLoadBalancersRequest)public BatchDeleteScheduledActionResult batchDeleteScheduledAction(BatchDeleteScheduledActionRequest request)
AmazonAutoScalingDeletes one or more scheduled actions for the specified Auto Scaling group.
batchDeleteScheduledAction in interface AmazonAutoScalingpublic BatchPutScheduledUpdateGroupActionResult batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest request)
AmazonAutoScalingCreates 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 in interface AmazonAutoScalingpublic CancelInstanceRefreshResult cancelInstanceRefresh(CancelInstanceRefreshRequest request)
AmazonAutoScalingCancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
cancelInstanceRefresh in interface AmazonAutoScalingpublic CompleteLifecycleActionResult completeLifecycleAction(CompleteLifecycleActionRequest request)
AmazonAutoScalingCompletes 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 in interface AmazonAutoScalingpublic CreateAutoScalingGroupResult createAutoScalingGroup(CreateAutoScalingGroupRequest request)
AmazonAutoScalingWe strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and
MinSize). Usually, you set these sizes based on a specific number of instances. However, if you
configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with
the same units that you use for weighting instances.
createAutoScalingGroup in interface AmazonAutoScalingpublic CreateLaunchConfigurationResult createLaunchConfiguration(CreateLaunchConfigurationRequest request)
AmazonAutoScalingCreates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
createLaunchConfiguration in interface AmazonAutoScalingpublic CreateOrUpdateTagsResult createOrUpdateTags(CreateOrUpdateTagsRequest request)
AmazonAutoScalingCreates 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 in interface AmazonAutoScalingpublic DeleteAutoScalingGroupResult deleteAutoScalingGroup(DeleteAutoScalingGroupRequest request)
AmazonAutoScalingDeletes 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 the DetachInstances API 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 the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
deleteAutoScalingGroup in interface AmazonAutoScalingpublic DeleteLaunchConfigurationResult deleteLaunchConfiguration(DeleteLaunchConfigurationRequest request)
AmazonAutoScalingDeletes 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 in interface AmazonAutoScalingpublic DeleteLifecycleHookResult deleteLifecycleHook(DeleteLifecycleHookRequest request)
AmazonAutoScalingDeletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching
instances, CONTINUE for terminating instances).
deleteLifecycleHook in interface AmazonAutoScalingpublic DeleteNotificationConfigurationResult deleteNotificationConfiguration(DeleteNotificationConfigurationRequest request)
AmazonAutoScalingDeletes the specified notification.
deleteNotificationConfiguration in interface AmazonAutoScalingpublic DeletePolicyResult deletePolicy(DeletePolicyRequest request)
AmazonAutoScalingDeletes the specified scaling policy.
Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide.
deletePolicy in interface AmazonAutoScalingpublic DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest request)
AmazonAutoScalingDeletes the specified scheduled action.
deleteScheduledAction in interface AmazonAutoScalingpublic DeleteTagsResult deleteTags(DeleteTagsRequest request)
AmazonAutoScalingDeletes the specified tags.
deleteTags in interface AmazonAutoScalingpublic DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest request)
AmazonAutoScalingDescribes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.
For information about requesting an increase, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
describeAccountLimits in interface AmazonAutoScalingpublic DescribeAccountLimitsResult describeAccountLimits()
AmazonAutoScalingdescribeAccountLimits in interface AmazonAutoScalingAmazonAutoScaling.describeAccountLimits(DescribeAccountLimitsRequest)public DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest request)
AmazonAutoScalingDescribes the available adjustment types for Amazon EC2 Auto Scaling scaling policies. These settings apply to step scaling policies and simple scaling policies; they do not apply to target tracking scaling policies.
The following adjustment types are supported:
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
describeAdjustmentTypes in interface AmazonAutoScalingpublic DescribeAdjustmentTypesResult describeAdjustmentTypes()
AmazonAutoScalingdescribeAdjustmentTypes in interface AmazonAutoScalingAmazonAutoScaling.describeAdjustmentTypes(DescribeAdjustmentTypesRequest)public DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest request)
AmazonAutoScalingDescribes one or more Auto Scaling groups.
describeAutoScalingGroups in interface AmazonAutoScalingpublic DescribeAutoScalingGroupsResult describeAutoScalingGroups()
AmazonAutoScalingdescribeAutoScalingGroups in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingGroups(DescribeAutoScalingGroupsRequest)public DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest request)
AmazonAutoScalingDescribes one or more Auto Scaling instances.
describeAutoScalingInstances in interface AmazonAutoScalingpublic DescribeAutoScalingInstancesResult describeAutoScalingInstances()
AmazonAutoScalingdescribeAutoScalingInstances in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingInstances(DescribeAutoScalingInstancesRequest)public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest request)
AmazonAutoScalingDescribes the notification types that are supported by Amazon EC2 Auto Scaling.
describeAutoScalingNotificationTypes in interface AmazonAutoScalingpublic DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes()
AmazonAutoScalingdescribeAutoScalingNotificationTypes in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest)public DescribeInstanceRefreshesResult describeInstanceRefreshes(DescribeInstanceRefreshesRequest request)
AmazonAutoScalingDescribes one or more instance refreshes.
You can determine the status of a request by looking at the Status parameter. The following are the
possible statuses:
Pending - The request was created, but the operation has not started.
InProgress - The operation is in progress.
Successful - The operation completed successfully.
Failed - The operation failed to complete. You can troubleshoot using the status reason and the
scaling activities.
Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any
replacements that have already been completed, but it prevents new replacements from being started.
Cancelled - The operation is cancelled.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
describeInstanceRefreshes in interface AmazonAutoScalingpublic DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest request)
AmazonAutoScalingDescribes one or more launch configurations.
describeLaunchConfigurations in interface AmazonAutoScalingpublic DescribeLaunchConfigurationsResult describeLaunchConfigurations()
AmazonAutoScalingdescribeLaunchConfigurations in interface AmazonAutoScalingAmazonAutoScaling.describeLaunchConfigurations(DescribeLaunchConfigurationsRequest)public DescribeLifecycleHookTypesResult describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest request)
AmazonAutoScalingDescribes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
describeLifecycleHookTypes in interface AmazonAutoScalingpublic DescribeLifecycleHookTypesResult describeLifecycleHookTypes()
AmazonAutoScalingdescribeLifecycleHookTypes in interface AmazonAutoScalingAmazonAutoScaling.describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest)public DescribeLifecycleHooksResult describeLifecycleHooks(DescribeLifecycleHooksRequest request)
AmazonAutoScalingDescribes the lifecycle hooks for the specified Auto Scaling group.
describeLifecycleHooks in interface AmazonAutoScalingpublic DescribeLoadBalancerTargetGroupsResult describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest request)
AmazonAutoScalingDescribes the target groups for the specified Auto Scaling group.
describeLoadBalancerTargetGroups in interface AmazonAutoScalingpublic DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest request)
AmazonAutoScalingDescribes the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
describeLoadBalancers in interface AmazonAutoScalingpublic DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest request)
AmazonAutoScalingDescribes 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 the EnableMetricsCollection API.
describeMetricCollectionTypes in interface AmazonAutoScalingpublic DescribeMetricCollectionTypesResult describeMetricCollectionTypes()
AmazonAutoScalingdescribeMetricCollectionTypes in interface AmazonAutoScalingAmazonAutoScaling.describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest)public DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest request)
AmazonAutoScalingDescribes the notification actions associated with the specified Auto Scaling group.
describeNotificationConfigurations in interface AmazonAutoScalingpublic DescribeNotificationConfigurationsResult describeNotificationConfigurations()
AmazonAutoScalingdescribeNotificationConfigurations in interface AmazonAutoScalingAmazonAutoScaling.describeNotificationConfigurations(DescribeNotificationConfigurationsRequest)public DescribePoliciesResult describePolicies(DescribePoliciesRequest request)
AmazonAutoScalingDescribes the policies for the specified Auto Scaling group.
describePolicies in interface AmazonAutoScalingpublic DescribePoliciesResult describePolicies()
AmazonAutoScalingdescribePolicies in interface AmazonAutoScalingAmazonAutoScaling.describePolicies(DescribePoliciesRequest)public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest request)
AmazonAutoScalingDescribes one or more scaling activities for the specified Auto Scaling group.
To view the scaling activities from the Amazon EC2 Auto Scaling console, choose the Activity tab of the Auto Scaling group. When scaling events occur, you see scaling activity messages in the Activity history. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
describeScalingActivities in interface AmazonAutoScalingpublic DescribeScalingActivitiesResult describeScalingActivities()
AmazonAutoScalingdescribeScalingActivities in interface AmazonAutoScalingAmazonAutoScaling.describeScalingActivities(DescribeScalingActivitiesRequest)public DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest request)
AmazonAutoScalingDescribes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
describeScalingProcessTypes in interface AmazonAutoScalingpublic DescribeScalingProcessTypesResult describeScalingProcessTypes()
AmazonAutoScalingdescribeScalingProcessTypes in interface AmazonAutoScalingAmazonAutoScaling.describeScalingProcessTypes(DescribeScalingProcessTypesRequest)public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest request)
AmazonAutoScalingDescribes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time. To describe the actions that have already run, call the DescribeScalingActivities API.
describeScheduledActions in interface AmazonAutoScalingpublic DescribeScheduledActionsResult describeScheduledActions()
AmazonAutoScalingdescribeScheduledActions in interface AmazonAutoScalingAmazonAutoScaling.describeScheduledActions(DescribeScheduledActionsRequest)public DescribeTagsResult describeTags(DescribeTagsRequest request)
AmazonAutoScalingDescribes 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.
For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
describeTags in interface AmazonAutoScalingpublic DescribeTagsResult describeTags()
AmazonAutoScalingdescribeTags in interface AmazonAutoScalingAmazonAutoScaling.describeTags(DescribeTagsRequest)public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest request)
AmazonAutoScalingDescribes 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 in interface AmazonAutoScalingpublic DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes()
AmazonAutoScalingdescribeTerminationPolicyTypes in interface AmazonAutoScalingAmazonAutoScaling.describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest)public DetachInstancesResult detachInstances(DetachInstancesRequest request)
AmazonAutoScalingRemoves 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 in interface AmazonAutoScalingpublic DetachLoadBalancerTargetGroupsResult detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest request)
AmazonAutoScalingDetaches one or more target groups from the specified Auto Scaling group.
detachLoadBalancerTargetGroups in interface AmazonAutoScalingpublic DetachLoadBalancersResult detachLoadBalancers(DetachLoadBalancersRequest request)
AmazonAutoScalingDetaches 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, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API 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 the
DescribeLoadBalancers API call. The instances remain running.
detachLoadBalancers in interface AmazonAutoScalingpublic DetachLoadBalancersResult detachLoadBalancers()
AmazonAutoScalingdetachLoadBalancers in interface AmazonAutoScalingAmazonAutoScaling.detachLoadBalancers(DetachLoadBalancersRequest)public DisableMetricsCollectionResult disableMetricsCollection(DisableMetricsCollectionRequest request)
AmazonAutoScalingDisables group metrics for the specified Auto Scaling group.
disableMetricsCollection in interface AmazonAutoScalingpublic EnableMetricsCollectionResult enableMetricsCollection(EnableMetricsCollectionRequest request)
AmazonAutoScalingEnables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
enableMetricsCollection in interface AmazonAutoScalingpublic EnterStandbyResult enterStandby(EnterStandbyRequest request)
AmazonAutoScalingMoves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
enterStandby in interface AmazonAutoScalingpublic ExecutePolicyResult executePolicy(ExecutePolicyRequest request)
AmazonAutoScalingExecutes the specified policy. This can be useful for testing the design of your scaling policy.
executePolicy in interface AmazonAutoScalingpublic ExitStandbyResult exitStandby(ExitStandbyRequest request)
AmazonAutoScalingMoves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
exitStandby in interface AmazonAutoScalingpublic PutLifecycleHookResult putLifecycleHook(PutLifecycleHookRequest request)
AmazonAutoScalingCreates 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 the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, complete the lifecycle action using the CompleteLifecycleAction API call.
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 the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
putLifecycleHook in interface AmazonAutoScalingpublic PutNotificationConfigurationResult putNotificationConfiguration(PutNotificationConfigurationRequest request)
AmazonAutoScalingConfigures 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.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
putNotificationConfiguration in interface AmazonAutoScalingpublic PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest request)
AmazonAutoScalingCreates or updates a scaling policy for an Auto Scaling group.
For more information about using scaling policies to scale your Auto Scaling group, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
putScalingPolicy in interface AmazonAutoScalingpublic PutScheduledUpdateGroupActionResult putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest request)
AmazonAutoScalingCreates 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 in interface AmazonAutoScalingpublic RecordLifecycleActionHeartbeatResult recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest request)
AmazonAutoScalingRecords a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
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 in interface AmazonAutoScalingpublic ResumeProcessesResult resumeProcesses(ResumeProcessesRequest request)
AmazonAutoScalingResumes the specified suspended auto 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 in interface AmazonAutoScalingpublic SetDesiredCapacityResult setDesiredCapacity(SetDesiredCapacityRequest request)
AmazonAutoScalingSets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the
current size of the group, the Auto Scaling group uses its termination policy to determine which instances to
terminate.
For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
setDesiredCapacity in interface AmazonAutoScalingpublic SetInstanceHealthResult setInstanceHealth(SetInstanceHealthRequest request)
AmazonAutoScalingSets 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 in interface AmazonAutoScalingpublic SetInstanceProtectionResult setInstanceProtection(SetInstanceProtectionRequest request)
AmazonAutoScalingUpdates 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 scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
setInstanceProtection in interface AmazonAutoScalingpublic StartInstanceRefreshResult startInstanceRefresh(StartInstanceRefreshRequest request)
AmazonAutoScalingStarts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.
If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
startInstanceRefresh in interface AmazonAutoScalingpublic SuspendProcessesResult suspendProcesses(SuspendProcessesRequest request)
AmazonAutoScalingSuspends the specified auto 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. For more information, see Suspending and
resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
suspendProcesses in interface AmazonAutoScalingpublic TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest request)
AmazonAutoScalingTerminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instance is not terminated immediately. When an instance is
terminated, the instance status changes to terminated. You can't connect to or start an instance
after you've terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
terminateInstanceInAutoScalingGroup in interface AmazonAutoScalingpublic UpdateAutoScalingGroupResult updateAutoScalingGroup(UpdateAutoScalingGroupRequest request)
AmazonAutoScalingWe strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing DesiredCapacity, MaxSize, or MinSize:
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the
current size of the group, the Auto Scaling group uses its termination policy to determine which instances to
terminate.
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, this sets the group's
DesiredCapacity to the new MinSize value.
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, this sets the group's
DesiredCapacity to the new MaxSize value.
To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
updateAutoScalingGroup in interface AmazonAutoScalingpublic void shutdown()
AmazonAutoScalingshutdown in interface AmazonAutoScalingpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonAutoScalingResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonAutoScalingrequest - The originally executed request.public AmazonAutoScalingWaiters waiters()
waiters in interface AmazonAutoScalingCopyright © 2021. All rights reserved.