@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAutoScaling
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonAutoScaling instead.
Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.
For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AttachInstancesResult |
attachInstances(AttachInstancesRequest attachInstancesRequest)
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 attachLoadBalancersRequest)
Attaches one or more Classic Load Balancers to the specified Auto Scaling group.
|
AttachLoadBalancerTargetGroupsResult |
attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest)
Attaches one or more target groups to the specified Auto Scaling group.
|
BatchDeleteScheduledActionResult |
batchDeleteScheduledAction(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest)
Deletes one or more scheduled actions for the specified Auto Scaling group.
|
BatchPutScheduledUpdateGroupActionResult |
batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest batchPutScheduledUpdateGroupActionRequest)
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
|
CompleteLifecycleActionResult |
completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest)
Completes the lifecycle action for the specified token or instance with the specified result.
|
CreateAutoScalingGroupResult |
createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
Creates an Auto Scaling group with the specified name and attributes.
|
CreateLaunchConfigurationResult |
createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
Creates a launch configuration.
|
CreateOrUpdateTagsResult |
createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)
Creates or updates tags for the specified Auto Scaling group.
|
DeleteAutoScalingGroupResult |
deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
Deletes the specified Auto Scaling group.
|
DeleteLaunchConfigurationResult |
deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
Deletes the specified launch configuration.
|
DeleteLifecycleHookResult |
deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest)
Deletes the specified lifecycle hook.
|
DeleteNotificationConfigurationResult |
deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
Deletes the specified notification.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified scaling policy.
|
DeleteScheduledActionResult |
deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes the specified scheduled action.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags.
|
DescribeAccountLimitsResult |
describeAccountLimits()
Simplified method form for invoking the DescribeAccountLimits operation.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Amazon EC2 Auto Scaling resource limits for your AWS account.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes()
Simplified method form for invoking the DescribeAdjustmentTypes operation.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
Describes the policy adjustment types for use with PutScalingPolicy.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups()
Simplified method form for invoking the DescribeAutoScalingGroups operation.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
Describes one or more Auto Scaling groups.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances()
Simplified method form for invoking the DescribeAutoScalingInstances operation.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
Describes one or more Auto Scaling instances.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes()
Simplified method form for invoking the DescribeAutoScalingNotificationTypes operation.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations()
Simplified method form for invoking the DescribeLaunchConfigurations operation.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
Describes one or more launch configurations.
|
DescribeLifecycleHooksResult |
describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest)
Describes the lifecycle hooks for the specified Auto Scaling group.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes()
Simplified method form for invoking the DescribeLifecycleHookTypes operation.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest)
Describes the available types of lifecycle hooks.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the load balancers for the specified Auto Scaling group.
|
DescribeLoadBalancerTargetGroupsResult |
describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest)
Describes the target groups for the specified Auto Scaling group.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes()
Simplified method form for invoking the DescribeMetricCollectionTypes operation.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations()
Simplified method form for invoking the DescribeNotificationConfigurations operation.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Describes the notification actions associated with the specified Auto Scaling group.
|
DescribePoliciesResult |
describePolicies()
Simplified method form for invoking the DescribePolicies operation.
|
DescribePoliciesResult |
describePolicies(DescribePoliciesRequest describePoliciesRequest)
Describes the policies for the specified Auto Scaling group.
|
DescribeScalingActivitiesResult |
describeScalingActivities()
Simplified method form for invoking the DescribeScalingActivities operation.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
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 describeScalingProcessTypesRequest)
Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
|
DescribeScheduledActionsResult |
describeScheduledActions()
Simplified method form for invoking the DescribeScheduledActions operation.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
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 describeTagsRequest)
Describes the specified tags.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes()
Simplified method form for invoking the DescribeTerminationPolicyTypes operation.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
Describes the termination policies supported by Amazon EC2 Auto Scaling.
|
DetachInstancesResult |
detachInstances(DetachInstancesRequest detachInstancesRequest)
Removes one or more instances from the specified Auto Scaling group.
|
DetachLoadBalancersResult |
detachLoadBalancers()
Simplified method form for invoking the DetachLoadBalancers operation.
|
DetachLoadBalancersResult |
detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest)
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
|
DetachLoadBalancerTargetGroupsResult |
detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest)
Detaches one or more target groups from the specified Auto Scaling group.
|
DisableMetricsCollectionResult |
disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
Disables group metrics for the specified Auto Scaling group.
|
EnableMetricsCollectionResult |
enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
Enables group metrics for the specified Auto Scaling group.
|
EnterStandbyResult |
enterStandby(EnterStandbyRequest enterStandbyRequest)
Moves the specified instances into the standby state.
|
ExecutePolicyResult |
executePolicy(ExecutePolicyRequest executePolicyRequest)
Executes the specified policy.
|
ExitStandbyResult |
exitStandby(ExitStandbyRequest exitStandbyRequest)
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 putLifecycleHookRequest)
Creates or updates a lifecycle hook for the specified Auto Scaling group.
|
PutNotificationConfigurationResult |
putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)
Configures an Auto Scaling group to send notifications when specified events take place.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
Creates or updates a scaling policy for an Auto Scaling group.
|
PutScheduledUpdateGroupActionResult |
putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)
Creates or updates a scheduled scaling action for an Auto Scaling group.
|
RecordLifecycleActionHeartbeatResult |
recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest)
Records a heartbeat for the lifecycle action associated with the specified token or instance.
|
ResumeProcessesResult |
resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto
Scaling group.
|
SetDesiredCapacityResult |
setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
Sets the size of the specified Auto Scaling group.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetInstanceHealthResult |
setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
Sets the health status of the specified instance.
|
SetInstanceProtectionResult |
setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest)
Updates the instance protection settings of the specified instances.
|
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
SuspendProcessesResult |
suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.
|
TerminateInstanceInAutoScalingGroupResult |
terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
Terminates the specified instance and optionally adjusts the desired group size.
|
UpdateAutoScalingGroupResult |
updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
Updates the configuration for the specified Auto Scaling group.
|
AmazonAutoScalingWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
endpoint - 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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
region - 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)AttachInstancesResult attachInstances(AttachInstancesRequest attachInstancesRequest)
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.
attachInstancesRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
AttachInstancesRequest request = new AttachInstancesRequest().withInstanceIds("i-93633f9b").withAutoScalingGroupName("my-auto-scaling-group");
AttachInstancesResult response = client.attachInstances(request);AttachLoadBalancerTargetGroupsResult attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest)
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.
attachLoadBalancerTargetGroupsRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
AttachLoadBalancerTargetGroupsRequest request = new AttachLoadBalancerTargetGroupsRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withTargetGroupARNs("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067");
AttachLoadBalancerTargetGroupsResult response = client.attachLoadBalancerTargetGroups(request);AttachLoadBalancersResult attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest)
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.
attachLoadBalancersRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
AttachLoadBalancersRequest request = new AttachLoadBalancersRequest().withAutoScalingGroupName("my-auto-scaling-group").withLoadBalancerNames(
"my-load-balancer");
AttachLoadBalancersResult response = client.attachLoadBalancers(request);AttachLoadBalancersResult attachLoadBalancers()
BatchDeleteScheduledActionResult batchDeleteScheduledAction(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest)
Deletes one or more scheduled actions for the specified Auto Scaling group.
batchDeleteScheduledActionRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).BatchPutScheduledUpdateGroupActionResult batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest batchPutScheduledUpdateGroupActionRequest)
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.
batchPutScheduledUpdateGroupActionRequest - AlreadyExistsException - You already have an Auto Scaling group or launch configuration with this name.LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).CompleteLifecycleActionResult completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest)
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.
completeLifecycleActionRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
CompleteLifecycleActionRequest request = new CompleteLifecycleActionRequest().withLifecycleHookName("my-lifecycle-hook")
.withAutoScalingGroupName("my-auto-scaling-group").withLifecycleActionToken("bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635")
.withLifecycleActionResult("CONTINUE");
CompleteLifecycleActionResult response = client.completeLifecycleAction(request);CreateAutoScalingGroupResult createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
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.
createAutoScalingGroupRequest - AlreadyExistsException - You already have an Auto Scaling group or launch configuration with this name.LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
CreateAutoScalingGroupRequest request = new CreateAutoScalingGroupRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withLaunchConfigurationName("my-launch-config").withMinSize(1).withMaxSize(3).withVPCZoneIdentifier("subnet-4176792c");
CreateAutoScalingGroupResult response = client.createAutoScalingGroup(request);AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
CreateAutoScalingGroupRequest request = new CreateAutoScalingGroupRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withLaunchConfigurationName("my-launch-config").withMinSize(1).withMaxSize(3).withAvailabilityZones("us-west-2c")
.withLoadBalancerNames("my-load-balancer").withHealthCheckType("ELB").withHealthCheckGracePeriod(120);
CreateAutoScalingGroupResult response = client.createAutoScalingGroup(request);AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
CreateAutoScalingGroupRequest request = new CreateAutoScalingGroupRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withLaunchConfigurationName("my-launch-config").withMinSize(1).withMaxSize(3)
.withTargetGroupARNs("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067").withHealthCheckType("ELB")
.withHealthCheckGracePeriod(120).withVPCZoneIdentifier("subnet-4176792c, subnet-65ea5f08");
CreateAutoScalingGroupResult response = client.createAutoScalingGroup(request);CreateLaunchConfigurationResult createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
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.
createLaunchConfigurationRequest - AlreadyExistsException - You already have an Auto Scaling group or launch configuration with this name.LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
CreateLaunchConfigurationRequest request = new CreateLaunchConfigurationRequest().withLaunchConfigurationName("my-launch-config")
.withImageId("ami-12345678").withSecurityGroups("sg-eb2af88e").withInstanceType("m3.medium").withIamInstanceProfile("my-iam-role");
CreateLaunchConfigurationResult response = client.createLaunchConfiguration(request);CreateOrUpdateTagsResult createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)
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.
createOrUpdateTagsRequest - LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.AlreadyExistsException - You already have an Auto Scaling group or launch configuration with this name.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ResourceInUseException - The operation can't be performed because the resource is in use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
CreateOrUpdateTagsRequest request = new CreateOrUpdateTagsRequest().withTags(
new Tag().withResourceId("my-auto-scaling-group").withResourceType("auto-scaling-group").withKey("Role").withValue("WebServer")
.withPropagateAtLaunch(true), new Tag().withResourceId("my-auto-scaling-group").withResourceType("auto-scaling-group").withKey("Dept")
.withValue("Research").withPropagateAtLaunch(true));
CreateOrUpdateTagsResult response = client.createOrUpdateTags(request);DeleteAutoScalingGroupResult deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
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.
deleteAutoScalingGroupRequest - ScalingActivityInProgressException - The operation can't be performed because there are scaling activities in progress.ResourceInUseException - The operation can't be performed because the resource is in use.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DeleteAutoScalingGroupRequest request = new DeleteAutoScalingGroupRequest().withAutoScalingGroupName("my-auto-scaling-group");
DeleteAutoScalingGroupResult response = client.deleteAutoScalingGroup(request);AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DeleteAutoScalingGroupRequest request = new DeleteAutoScalingGroupRequest().withAutoScalingGroupName("my-auto-scaling-group").withForceDelete(true);
DeleteAutoScalingGroupResult response = client.deleteAutoScalingGroup(request);DeleteLaunchConfigurationResult deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
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.
deleteLaunchConfigurationRequest - ResourceInUseException - The operation can't be performed because the resource is in use.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DeleteLaunchConfigurationRequest request = new DeleteLaunchConfigurationRequest().withLaunchConfigurationName("my-launch-config");
DeleteLaunchConfigurationResult response = client.deleteLaunchConfiguration(request);DeleteLifecycleHookResult deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest)
Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching
instances, CONTINUE for terminating instances).
deleteLifecycleHookRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DeleteLifecycleHookRequest request = new DeleteLifecycleHookRequest().withLifecycleHookName("my-lifecycle-hook").withAutoScalingGroupName(
"my-auto-scaling-group");
DeleteLifecycleHookResult response = client.deleteLifecycleHook(request);DeleteNotificationConfigurationResult deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
Deletes the specified notification.
deleteNotificationConfigurationRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DeleteNotificationConfigurationRequest request = new DeleteNotificationConfigurationRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withTopicARN("arn:aws:sns:us-west-2:123456789012:my-sns-topic");
DeleteNotificationConfigurationResult response = client.deleteNotificationConfiguration(request);DeletePolicyResult deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes 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.
deletePolicyRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DeletePolicyRequest request = new DeletePolicyRequest().withAutoScalingGroupName("my-auto-scaling-group").withPolicyName("ScaleIn");
DeletePolicyResult response = client.deletePolicy(request);DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes the specified scheduled action.
deleteScheduledActionRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DeleteScheduledActionRequest request = new DeleteScheduledActionRequest().withAutoScalingGroupName("my-auto-scaling-group").withScheduledActionName(
"my-scheduled-action");
DeleteScheduledActionResult response = client.deleteScheduledAction(request);DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags.
deleteTagsRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ResourceInUseException - The operation can't be performed because the resource is in use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DeleteTagsRequest request = new DeleteTagsRequest().withTags(new Tag().withResourceId("my-auto-scaling-group").withResourceType("auto-scaling-group")
.withKey("Dept").withValue("Research"));
DeleteTagsResult response = client.deleteTags(request);DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
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.
describeAccountLimitsRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build(); DescribeAccountLimitsRequest request = new DescribeAccountLimitsRequest(); DescribeAccountLimitsResult response = client.describeAccountLimits(request);
DescribeAccountLimitsResult describeAccountLimits()
DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
Describes the policy adjustment types for use with PutScalingPolicy.
describeAdjustmentTypesRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build(); DescribeAdjustmentTypesRequest request = new DescribeAdjustmentTypesRequest(); DescribeAdjustmentTypesResult response = client.describeAdjustmentTypes(request);
DescribeAdjustmentTypesResult describeAdjustmentTypes()
DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
Describes one or more Auto Scaling groups.
describeAutoScalingGroupsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeAutoScalingGroupsRequest request = new DescribeAutoScalingGroupsRequest().withAutoScalingGroupNames("my-auto-scaling-group");
DescribeAutoScalingGroupsResult response = client.describeAutoScalingGroups(request);DescribeAutoScalingGroupsResult describeAutoScalingGroups()
DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
Describes one or more Auto Scaling instances.
describeAutoScalingInstancesRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeAutoScalingInstancesRequest request = new DescribeAutoScalingInstancesRequest().withInstanceIds("i-4ba0837f");
DescribeAutoScalingInstancesResult response = client.describeAutoScalingInstances(request);DescribeAutoScalingInstancesResult describeAutoScalingInstances()
DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
describeAutoScalingNotificationTypesRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build(); DescribeAutoScalingNotificationTypesRequest request = new DescribeAutoScalingNotificationTypesRequest(); DescribeAutoScalingNotificationTypesResult response = client.describeAutoScalingNotificationTypes(request);
DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes()
DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
Describes one or more launch configurations.
describeLaunchConfigurationsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeLaunchConfigurationsRequest request = new DescribeLaunchConfigurationsRequest().withLaunchConfigurationNames("my-launch-config");
DescribeLaunchConfigurationsResult response = client.describeLaunchConfigurations(request);DescribeLaunchConfigurationsResult describeLaunchConfigurations()
DescribeLifecycleHookTypesResult describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest)
Describes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
describeLifecycleHookTypesRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build(); DescribeLifecycleHookTypesRequest request = new DescribeLifecycleHookTypesRequest(); DescribeLifecycleHookTypesResult response = client.describeLifecycleHookTypes(request);
DescribeLifecycleHookTypesResult describeLifecycleHookTypes()
DescribeLifecycleHooksResult describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest)
Describes the lifecycle hooks for the specified Auto Scaling group.
describeLifecycleHooksRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeLifecycleHooksRequest request = new DescribeLifecycleHooksRequest().withAutoScalingGroupName("my-auto-scaling-group");
DescribeLifecycleHooksResult response = client.describeLifecycleHooks(request);DescribeLoadBalancerTargetGroupsResult describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest)
Describes the target groups for the specified Auto Scaling group.
describeLoadBalancerTargetGroupsRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeLoadBalancerTargetGroupsRequest request = new DescribeLoadBalancerTargetGroupsRequest().withAutoScalingGroupName("my-auto-scaling-group");
DescribeLoadBalancerTargetGroupsResult response = client.describeLoadBalancerTargetGroups(request);DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
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.
describeLoadBalancersRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeLoadBalancersRequest request = new DescribeLoadBalancersRequest().withAutoScalingGroupName("my-auto-scaling-group");
DescribeLoadBalancersResult response = client.describeLoadBalancers(request);DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
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.
describeMetricCollectionTypesRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build(); DescribeMetricCollectionTypesRequest request = new DescribeMetricCollectionTypesRequest(); DescribeMetricCollectionTypesResult response = client.describeMetricCollectionTypes(request);
DescribeMetricCollectionTypesResult describeMetricCollectionTypes()
DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Describes the notification actions associated with the specified Auto Scaling group.
describeNotificationConfigurationsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeNotificationConfigurationsRequest request = new DescribeNotificationConfigurationsRequest().withAutoScalingGroupNames("my-auto-scaling-group");
DescribeNotificationConfigurationsResult response = client.describeNotificationConfigurations(request);DescribeNotificationConfigurationsResult describeNotificationConfigurations()
DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest)
Describes the policies for the specified Auto Scaling group.
describePoliciesRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribePoliciesRequest request = new DescribePoliciesRequest().withAutoScalingGroupName("my-auto-scaling-group");
DescribePoliciesResult response = client.describePolicies(request);DescribePoliciesResult describePolicies()
DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Describes one or more scaling activities for the specified Auto Scaling group.
describeScalingActivitiesRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeScalingActivitiesRequest request = new DescribeScalingActivitiesRequest().withAutoScalingGroupName("my-auto-scaling-group");
DescribeScalingActivitiesResult response = client.describeScalingActivities(request);DescribeScalingActivitiesResult describeScalingActivities()
DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
describeScalingProcessTypesRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build(); DescribeScalingProcessTypesRequest request = new DescribeScalingProcessTypesRequest(); DescribeScalingProcessTypesResult response = client.describeScalingProcessTypes(request);
DescribeScalingProcessTypesResult describeScalingProcessTypes()
DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes 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, use DescribeScalingActivities.
describeScheduledActionsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeScheduledActionsRequest request = new DescribeScheduledActionsRequest().withAutoScalingGroupName("my-auto-scaling-group");
DescribeScheduledActionsResult response = client.describeScheduledActions(request);DescribeScheduledActionsResult describeScheduledActions()
DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
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.
describeTagsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DescribeTagsRequest request = new DescribeTagsRequest().withFilters(new Filter().withName("auto-scaling-group").withValues("my-auto-scaling-group"));
DescribeTagsResult response = client.describeTags(request);DescribeTagsResult describeTags()
describeTags(DescribeTagsRequest)DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
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.
describeTerminationPolicyTypesRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build(); DescribeTerminationPolicyTypesRequest request = new DescribeTerminationPolicyTypesRequest(); DescribeTerminationPolicyTypesResult response = client.describeTerminationPolicyTypes(request);
DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes()
DetachInstancesResult detachInstances(DetachInstancesRequest detachInstancesRequest)
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.
detachInstancesRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DetachInstancesRequest request = new DetachInstancesRequest().withInstanceIds("i-93633f9b").withAutoScalingGroupName("my-auto-scaling-group")
.withShouldDecrementDesiredCapacity(true);
DetachInstancesResult response = client.detachInstances(request);DetachLoadBalancerTargetGroupsResult detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest)
Detaches one or more target groups from the specified Auto Scaling group.
detachLoadBalancerTargetGroupsRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DetachLoadBalancerTargetGroupsRequest request = new DetachLoadBalancerTargetGroupsRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withTargetGroupARNs("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067");
DetachLoadBalancerTargetGroupsResult response = client.detachLoadBalancerTargetGroups(request);DetachLoadBalancersResult detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest)
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.
detachLoadBalancersRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DetachLoadBalancersRequest request = new DetachLoadBalancersRequest().withAutoScalingGroupName("my-auto-scaling-group").withLoadBalancerNames(
"my-load-balancer");
DetachLoadBalancersResult response = client.detachLoadBalancers(request);DetachLoadBalancersResult detachLoadBalancers()
DisableMetricsCollectionResult disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
Disables group metrics for the specified Auto Scaling group.
disableMetricsCollectionRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
DisableMetricsCollectionRequest request = new DisableMetricsCollectionRequest().withAutoScalingGroupName("my-auto-scaling-group").withMetrics(
"GroupDesiredCapacity");
DisableMetricsCollectionResult response = client.disableMetricsCollection(request);EnableMetricsCollectionResult enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
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.
enableMetricsCollectionRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
EnableMetricsCollectionRequest request = new EnableMetricsCollectionRequest().withAutoScalingGroupName("my-auto-scaling-group").withGranularity(
"1Minute");
EnableMetricsCollectionResult response = client.enableMetricsCollection(request);EnterStandbyResult enterStandby(EnterStandbyRequest enterStandbyRequest)
Moves 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.
enterStandbyRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
EnterStandbyRequest request = new EnterStandbyRequest().withInstanceIds("i-93633f9b").withAutoScalingGroupName("my-auto-scaling-group")
.withShouldDecrementDesiredCapacity(true);
EnterStandbyResult response = client.enterStandby(request);ExecutePolicyResult executePolicy(ExecutePolicyRequest executePolicyRequest)
Executes the specified policy.
executePolicyRequest - ScalingActivityInProgressException - The operation can't be performed because there are scaling activities in progress.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
ExecutePolicyRequest request = new ExecutePolicyRequest().withAutoScalingGroupName("my-auto-scaling-group").withPolicyName("ScaleIn")
.withHonorCooldown(true);
ExecutePolicyResult response = client.executePolicy(request);ExitStandbyResult exitStandby(ExitStandbyRequest exitStandbyRequest)
Moves 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.
exitStandbyRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
ExitStandbyRequest request = new ExitStandbyRequest().withInstanceIds("i-93633f9b").withAutoScalingGroupName("my-auto-scaling-group");
ExitStandbyResult response = client.exitStandby(request);PutLifecycleHookResult putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest)
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 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.
putLifecycleHookRequest - LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
PutLifecycleHookRequest request = new PutLifecycleHookRequest().withLifecycleHookName("my-lifecycle-hook")
.withAutoScalingGroupName("my-auto-scaling-group").withLifecycleTransition("autoscaling:EC2_INSTANCE_LAUNCHING")
.withRoleARN("arn:aws:iam::123456789012:role/my-auto-scaling-role")
.withNotificationTargetARN("arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn");
PutLifecycleHookResult response = client.putLifecycleHook(request);PutNotificationConfigurationResult putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)
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.
putNotificationConfigurationRequest - LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
PutNotificationConfigurationRequest request = new PutNotificationConfigurationRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withTopicARN("arn:aws:sns:us-west-2:123456789012:my-sns-topic").withNotificationTypes("autoscaling:TEST_NOTIFICATION");
PutNotificationConfigurationResult response = client.putNotificationConfiguration(request);PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
Creates or updates a scaling policy for an Auto Scaling group. To update an existing scaling 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.
For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.
putScalingPolicyRequest - LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
PutScalingPolicyRequest request = new PutScalingPolicyRequest().withAutoScalingGroupName("my-auto-scaling-group").withPolicyName("ScaleIn")
.withAdjustmentType("ChangeInCapacity").withScalingAdjustment(-1);
PutScalingPolicyResult response = client.putScalingPolicy(request);PutScheduledUpdateGroupActionResult putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)
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.
putScheduledUpdateGroupActionRequest - AlreadyExistsException - You already have an Auto Scaling group or launch configuration with this name.LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
PutScheduledUpdateGroupActionRequest request = new PutScheduledUpdateGroupActionRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withScheduledActionName("my-scheduled-action").withStartTime(new Date("2014-05-12T08:00:00Z")).withEndTime(new Date("2014-05-12T08:00:00Z"))
.withMinSize(2).withMaxSize(6).withDesiredCapacity(4);
PutScheduledUpdateGroupActionResult response = client.putScheduledUpdateGroupAction(request);RecordLifecycleActionHeartbeatResult recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest)
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.
recordLifecycleActionHeartbeatRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
RecordLifecycleActionHeartbeatRequest request = new RecordLifecycleActionHeartbeatRequest().withLifecycleHookName("my-lifecycle-hook")
.withAutoScalingGroupName("my-auto-scaling-group").withLifecycleActionToken("bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635");
RecordLifecycleActionHeartbeatResult response = client.recordLifecycleActionHeartbeat(request);ResumeProcessesResult resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
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.
resumeProcessesRequest - ResourceInUseException - The operation can't be performed because the resource is in use.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
ResumeProcessesRequest request = new ResumeProcessesRequest().withAutoScalingGroupName("my-auto-scaling-group").withScalingProcesses(
"AlarmNotification");
ResumeProcessesResult response = client.resumeProcesses(request);SetDesiredCapacityResult setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
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.
setDesiredCapacityRequest - ScalingActivityInProgressException - The operation can't be performed because there are scaling activities in progress.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
SetDesiredCapacityRequest request = new SetDesiredCapacityRequest().withAutoScalingGroupName("my-auto-scaling-group").withDesiredCapacity(2)
.withHonorCooldown(true);
SetDesiredCapacityResult response = client.setDesiredCapacity(request);SetInstanceHealthResult setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
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.
setInstanceHealthRequest - ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
SetInstanceHealthRequest request = new SetInstanceHealthRequest().withInstanceId("i-93633f9b").withHealthStatus("Unhealthy");
SetInstanceHealthResult response = client.setInstanceHealth(request);SetInstanceProtectionResult setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest)
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.
setInstanceProtectionRequest - LimitExceededException - You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling
groups, launch configurations, or lifecycle hooks). For more information, see
DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
SetInstanceProtectionRequest request = new SetInstanceProtectionRequest().withInstanceIds("i-93633f9b")
.withAutoScalingGroupName("my-auto-scaling-group").withProtectedFromScaleIn(true);
SetInstanceProtectionResult response = client.setInstanceProtection(request);AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
SetInstanceProtectionRequest request = new SetInstanceProtectionRequest().withInstanceIds("i-93633f9b")
.withAutoScalingGroupName("my-auto-scaling-group").withProtectedFromScaleIn(false);
SetInstanceProtectionResult response = client.setInstanceProtection(request);SuspendProcessesResult suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
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.
suspendProcessesRequest - ResourceInUseException - The operation can't be performed because the resource is in use.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
SuspendProcessesRequest request = new SuspendProcessesRequest().withAutoScalingGroupName("my-auto-scaling-group").withScalingProcesses(
"AlarmNotification");
SuspendProcessesResult response = client.suspendProcesses(request);TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
Terminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instance is not terminated immediately.
terminateInstanceInAutoScalingGroupRequest - ScalingActivityInProgressException - The operation can't be performed because there are scaling activities in progress.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
TerminateInstanceInAutoScalingGroupRequest request = new TerminateInstanceInAutoScalingGroupRequest().withInstanceId("i-93633f9b")
.withShouldDecrementDesiredCapacity(false);
TerminateInstanceInAutoScalingGroupResult response = client.terminateInstanceInAutoScalingGroup(request);UpdateAutoScalingGroupResult updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
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 event 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, use DescribeAutoScalingGroups. You can also view the scaling policies for an Auto Scaling group using DescribePolicies. If the group has scaling policies, you can update them using PutScalingPolicy.
updateAutoScalingGroupRequest - ScalingActivityInProgressException - The operation can't be performed because there are scaling activities in progress.ResourceContentionException - You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling
group, instance, or load balancer).ServiceLinkedRoleFailureException - The service-linked role is not yet ready for use.AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
UpdateAutoScalingGroupRequest request = new UpdateAutoScalingGroupRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withLaunchConfigurationName("new-launch-config");
UpdateAutoScalingGroupResult response = client.updateAutoScalingGroup(request);AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
UpdateAutoScalingGroupRequest request = new UpdateAutoScalingGroupRequest().withAutoScalingGroupName("my-auto-scaling-group").withMinSize(1)
.withMaxSize(3);
UpdateAutoScalingGroupResult response = client.updateAutoScalingGroup(request);AmazonAutoScaling client = AmazonAutoScalingClientBuilder.standard().build();
UpdateAutoScalingGroupRequest request = new UpdateAutoScalingGroupRequest().withAutoScalingGroupName("my-auto-scaling-group")
.withNewInstancesProtectedFromScaleIn(true);
UpdateAutoScalingGroupResult response = client.updateAutoScalingGroup(request);void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response 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.
request - The originally executed request.AmazonAutoScalingWaiters waiters()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.