Interface AutoScalingClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AttachInstancesResponse
attachInstances
(Consumer<AttachInstancesRequest.Builder> attachInstancesRequest) Attaches one or more EC2 instances to the specified Auto Scaling group.default AttachInstancesResponse
attachInstances
(AttachInstancesRequest attachInstancesRequest) Attaches one or more EC2 instances to the specified Auto Scaling group.default AttachLoadBalancersResponse
attachLoadBalancers
(Consumer<AttachLoadBalancersRequest.Builder> attachLoadBalancersRequest) default AttachLoadBalancersResponse
attachLoadBalancers
(AttachLoadBalancersRequest attachLoadBalancersRequest) attachLoadBalancerTargetGroups
(Consumer<AttachLoadBalancerTargetGroupsRequest.Builder> attachLoadBalancerTargetGroupsRequest) attachLoadBalancerTargetGroups
(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest) default AttachTrafficSourcesResponse
attachTrafficSources
(Consumer<AttachTrafficSourcesRequest.Builder> attachTrafficSourcesRequest) Attaches one or more traffic sources to the specified Auto Scaling group.default AttachTrafficSourcesResponse
attachTrafficSources
(AttachTrafficSourcesRequest attachTrafficSourcesRequest) Attaches one or more traffic sources to the specified Auto Scaling group.batchDeleteScheduledAction
(Consumer<BatchDeleteScheduledActionRequest.Builder> batchDeleteScheduledActionRequest) Deletes one or more scheduled actions for the specified Auto Scaling group.batchDeleteScheduledAction
(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest) Deletes one or more scheduled actions for the specified Auto Scaling group.batchPutScheduledUpdateGroupAction
(Consumer<BatchPutScheduledUpdateGroupActionRequest.Builder> batchPutScheduledUpdateGroupActionRequest) Creates or updates one or more scheduled scaling actions for an Auto Scaling group.batchPutScheduledUpdateGroupAction
(BatchPutScheduledUpdateGroupActionRequest batchPutScheduledUpdateGroupActionRequest) Creates or updates one or more scheduled scaling actions for an Auto Scaling group.static AutoScalingClientBuilder
builder()
Create a builder that can be used to configure and create aAutoScalingClient
.default CancelInstanceRefreshResponse
cancelInstanceRefresh
(Consumer<CancelInstanceRefreshRequest.Builder> cancelInstanceRefreshRequest) Cancels an instance refresh or rollback that is in progress.default CancelInstanceRefreshResponse
cancelInstanceRefresh
(CancelInstanceRefreshRequest cancelInstanceRefreshRequest) Cancels an instance refresh or rollback that is in progress.default CompleteLifecycleActionResponse
completeLifecycleAction
(Consumer<CompleteLifecycleActionRequest.Builder> completeLifecycleActionRequest) Completes the lifecycle action for the specified token or instance with the specified result.default CompleteLifecycleActionResponse
completeLifecycleAction
(CompleteLifecycleActionRequest completeLifecycleActionRequest) Completes the lifecycle action for the specified token or instance with the specified result.static AutoScalingClient
create()
Create aAutoScalingClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAutoScalingGroupResponse
createAutoScalingGroup
(Consumer<CreateAutoScalingGroupRequest.Builder> createAutoScalingGroupRequest) We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.default CreateAutoScalingGroupResponse
createAutoScalingGroup
(CreateAutoScalingGroupRequest createAutoScalingGroupRequest) We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.createLaunchConfiguration
(Consumer<CreateLaunchConfigurationRequest.Builder> createLaunchConfigurationRequest) Creates a launch configuration.createLaunchConfiguration
(CreateLaunchConfigurationRequest createLaunchConfigurationRequest) Creates a launch configuration.default CreateOrUpdateTagsResponse
createOrUpdateTags
(Consumer<CreateOrUpdateTagsRequest.Builder> createOrUpdateTagsRequest) Creates or updates tags for the specified Auto Scaling group.default CreateOrUpdateTagsResponse
createOrUpdateTags
(CreateOrUpdateTagsRequest createOrUpdateTagsRequest) Creates or updates tags for the specified Auto Scaling group.default DeleteAutoScalingGroupResponse
deleteAutoScalingGroup
(Consumer<DeleteAutoScalingGroupRequest.Builder> deleteAutoScalingGroupRequest) Deletes the specified Auto Scaling group.default DeleteAutoScalingGroupResponse
deleteAutoScalingGroup
(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest) Deletes the specified Auto Scaling group.deleteLaunchConfiguration
(Consumer<DeleteLaunchConfigurationRequest.Builder> deleteLaunchConfigurationRequest) Deletes the specified launch configuration.deleteLaunchConfiguration
(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest) Deletes the specified launch configuration.default DeleteLifecycleHookResponse
deleteLifecycleHook
(Consumer<DeleteLifecycleHookRequest.Builder> deleteLifecycleHookRequest) Deletes the specified lifecycle hook.default DeleteLifecycleHookResponse
deleteLifecycleHook
(DeleteLifecycleHookRequest deleteLifecycleHookRequest) Deletes the specified lifecycle hook.deleteNotificationConfiguration
(Consumer<DeleteNotificationConfigurationRequest.Builder> deleteNotificationConfigurationRequest) Deletes the specified notification.deleteNotificationConfiguration
(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) Deletes the specified notification.default DeletePolicyResponse
deletePolicy
(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Deletes the specified scaling policy.default DeletePolicyResponse
deletePolicy
(DeletePolicyRequest deletePolicyRequest) Deletes the specified scaling policy.default DeleteScheduledActionResponse
deleteScheduledAction
(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest) Deletes the specified scheduled action.default DeleteScheduledActionResponse
deleteScheduledAction
(DeleteScheduledActionRequest deleteScheduledActionRequest) Deletes the specified scheduled action.default DeleteTagsResponse
deleteTags
(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Deletes the specified tags.default DeleteTagsResponse
deleteTags
(DeleteTagsRequest deleteTagsRequest) Deletes the specified tags.default DeleteWarmPoolResponse
deleteWarmPool
(Consumer<DeleteWarmPoolRequest.Builder> deleteWarmPoolRequest) Deletes the warm pool for the specified Auto Scaling group.default DeleteWarmPoolResponse
deleteWarmPool
(DeleteWarmPoolRequest deleteWarmPoolRequest) Deletes the warm pool for the specified Auto Scaling group.default DescribeAccountLimitsResponse
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.default DescribeAccountLimitsResponse
describeAccountLimits
(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) Describes the current Amazon EC2 Auto Scaling resource quotas for your account.default DescribeAccountLimitsResponse
describeAccountLimits
(DescribeAccountLimitsRequest describeAccountLimitsRequest) Describes the current Amazon EC2 Auto Scaling resource quotas for your account.default DescribeAdjustmentTypesResponse
Describes the available adjustment types for step scaling and simple scaling policies.default DescribeAdjustmentTypesResponse
describeAdjustmentTypes
(Consumer<DescribeAdjustmentTypesRequest.Builder> describeAdjustmentTypesRequest) Describes the available adjustment types for step scaling and simple scaling policies.default DescribeAdjustmentTypesResponse
describeAdjustmentTypes
(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest) Describes the available adjustment types for step scaling and simple scaling policies.Gets information about the Auto Scaling groups in the account and Region.describeAutoScalingGroups
(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest) Gets information about the Auto Scaling groups in the account and Region.describeAutoScalingGroups
(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) Gets information about the Auto Scaling groups in the account and Region.This is a variant ofdescribeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation.describeAutoScalingGroupsPaginator
(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest) This is a variant ofdescribeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation.describeAutoScalingGroupsPaginator
(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) This is a variant ofdescribeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation.Gets information about the Auto Scaling instances in the account and Region.describeAutoScalingInstances
(Consumer<DescribeAutoScalingInstancesRequest.Builder> describeAutoScalingInstancesRequest) Gets information about the Auto Scaling instances in the account and Region.describeAutoScalingInstances
(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) Gets information about the Auto Scaling instances in the account and Region.This is a variant ofdescribeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation.describeAutoScalingInstancesPaginator
(Consumer<DescribeAutoScalingInstancesRequest.Builder> describeAutoScalingInstancesRequest) This is a variant ofdescribeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation.describeAutoScalingInstancesPaginator
(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) This is a variant ofdescribeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation.Describes the notification types that are supported by Amazon EC2 Auto Scaling.describeAutoScalingNotificationTypes
(Consumer<DescribeAutoScalingNotificationTypesRequest.Builder> describeAutoScalingNotificationTypesRequest) Describes the notification types that are supported by Amazon EC2 Auto Scaling.describeAutoScalingNotificationTypes
(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest) Describes the notification types that are supported by Amazon EC2 Auto Scaling.describeInstanceRefreshes
(Consumer<DescribeInstanceRefreshesRequest.Builder> describeInstanceRefreshesRequest) Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.describeInstanceRefreshes
(DescribeInstanceRefreshesRequest describeInstanceRefreshesRequest) Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.describeInstanceRefreshesPaginator
(Consumer<DescribeInstanceRefreshesRequest.Builder> describeInstanceRefreshesRequest) This is a variant ofdescribeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)
operation.describeInstanceRefreshesPaginator
(DescribeInstanceRefreshesRequest describeInstanceRefreshesRequest) This is a variant ofdescribeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)
operation.Gets information about the launch configurations in the account and Region.describeLaunchConfigurations
(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest) Gets information about the launch configurations in the account and Region.describeLaunchConfigurations
(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) Gets information about the launch configurations in the account and Region.This is a variant ofdescribeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation.describeLaunchConfigurationsPaginator
(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest) This is a variant ofdescribeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation.describeLaunchConfigurationsPaginator
(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) This is a variant ofdescribeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation.default DescribeLifecycleHooksResponse
describeLifecycleHooks
(Consumer<DescribeLifecycleHooksRequest.Builder> describeLifecycleHooksRequest) Gets information about the lifecycle hooks for the specified Auto Scaling group.default DescribeLifecycleHooksResponse
describeLifecycleHooks
(DescribeLifecycleHooksRequest describeLifecycleHooksRequest) Gets information about the lifecycle hooks for the specified Auto Scaling group.Describes the available types of lifecycle hooks.describeLifecycleHookTypes
(Consumer<DescribeLifecycleHookTypesRequest.Builder> describeLifecycleHookTypesRequest) Describes the available types of lifecycle hooks.describeLifecycleHookTypes
(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest) Describes the available types of lifecycle hooks.default DescribeLoadBalancersResponse
describeLoadBalancers
(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) default DescribeLoadBalancersResponse
describeLoadBalancers
(DescribeLoadBalancersRequest describeLoadBalancersRequest) default DescribeLoadBalancersIterable
describeLoadBalancersPaginator
(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) This is a variant ofdescribeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)
operation.default DescribeLoadBalancersIterable
describeLoadBalancersPaginator
(DescribeLoadBalancersRequest describeLoadBalancersRequest) This is a variant ofdescribeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)
operation.describeLoadBalancerTargetGroups
(Consumer<DescribeLoadBalancerTargetGroupsRequest.Builder> describeLoadBalancerTargetGroupsRequest) describeLoadBalancerTargetGroups
(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest) describeLoadBalancerTargetGroupsPaginator
(Consumer<DescribeLoadBalancerTargetGroupsRequest.Builder> describeLoadBalancerTargetGroupsRequest) This is a variant ofdescribeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)
operation.describeLoadBalancerTargetGroupsPaginator
(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest) This is a variant ofdescribeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)
operation.Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.describeMetricCollectionTypes
(Consumer<DescribeMetricCollectionTypesRequest.Builder> describeMetricCollectionTypesRequest) Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.describeMetricCollectionTypes
(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest) Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.describeNotificationConfigurations
(Consumer<DescribeNotificationConfigurationsRequest.Builder> describeNotificationConfigurationsRequest) Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.describeNotificationConfigurations
(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.This is a variant ofdescribeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation.describeNotificationConfigurationsPaginator
(Consumer<DescribeNotificationConfigurationsRequest.Builder> describeNotificationConfigurationsRequest) This is a variant ofdescribeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation.describeNotificationConfigurationsPaginator
(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) This is a variant ofdescribeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation.default DescribePoliciesResponse
Gets information about the scaling policies in the account and Region.default DescribePoliciesResponse
describePolicies
(Consumer<DescribePoliciesRequest.Builder> describePoliciesRequest) Gets information about the scaling policies in the account and Region.default DescribePoliciesResponse
describePolicies
(DescribePoliciesRequest describePoliciesRequest) Gets information about the scaling policies in the account and Region.default DescribePoliciesIterable
This is a variant ofdescribePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation.default DescribePoliciesIterable
describePoliciesPaginator
(Consumer<DescribePoliciesRequest.Builder> describePoliciesRequest) This is a variant ofdescribePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation.default DescribePoliciesIterable
describePoliciesPaginator
(DescribePoliciesRequest describePoliciesRequest) This is a variant ofdescribePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation.Gets information about the scaling activities in the account and Region.describeScalingActivities
(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest) Gets information about the scaling activities in the account and Region.describeScalingActivities
(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) Gets information about the scaling activities in the account and Region.This is a variant ofdescribeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation.describeScalingActivitiesPaginator
(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest) This is a variant ofdescribeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation.describeScalingActivitiesPaginator
(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) This is a variant ofdescribeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation.Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.describeScalingProcessTypes
(Consumer<DescribeScalingProcessTypesRequest.Builder> describeScalingProcessTypesRequest) Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.describeScalingProcessTypes
(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest) Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.default DescribeScheduledActionsResponse
Gets information about the scheduled actions that haven't run or that have not reached their end time.default DescribeScheduledActionsResponse
describeScheduledActions
(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) Gets information about the scheduled actions that haven't run or that have not reached their end time.default DescribeScheduledActionsResponse
describeScheduledActions
(DescribeScheduledActionsRequest describeScheduledActionsRequest) Gets information about the scheduled actions that haven't run or that have not reached their end time.default DescribeScheduledActionsIterable
This is a variant ofdescribeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation.default DescribeScheduledActionsIterable
describeScheduledActionsPaginator
(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) This is a variant ofdescribeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation.default DescribeScheduledActionsIterable
describeScheduledActionsPaginator
(DescribeScheduledActionsRequest describeScheduledActionsRequest) This is a variant ofdescribeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation.default DescribeTagsResponse
Describes the specified tags.default DescribeTagsResponse
describeTags
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Describes the specified tags.default DescribeTagsResponse
describeTags
(DescribeTagsRequest describeTagsRequest) Describes the specified tags.default DescribeTagsIterable
This is a variant ofdescribeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation.default DescribeTagsIterable
describeTagsPaginator
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation.default DescribeTagsIterable
describeTagsPaginator
(DescribeTagsRequest describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation.Describes the termination policies supported by Amazon EC2 Auto Scaling.describeTerminationPolicyTypes
(Consumer<DescribeTerminationPolicyTypesRequest.Builder> describeTerminationPolicyTypesRequest) Describes the termination policies supported by Amazon EC2 Auto Scaling.describeTerminationPolicyTypes
(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest) Describes the termination policies supported by Amazon EC2 Auto Scaling.default DescribeTrafficSourcesResponse
describeTrafficSources
(Consumer<DescribeTrafficSourcesRequest.Builder> describeTrafficSourcesRequest) Gets information about the traffic sources for the specified Auto Scaling group.default DescribeTrafficSourcesResponse
describeTrafficSources
(DescribeTrafficSourcesRequest describeTrafficSourcesRequest) Gets information about the traffic sources for the specified Auto Scaling group.default DescribeTrafficSourcesIterable
describeTrafficSourcesPaginator
(Consumer<DescribeTrafficSourcesRequest.Builder> describeTrafficSourcesRequest) This is a variant ofdescribeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)
operation.default DescribeTrafficSourcesIterable
describeTrafficSourcesPaginator
(DescribeTrafficSourcesRequest describeTrafficSourcesRequest) This is a variant ofdescribeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)
operation.default DescribeWarmPoolResponse
describeWarmPool
(Consumer<DescribeWarmPoolRequest.Builder> describeWarmPoolRequest) Gets information about a warm pool and its instances.default DescribeWarmPoolResponse
describeWarmPool
(DescribeWarmPoolRequest describeWarmPoolRequest) Gets information about a warm pool and its instances.default DescribeWarmPoolIterable
describeWarmPoolPaginator
(Consumer<DescribeWarmPoolRequest.Builder> describeWarmPoolRequest) This is a variant ofdescribeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)
operation.default DescribeWarmPoolIterable
describeWarmPoolPaginator
(DescribeWarmPoolRequest describeWarmPoolRequest) This is a variant ofdescribeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)
operation.default DetachInstancesResponse
detachInstances
(Consumer<DetachInstancesRequest.Builder> detachInstancesRequest) Removes one or more instances from the specified Auto Scaling group.default DetachInstancesResponse
detachInstances
(DetachInstancesRequest detachInstancesRequest) Removes one or more instances from the specified Auto Scaling group.default DetachLoadBalancersResponse
detachLoadBalancers
(Consumer<DetachLoadBalancersRequest.Builder> detachLoadBalancersRequest) default DetachLoadBalancersResponse
detachLoadBalancers
(DetachLoadBalancersRequest detachLoadBalancersRequest) detachLoadBalancerTargetGroups
(Consumer<DetachLoadBalancerTargetGroupsRequest.Builder> detachLoadBalancerTargetGroupsRequest) detachLoadBalancerTargetGroups
(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest) default DetachTrafficSourcesResponse
detachTrafficSources
(Consumer<DetachTrafficSourcesRequest.Builder> detachTrafficSourcesRequest) Detaches one or more traffic sources from the specified Auto Scaling group.default DetachTrafficSourcesResponse
detachTrafficSources
(DetachTrafficSourcesRequest detachTrafficSourcesRequest) Detaches one or more traffic sources from the specified Auto Scaling group.default DisableMetricsCollectionResponse
disableMetricsCollection
(Consumer<DisableMetricsCollectionRequest.Builder> disableMetricsCollectionRequest) Disables group metrics collection for the specified Auto Scaling group.default DisableMetricsCollectionResponse
disableMetricsCollection
(DisableMetricsCollectionRequest disableMetricsCollectionRequest) Disables group metrics collection for the specified Auto Scaling group.default EnableMetricsCollectionResponse
enableMetricsCollection
(Consumer<EnableMetricsCollectionRequest.Builder> enableMetricsCollectionRequest) Enables group metrics collection for the specified Auto Scaling group.default EnableMetricsCollectionResponse
enableMetricsCollection
(EnableMetricsCollectionRequest enableMetricsCollectionRequest) Enables group metrics collection for the specified Auto Scaling group.default EnterStandbyResponse
enterStandby
(Consumer<EnterStandbyRequest.Builder> enterStandbyRequest) Moves the specified instances into the standby state.default EnterStandbyResponse
enterStandby
(EnterStandbyRequest enterStandbyRequest) Moves the specified instances into the standby state.default ExecutePolicyResponse
executePolicy
(Consumer<ExecutePolicyRequest.Builder> executePolicyRequest) Executes the specified policy.default ExecutePolicyResponse
executePolicy
(ExecutePolicyRequest executePolicyRequest) Executes the specified policy.default ExitStandbyResponse
exitStandby
(Consumer<ExitStandbyRequest.Builder> exitStandbyRequest) Moves the specified instances out of the standby state.default ExitStandbyResponse
exitStandby
(ExitStandbyRequest exitStandbyRequest) Moves the specified instances out of the standby state.getPredictiveScalingForecast
(Consumer<GetPredictiveScalingForecastRequest.Builder> getPredictiveScalingForecastRequest) Retrieves the forecast data for a predictive scaling policy.getPredictiveScalingForecast
(GetPredictiveScalingForecastRequest getPredictiveScalingForecastRequest) Retrieves the forecast data for a predictive scaling policy.default PutLifecycleHookResponse
putLifecycleHook
(Consumer<PutLifecycleHookRequest.Builder> putLifecycleHookRequest) Creates or updates a lifecycle hook for the specified Auto Scaling group.default PutLifecycleHookResponse
putLifecycleHook
(PutLifecycleHookRequest putLifecycleHookRequest) Creates or updates a lifecycle hook for the specified Auto Scaling group.putNotificationConfiguration
(Consumer<PutNotificationConfigurationRequest.Builder> putNotificationConfigurationRequest) Configures an Auto Scaling group to send notifications when specified events take place.putNotificationConfiguration
(PutNotificationConfigurationRequest putNotificationConfigurationRequest) Configures an Auto Scaling group to send notifications when specified events take place.default PutScalingPolicyResponse
putScalingPolicy
(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest) Creates or updates a scaling policy for an Auto Scaling group.default PutScalingPolicyResponse
putScalingPolicy
(PutScalingPolicyRequest putScalingPolicyRequest) Creates or updates a scaling policy for an Auto Scaling group.putScheduledUpdateGroupAction
(Consumer<PutScheduledUpdateGroupActionRequest.Builder> putScheduledUpdateGroupActionRequest) Creates or updates a scheduled scaling action for an Auto Scaling group.putScheduledUpdateGroupAction
(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest) Creates or updates a scheduled scaling action for an Auto Scaling group.default PutWarmPoolResponse
putWarmPool
(Consumer<PutWarmPoolRequest.Builder> putWarmPoolRequest) Creates or updates a warm pool for the specified Auto Scaling group.default PutWarmPoolResponse
putWarmPool
(PutWarmPoolRequest putWarmPoolRequest) Creates or updates a warm pool for the specified Auto Scaling group.recordLifecycleActionHeartbeat
(Consumer<RecordLifecycleActionHeartbeatRequest.Builder> recordLifecycleActionHeartbeatRequest) Records a heartbeat for the lifecycle action associated with the specified token or instance.recordLifecycleActionHeartbeat
(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest) Records a heartbeat for the lifecycle action associated with the specified token or instance.default ResumeProcessesResponse
resumeProcesses
(Consumer<ResumeProcessesRequest.Builder> resumeProcessesRequest) Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.default ResumeProcessesResponse
resumeProcesses
(ResumeProcessesRequest resumeProcessesRequest) Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.default RollbackInstanceRefreshResponse
rollbackInstanceRefresh
(Consumer<RollbackInstanceRefreshRequest.Builder> rollbackInstanceRefreshRequest) Cancels an instance refresh that is in progress and rolls back any changes that it made.default RollbackInstanceRefreshResponse
rollbackInstanceRefresh
(RollbackInstanceRefreshRequest rollbackInstanceRefreshRequest) Cancels an instance refresh that is in progress and rolls back any changes that it made.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SetDesiredCapacityResponse
setDesiredCapacity
(Consumer<SetDesiredCapacityRequest.Builder> setDesiredCapacityRequest) Sets the size of the specified Auto Scaling group.default SetDesiredCapacityResponse
setDesiredCapacity
(SetDesiredCapacityRequest setDesiredCapacityRequest) Sets the size of the specified Auto Scaling group.default SetInstanceHealthResponse
setInstanceHealth
(Consumer<SetInstanceHealthRequest.Builder> setInstanceHealthRequest) Sets the health status of the specified instance.default SetInstanceHealthResponse
setInstanceHealth
(SetInstanceHealthRequest setInstanceHealthRequest) Sets the health status of the specified instance.default SetInstanceProtectionResponse
setInstanceProtection
(Consumer<SetInstanceProtectionRequest.Builder> setInstanceProtectionRequest) Updates the instance protection settings of the specified instances.default SetInstanceProtectionResponse
setInstanceProtection
(SetInstanceProtectionRequest setInstanceProtectionRequest) Updates the instance protection settings of the specified instances.default StartInstanceRefreshResponse
startInstanceRefresh
(Consumer<StartInstanceRefreshRequest.Builder> startInstanceRefreshRequest) Starts an instance refresh.default StartInstanceRefreshResponse
startInstanceRefresh
(StartInstanceRefreshRequest startInstanceRefreshRequest) Starts an instance refresh.default SuspendProcessesResponse
suspendProcesses
(Consumer<SuspendProcessesRequest.Builder> suspendProcessesRequest) Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.default SuspendProcessesResponse
suspendProcesses
(SuspendProcessesRequest suspendProcessesRequest) Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.terminateInstanceInAutoScalingGroup
(Consumer<TerminateInstanceInAutoScalingGroupRequest.Builder> terminateInstanceInAutoScalingGroupRequest) Terminates the specified instance and optionally adjusts the desired group size.terminateInstanceInAutoScalingGroup
(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest) Terminates the specified instance and optionally adjusts the desired group size.default UpdateAutoScalingGroupResponse
updateAutoScalingGroup
(Consumer<UpdateAutoScalingGroupRequest.Builder> updateAutoScalingGroupRequest) We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.default UpdateAutoScalingGroupResponse
updateAutoScalingGroup
(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest) We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.default AutoScalingWaiter
waiter()
Create an instance ofAutoScalingWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
attachInstances
default AttachInstancesResponse attachInstances(AttachInstancesRequest attachInstancesRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException 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.
- Parameters:
attachInstancesRequest
-- Returns:
- Result of the AttachInstances operation returned by the service.
- See Also:
-
attachInstances
default AttachInstancesResponse attachInstances(Consumer<AttachInstancesRequest.Builder> attachInstancesRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException 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.
This is a convenience which creates an instance of the
AttachInstancesRequest.Builder
avoiding the need to create one manually viaAttachInstancesRequest.builder()
- Parameters:
attachInstancesRequest
- AConsumer
that will call methods onAttachInstancesRequest.Builder
to create a request.- Returns:
- Result of the AttachInstances operation returned by the service.
- See Also:
-
attachLoadBalancerTargetGroups
default AttachLoadBalancerTargetGroupsResponse attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using
AttachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportAttachLoadBalancerTargetGroups
. You can use both the originalAttachLoadBalancerTargetGroups
API operation andAttachTrafficSources
on the same Auto Scaling group.Attaches 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.
This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
attachLoadBalancerTargetGroupsRequest
-- Returns:
- Result of the AttachLoadBalancerTargetGroups operation returned by the service.
- See Also:
-
-
attachLoadBalancerTargetGroups
default AttachLoadBalancerTargetGroupsResponse attachLoadBalancerTargetGroups(Consumer<AttachLoadBalancerTargetGroupsRequest.Builder> attachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using
AttachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportAttachLoadBalancerTargetGroups
. You can use both the originalAttachLoadBalancerTargetGroups
API operation andAttachTrafficSources
on the same Auto Scaling group.Attaches 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.
This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
AttachLoadBalancerTargetGroupsRequest.Builder
avoiding the need to create one manually viaAttachLoadBalancerTargetGroupsRequest.builder()
- Parameters:
attachLoadBalancerTargetGroupsRequest
- AConsumer
that will call methods onAttachLoadBalancerTargetGroupsRequest.Builder
to create a request.- Returns:
- Result of the AttachLoadBalancerTargetGroups operation returned by the service.
- See Also:
-
-
attachLoadBalancers
default AttachLoadBalancersResponse attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using
AttachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportAttachLoadBalancers
. You can use both the originalAttachLoadBalancers
API operation andAttachTrafficSources
on the same Auto Scaling group.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 a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
attachLoadBalancersRequest
-- Returns:
- Result of the AttachLoadBalancers operation returned by the service.
- See Also:
-
attachLoadBalancers
default AttachLoadBalancersResponse attachLoadBalancers(Consumer<AttachLoadBalancersRequest.Builder> attachLoadBalancersRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using
AttachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportAttachLoadBalancers
. You can use both the originalAttachLoadBalancers
API operation andAttachTrafficSources
on the same Auto Scaling group.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 a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
AttachLoadBalancersRequest.Builder
avoiding the need to create one manually viaAttachLoadBalancersRequest.builder()
- Parameters:
attachLoadBalancersRequest
- AConsumer
that will call methods onAttachLoadBalancersRequest.Builder
to create a request.- Returns:
- Result of the AttachLoadBalancers operation returned by the service.
- See Also:
-
attachTrafficSources
default AttachTrafficSourcesResponse attachTrafficSources(AttachTrafficSourcesRequest attachTrafficSourcesRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
-
Application Load Balancer
-
Classic Load Balancer
-
Gateway Load Balancer
-
Network Load Balancer
-
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
- Parameters:
attachTrafficSourcesRequest
-- Returns:
- Result of the AttachTrafficSources operation returned by the service.
- See Also:
-
-
attachTrafficSources
default AttachTrafficSourcesResponse attachTrafficSources(Consumer<AttachTrafficSourcesRequest.Builder> attachTrafficSourcesRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
-
Application Load Balancer
-
Classic Load Balancer
-
Gateway Load Balancer
-
Network Load Balancer
-
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
This is a convenience which creates an instance of the
AttachTrafficSourcesRequest.Builder
avoiding the need to create one manually viaAttachTrafficSourcesRequest.builder()
- Parameters:
attachTrafficSourcesRequest
- AConsumer
that will call methods onAttachTrafficSourcesRequest.Builder
to create a request.- Returns:
- Result of the AttachTrafficSources operation returned by the service.
- See Also:
-
-
batchDeleteScheduledAction
default BatchDeleteScheduledActionResponse batchDeleteScheduledAction(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Deletes one or more scheduled actions for the specified Auto Scaling group.
- Parameters:
batchDeleteScheduledActionRequest
-- Returns:
- Result of the BatchDeleteScheduledAction operation returned by the service.
- See Also:
-
batchDeleteScheduledAction
default BatchDeleteScheduledActionResponse batchDeleteScheduledAction(Consumer<BatchDeleteScheduledActionRequest.Builder> batchDeleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Deletes one or more scheduled actions for the specified Auto Scaling group.
This is a convenience which creates an instance of the
BatchDeleteScheduledActionRequest.Builder
avoiding the need to create one manually viaBatchDeleteScheduledActionRequest.builder()
- Parameters:
batchDeleteScheduledActionRequest
- AConsumer
that will call methods onBatchDeleteScheduledActionRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteScheduledAction operation returned by the service.
- See Also:
-
batchPutScheduledUpdateGroupAction
default BatchPutScheduledUpdateGroupActionResponse batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest batchPutScheduledUpdateGroupActionRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
- Parameters:
batchPutScheduledUpdateGroupActionRequest
-- Returns:
- Result of the BatchPutScheduledUpdateGroupAction operation returned by the service.
- See Also:
-
batchPutScheduledUpdateGroupAction
default BatchPutScheduledUpdateGroupActionResponse batchPutScheduledUpdateGroupAction(Consumer<BatchPutScheduledUpdateGroupActionRequest.Builder> batchPutScheduledUpdateGroupActionRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
This is a convenience which creates an instance of the
BatchPutScheduledUpdateGroupActionRequest.Builder
avoiding the need to create one manually viaBatchPutScheduledUpdateGroupActionRequest.builder()
- Parameters:
batchPutScheduledUpdateGroupActionRequest
- AConsumer
that will call methods onBatchPutScheduledUpdateGroupActionRequest.Builder
to create a request.- Returns:
- Result of the BatchPutScheduledUpdateGroupAction operation returned by the service.
- See Also:
-
cancelInstanceRefresh
default CancelInstanceRefreshResponse cancelInstanceRefresh(CancelInstanceRefreshRequest cancelInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, AwsServiceException, SdkClientException, AutoScalingException Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an
ActiveInstanceRefreshNotFound
error occurs.This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
- Parameters:
cancelInstanceRefreshRequest
-- Returns:
- Result of the CancelInstanceRefresh operation returned by the service.
- See Also:
-
cancelInstanceRefresh
default CancelInstanceRefreshResponse cancelInstanceRefresh(Consumer<CancelInstanceRefreshRequest.Builder> cancelInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, AwsServiceException, SdkClientException, AutoScalingException Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an
ActiveInstanceRefreshNotFound
error occurs.This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
This is a convenience which creates an instance of the
CancelInstanceRefreshRequest.Builder
avoiding the need to create one manually viaCancelInstanceRefreshRequest.builder()
- Parameters:
cancelInstanceRefreshRequest
- AConsumer
that will call methods onCancelInstanceRefreshRequest.Builder
to create a request.- Returns:
- Result of the CancelInstanceRefresh operation returned by the service.
- See Also:
-
completeLifecycleAction
default CompleteLifecycleActionResponse completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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 launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(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 wait state.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
completeLifecycleActionRequest
-- Returns:
- Result of the CompleteLifecycleAction operation returned by the service.
- See Also:
-
-
completeLifecycleAction
default CompleteLifecycleActionResponse completeLifecycleAction(Consumer<CompleteLifecycleActionRequest.Builder> completeLifecycleActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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 launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(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 wait state.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
CompleteLifecycleActionRequest.Builder
avoiding the need to create one manually viaCompleteLifecycleActionRequest.builder()
- Parameters:
completeLifecycleActionRequest
- AConsumer
that will call methods onCompleteLifecycleActionRequest.Builder
to create a request.- Returns:
- Result of the CompleteLifecycleAction operation returned by the service.
- See Also:
-
-
createAutoScalingGroup
default CreateAutoScalingGroupResponse createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException We 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 Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (
DesiredCapacity
,MaxSize
, andMinSize
). 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.- Parameters:
createAutoScalingGroupRequest
-- Returns:
- Result of the CreateAutoScalingGroup operation returned by the service.
- See Also:
-
createAutoScalingGroup
default CreateAutoScalingGroupResponse createAutoScalingGroup(Consumer<CreateAutoScalingGroupRequest.Builder> createAutoScalingGroupRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException We 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 Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (
DesiredCapacity
,MaxSize
, andMinSize
). 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.
This is a convenience which creates an instance of the
CreateAutoScalingGroupRequest.Builder
avoiding the need to create one manually viaCreateAutoScalingGroupRequest.builder()
- Parameters:
createAutoScalingGroupRequest
- AConsumer
that will call methods onCreateAutoScalingGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateAutoScalingGroup operation returned by the service.
- See Also:
-
createLaunchConfiguration
default CreateLaunchConfigurationResponse createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates 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 Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
createLaunchConfigurationRequest
-- Returns:
- Result of the CreateLaunchConfiguration operation returned by the service.
- See Also:
-
createLaunchConfiguration
default CreateLaunchConfigurationResponse createLaunchConfiguration(Consumer<CreateLaunchConfigurationRequest.Builder> createLaunchConfigurationRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates 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 Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
CreateLaunchConfigurationRequest.Builder
avoiding the need to create one manually viaCreateLaunchConfigurationRequest.builder()
- Parameters:
createLaunchConfigurationRequest
- AConsumer
that will call methods onCreateLaunchConfigurationRequest.Builder
to create a request.- Returns:
- Result of the CreateLaunchConfiguration operation returned by the service.
- See Also:
-
createOrUpdateTags
default CreateOrUpdateTagsResponse createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest) throws LimitExceededException, AlreadyExistsException, ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException 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 Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
createOrUpdateTagsRequest
-- Returns:
- Result of the CreateOrUpdateTags operation returned by the service.
- See Also:
-
createOrUpdateTags
default CreateOrUpdateTagsResponse createOrUpdateTags(Consumer<CreateOrUpdateTagsRequest.Builder> createOrUpdateTagsRequest) throws LimitExceededException, AlreadyExistsException, ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException 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 Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
CreateOrUpdateTagsRequest.Builder
avoiding the need to create one manually viaCreateOrUpdateTagsRequest.builder()
- Parameters:
createOrUpdateTagsRequest
- AConsumer
that will call methods onCreateOrUpdateTagsRequest.Builder
to create a request.- Returns:
- Result of the CreateOrUpdateTags operation returned by the service.
- See Also:
-
deleteAutoScalingGroup
default DeleteAutoScalingGroupResponse deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.
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.
If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
deleteAutoScalingGroupRequest
-- Returns:
- Result of the DeleteAutoScalingGroup operation returned by the service.
- See Also:
-
deleteAutoScalingGroup
default DeleteAutoScalingGroupResponse deleteAutoScalingGroup(Consumer<DeleteAutoScalingGroupRequest.Builder> deleteAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.
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.
If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DeleteAutoScalingGroupRequest.Builder
avoiding the need to create one manually viaDeleteAutoScalingGroupRequest.builder()
- Parameters:
deleteAutoScalingGroupRequest
- AConsumer
that will call methods onDeleteAutoScalingGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteAutoScalingGroup operation returned by the service.
- See Also:
-
deleteLaunchConfiguration
default DeleteLaunchConfigurationResponse deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
- Parameters:
deleteLaunchConfigurationRequest
-- Returns:
- Result of the DeleteLaunchConfiguration operation returned by the service.
- See Also:
-
deleteLaunchConfiguration
default DeleteLaunchConfigurationResponse deleteLaunchConfiguration(Consumer<DeleteLaunchConfigurationRequest.Builder> deleteLaunchConfigurationRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
This is a convenience which creates an instance of the
DeleteLaunchConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteLaunchConfigurationRequest.builder()
- Parameters:
deleteLaunchConfigurationRequest
- AConsumer
that will call methods onDeleteLaunchConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteLaunchConfiguration operation returned by the service.
- See Also:
-
deleteLifecycleHook
default DeleteLifecycleHookResponse deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (
ABANDON
for launching instances,CONTINUE
for terminating instances).- Parameters:
deleteLifecycleHookRequest
-- Returns:
- Result of the DeleteLifecycleHook operation returned by the service.
- See Also:
-
deleteLifecycleHook
default DeleteLifecycleHookResponse deleteLifecycleHook(Consumer<DeleteLifecycleHookRequest.Builder> deleteLifecycleHookRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (
ABANDON
for launching instances,CONTINUE
for terminating instances).
This is a convenience which creates an instance of the
DeleteLifecycleHookRequest.Builder
avoiding the need to create one manually viaDeleteLifecycleHookRequest.builder()
- Parameters:
deleteLifecycleHookRequest
- AConsumer
that will call methods onDeleteLifecycleHookRequest.Builder
to create a request.- Returns:
- Result of the DeleteLifecycleHook operation returned by the service.
- See Also:
-
deleteNotificationConfiguration
default DeleteNotificationConfigurationResponse deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Deletes the specified notification.
- Parameters:
deleteNotificationConfigurationRequest
-- Returns:
- Result of the DeleteNotificationConfiguration operation returned by the service.
- See Also:
-
deleteNotificationConfiguration
default DeleteNotificationConfigurationResponse deleteNotificationConfiguration(Consumer<DeleteNotificationConfigurationRequest.Builder> deleteNotificationConfigurationRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Deletes the specified notification.
This is a convenience which creates an instance of the
DeleteNotificationConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteNotificationConfigurationRequest.builder()
- Parameters:
deleteNotificationConfigurationRequest
- AConsumer
that will call methods onDeleteNotificationConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteNotificationConfiguration operation returned by the service.
- See Also:
-
deletePolicy
default DeletePolicyResponse deletePolicy(DeletePolicyRequest deletePolicyRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException 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.
- Parameters:
deletePolicyRequest
-- Returns:
- Result of the DeletePolicy operation returned by the service.
- See Also:
-
deletePolicy
default DeletePolicyResponse deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException 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.
This is a convenience which creates an instance of the
DeletePolicyRequest.Builder
avoiding the need to create one manually viaDeletePolicyRequest.builder()
- Parameters:
deletePolicyRequest
- AConsumer
that will call methods onDeletePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeletePolicy operation returned by the service.
- See Also:
-
deleteScheduledAction
default DeleteScheduledActionResponse deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Deletes the specified scheduled action.
- Parameters:
deleteScheduledActionRequest
-- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
- See Also:
-
deleteScheduledAction
default DeleteScheduledActionResponse deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Deletes the specified scheduled action.
This is a convenience which creates an instance of the
DeleteScheduledActionRequest.Builder
avoiding the need to create one manually viaDeleteScheduledActionRequest.builder()
- Parameters:
deleteScheduledActionRequest
- AConsumer
that will call methods onDeleteScheduledActionRequest.Builder
to create a request.- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
- See Also:
-
deleteTags
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException Deletes the specified tags.
- Parameters:
deleteTagsRequest
-- Returns:
- Result of the DeleteTags operation returned by the service.
- See Also:
-
deleteTags
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException Deletes the specified tags.
This is a convenience which creates an instance of the
DeleteTagsRequest.Builder
avoiding the need to create one manually viaDeleteTagsRequest.builder()
- Parameters:
deleteTagsRequest
- AConsumer
that will call methods onDeleteTagsRequest.Builder
to create a request.- Returns:
- Result of the DeleteTags operation returned by the service.
- See Also:
-
deleteWarmPool
default DeleteWarmPoolResponse deleteWarmPool(DeleteWarmPoolRequest deleteWarmPoolRequest) throws LimitExceededException, ResourceContentionException, ScalingActivityInProgressException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException Deletes the warm pool for the specified Auto Scaling group.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
deleteWarmPoolRequest
-- Returns:
- Result of the DeleteWarmPool operation returned by the service.
- See Also:
-
deleteWarmPool
default DeleteWarmPoolResponse deleteWarmPool(Consumer<DeleteWarmPoolRequest.Builder> deleteWarmPoolRequest) throws LimitExceededException, ResourceContentionException, ScalingActivityInProgressException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException Deletes the warm pool for the specified Auto Scaling group.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DeleteWarmPoolRequest.Builder
avoiding the need to create one manually viaDeleteWarmPoolRequest.builder()
- Parameters:
deleteWarmPoolRequest
- AConsumer
that will call methods onDeleteWarmPoolRequest.Builder
to create a request.- Returns:
- Result of the DeleteWarmPool operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeAccountLimitsRequest
-- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builder
avoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()
- Parameters:
describeAccountLimitsRequest
- AConsumer
that will call methods onDescribeAccountLimitsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionDescribes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAdjustmentTypes
default DescribeAdjustmentTypesResponse describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
-
ChangeInCapacity
-
ExactCapacity
-
PercentChangeInCapacity
- Parameters:
describeAdjustmentTypesRequest
-- Returns:
- Result of the DescribeAdjustmentTypes operation returned by the service.
- See Also:
-
-
describeAdjustmentTypes
default DescribeAdjustmentTypesResponse describeAdjustmentTypes(Consumer<DescribeAdjustmentTypesRequest.Builder> describeAdjustmentTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
-
ChangeInCapacity
-
ExactCapacity
-
PercentChangeInCapacity
This is a convenience which creates an instance of the
DescribeAdjustmentTypesRequest.Builder
avoiding the need to create one manually viaDescribeAdjustmentTypesRequest.builder()
- Parameters:
describeAdjustmentTypesRequest
- AConsumer
that will call methods onDescribeAdjustmentTypesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAdjustmentTypes operation returned by the service.
- See Also:
-
-
describeAdjustmentTypes
default DescribeAdjustmentTypesResponse describeAdjustmentTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionDescribes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
-
ChangeInCapacity
-
ExactCapacity
-
PercentChangeInCapacity
- Returns:
- Result of the DescribeAdjustmentTypes operation returned by the service.
- See Also:
-
-
describeAutoScalingGroups
default DescribeAutoScalingGroupsResponse describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
- Parameters:
describeAutoScalingGroupsRequest
-- Returns:
- Result of the DescribeAutoScalingGroups operation returned by the service.
- See Also:
-
describeAutoScalingGroups
default DescribeAutoScalingGroupsResponse describeAutoScalingGroups(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
This is a convenience which creates an instance of the
DescribeAutoScalingGroupsRequest.Builder
avoiding the need to create one manually viaDescribeAutoScalingGroupsRequest.builder()
- Parameters:
describeAutoScalingGroupsRequest
- AConsumer
that will call methods onDescribeAutoScalingGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAutoScalingGroups operation returned by the service.
- See Also:
-
describeAutoScalingGroups
default DescribeAutoScalingGroupsResponse describeAutoScalingGroups() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionGets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
- Returns:
- Result of the DescribeAutoScalingGroups operation returned by the service.
- See Also:
-
describeAutoScalingGroupsPaginator
default DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionThis is a variant of
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client .describeAutoScalingGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAutoScalingGroupsPaginator
default DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client .describeAutoScalingGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation.- Parameters:
describeAutoScalingGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAutoScalingGroupsPaginator
default DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client .describeAutoScalingGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeAutoScalingGroupsRequest.Builder
avoiding the need to create one manually viaDescribeAutoScalingGroupsRequest.builder()
- Parameters:
describeAutoScalingGroupsRequest
- AConsumer
that will call methods onDescribeAutoScalingGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAutoScalingInstances
default DescribeAutoScalingInstancesResponse describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the Auto Scaling instances in the account and Region.
- Parameters:
describeAutoScalingInstancesRequest
-- Returns:
- Result of the DescribeAutoScalingInstances operation returned by the service.
- See Also:
-
describeAutoScalingInstances
default DescribeAutoScalingInstancesResponse describeAutoScalingInstances(Consumer<DescribeAutoScalingInstancesRequest.Builder> describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the Auto Scaling instances in the account and Region.
This is a convenience which creates an instance of the
DescribeAutoScalingInstancesRequest.Builder
avoiding the need to create one manually viaDescribeAutoScalingInstancesRequest.builder()
- Parameters:
describeAutoScalingInstancesRequest
- AConsumer
that will call methods onDescribeAutoScalingInstancesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAutoScalingInstances operation returned by the service.
- See Also:
-
describeAutoScalingInstances
default DescribeAutoScalingInstancesResponse describeAutoScalingInstances() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionGets information about the Auto Scaling instances in the account and Region.
- Returns:
- Result of the DescribeAutoScalingInstances operation returned by the service.
- See Also:
-
describeAutoScalingInstancesPaginator
default DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionThis is a variant of
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client .describeAutoScalingInstancesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAutoScalingInstancesPaginator
default DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client .describeAutoScalingInstancesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation.- Parameters:
describeAutoScalingInstancesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAutoScalingInstancesPaginator
default DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator(Consumer<DescribeAutoScalingInstancesRequest.Builder> describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client .describeAutoScalingInstancesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)
operation.
This is a convenience which creates an instance of the
DescribeAutoScalingInstancesRequest.Builder
avoiding the need to create one manually viaDescribeAutoScalingInstancesRequest.builder()
- Parameters:
describeAutoScalingInstancesRequest
- AConsumer
that will call methods onDescribeAutoScalingInstancesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAutoScalingNotificationTypes
default DescribeAutoScalingNotificationTypesResponse describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the notification types that are supported by Amazon EC2 Auto Scaling.
- Parameters:
describeAutoScalingNotificationTypesRequest
-- Returns:
- Result of the DescribeAutoScalingNotificationTypes operation returned by the service.
- See Also:
-
describeAutoScalingNotificationTypes
default DescribeAutoScalingNotificationTypesResponse describeAutoScalingNotificationTypes(Consumer<DescribeAutoScalingNotificationTypesRequest.Builder> describeAutoScalingNotificationTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the notification types that are supported by Amazon EC2 Auto Scaling.
This is a convenience which creates an instance of the
DescribeAutoScalingNotificationTypesRequest.Builder
avoiding the need to create one manually viaDescribeAutoScalingNotificationTypesRequest.builder()
- Parameters:
describeAutoScalingNotificationTypesRequest
- AConsumer
that will call methods onDescribeAutoScalingNotificationTypesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAutoScalingNotificationTypes operation returned by the service.
- See Also:
-
describeAutoScalingNotificationTypes
default DescribeAutoScalingNotificationTypesResponse describeAutoScalingNotificationTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionDescribes the notification types that are supported by Amazon EC2 Auto Scaling.
- Returns:
- Result of the DescribeAutoScalingNotificationTypes operation returned by the service.
- See Also:
-
describeInstanceRefreshes
default DescribeInstanceRefreshesResponse describeInstanceRefreshes(DescribeInstanceRefreshesRequest describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
- Parameters:
describeInstanceRefreshesRequest
-- Returns:
- Result of the DescribeInstanceRefreshes operation returned by the service.
- See Also:
-
describeInstanceRefreshes
default DescribeInstanceRefreshesResponse describeInstanceRefreshes(Consumer<DescribeInstanceRefreshesRequest.Builder> describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
This is a convenience which creates an instance of the
DescribeInstanceRefreshesRequest.Builder
avoiding the need to create one manually viaDescribeInstanceRefreshesRequest.builder()
- Parameters:
describeInstanceRefreshesRequest
- AConsumer
that will call methods onDescribeInstanceRefreshesRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstanceRefreshes operation returned by the service.
- See Also:
-
describeInstanceRefreshesPaginator
default DescribeInstanceRefreshesIterable describeInstanceRefreshesPaginator(DescribeInstanceRefreshesRequest describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client.describeInstanceRefreshesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client .describeInstanceRefreshesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client.describeInstanceRefreshesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)
operation.- Parameters:
describeInstanceRefreshesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeInstanceRefreshesPaginator
default DescribeInstanceRefreshesIterable describeInstanceRefreshesPaginator(Consumer<DescribeInstanceRefreshesRequest.Builder> describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client.describeInstanceRefreshesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client .describeInstanceRefreshesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client.describeInstanceRefreshesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)
operation.
This is a convenience which creates an instance of the
DescribeInstanceRefreshesRequest.Builder
avoiding the need to create one manually viaDescribeInstanceRefreshesRequest.builder()
- Parameters:
describeInstanceRefreshesRequest
- AConsumer
that will call methods onDescribeInstanceRefreshesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLaunchConfigurations
default DescribeLaunchConfigurationsResponse describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the launch configurations in the account and Region.
- Parameters:
describeLaunchConfigurationsRequest
-- Returns:
- Result of the DescribeLaunchConfigurations operation returned by the service.
- See Also:
-
describeLaunchConfigurations
default DescribeLaunchConfigurationsResponse describeLaunchConfigurations(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the launch configurations in the account and Region.
This is a convenience which creates an instance of the
DescribeLaunchConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeLaunchConfigurationsRequest.builder()
- Parameters:
describeLaunchConfigurationsRequest
- AConsumer
that will call methods onDescribeLaunchConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeLaunchConfigurations operation returned by the service.
- See Also:
-
describeLaunchConfigurations
default DescribeLaunchConfigurationsResponse describeLaunchConfigurations() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionGets information about the launch configurations in the account and Region.
- Returns:
- Result of the DescribeLaunchConfigurations operation returned by the service.
- See Also:
-
describeLaunchConfigurationsPaginator
default DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionThis is a variant of
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client .describeLaunchConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLaunchConfigurationsPaginator
default DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client .describeLaunchConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation.- Parameters:
describeLaunchConfigurationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLaunchConfigurationsPaginator
default DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client .describeLaunchConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeLaunchConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeLaunchConfigurationsRequest.builder()
- Parameters:
describeLaunchConfigurationsRequest
- AConsumer
that will call methods onDescribeLaunchConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLifecycleHookTypes
default DescribeLifecycleHookTypesResponse describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the available types of lifecycle hooks.
The following hook types are supported:
-
autoscaling:EC2_INSTANCE_LAUNCHING
-
autoscaling:EC2_INSTANCE_TERMINATING
- Parameters:
describeLifecycleHookTypesRequest
-- Returns:
- Result of the DescribeLifecycleHookTypes operation returned by the service.
- See Also:
-
-
describeLifecycleHookTypes
default DescribeLifecycleHookTypesResponse describeLifecycleHookTypes(Consumer<DescribeLifecycleHookTypesRequest.Builder> describeLifecycleHookTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the available types of lifecycle hooks.
The following hook types are supported:
-
autoscaling:EC2_INSTANCE_LAUNCHING
-
autoscaling:EC2_INSTANCE_TERMINATING
This is a convenience which creates an instance of the
DescribeLifecycleHookTypesRequest.Builder
avoiding the need to create one manually viaDescribeLifecycleHookTypesRequest.builder()
- Parameters:
describeLifecycleHookTypesRequest
- AConsumer
that will call methods onDescribeLifecycleHookTypesRequest.Builder
to create a request.- Returns:
- Result of the DescribeLifecycleHookTypes operation returned by the service.
- See Also:
-
-
describeLifecycleHookTypes
default DescribeLifecycleHookTypesResponse describeLifecycleHookTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionDescribes the available types of lifecycle hooks.
The following hook types are supported:
-
autoscaling:EC2_INSTANCE_LAUNCHING
-
autoscaling:EC2_INSTANCE_TERMINATING
- Returns:
- Result of the DescribeLifecycleHookTypes operation returned by the service.
- See Also:
-
-
describeLifecycleHooks
default DescribeLifecycleHooksResponse describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the lifecycle hooks for the specified Auto Scaling group.
- Parameters:
describeLifecycleHooksRequest
-- Returns:
- Result of the DescribeLifecycleHooks operation returned by the service.
- See Also:
-
describeLifecycleHooks
default DescribeLifecycleHooksResponse describeLifecycleHooks(Consumer<DescribeLifecycleHooksRequest.Builder> describeLifecycleHooksRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the lifecycle hooks for the specified Auto Scaling group.
This is a convenience which creates an instance of the
DescribeLifecycleHooksRequest.Builder
avoiding the need to create one manually viaDescribeLifecycleHooksRequest.builder()
- Parameters:
describeLifecycleHooksRequest
- AConsumer
that will call methods onDescribeLifecycleHooksRequest.Builder
to create a request.- Returns:
- Result of the DescribeLifecycleHooks operation returned by the service.
- See Also:
-
describeLoadBalancerTargetGroups
default DescribeLoadBalancerTargetGroupsResponse describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using
DetachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportDescribeLoadBalancerTargetGroups
. You can use both the originalDescribeLoadBalancerTargetGroups
API operation andDescribeTrafficSources
on the same Auto Scaling group.Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
To determine the attachment status of the target group, use the
State
element in the response. When you attach a target group to an Auto Scaling group, the initialState
value isAdding
. The state transitions toAdded
after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions toInService
after at least one Auto Scaling instance passes the health check. When the target group is in theInService
state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter theInService
state.Target groups also have an
InService
state if you attach them in the CreateAutoScalingGroup API call. If your target group state isInService
, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
- Parameters:
describeLoadBalancerTargetGroupsRequest
-- Returns:
- Result of the DescribeLoadBalancerTargetGroups operation returned by the service.
- See Also:
-
describeLoadBalancerTargetGroups
default DescribeLoadBalancerTargetGroupsResponse describeLoadBalancerTargetGroups(Consumer<DescribeLoadBalancerTargetGroupsRequest.Builder> describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using
DetachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportDescribeLoadBalancerTargetGroups
. You can use both the originalDescribeLoadBalancerTargetGroups
API operation andDescribeTrafficSources
on the same Auto Scaling group.Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
To determine the attachment status of the target group, use the
State
element in the response. When you attach a target group to an Auto Scaling group, the initialState
value isAdding
. The state transitions toAdded
after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions toInService
after at least one Auto Scaling instance passes the health check. When the target group is in theInService
state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter theInService
state.Target groups also have an
InService
state if you attach them in the CreateAutoScalingGroup API call. If your target group state isInService
, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
This is a convenience which creates an instance of the
DescribeLoadBalancerTargetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancerTargetGroupsRequest.builder()
- Parameters:
describeLoadBalancerTargetGroupsRequest
- AConsumer
that will call methods onDescribeLoadBalancerTargetGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeLoadBalancerTargetGroups operation returned by the service.
- See Also:
-
describeLoadBalancerTargetGroupsPaginator
default DescribeLoadBalancerTargetGroupsIterable describeLoadBalancerTargetGroupsPaginator(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client.describeLoadBalancerTargetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client .describeLoadBalancerTargetGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client.describeLoadBalancerTargetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)
operation.- Parameters:
describeLoadBalancerTargetGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLoadBalancerTargetGroupsPaginator
default DescribeLoadBalancerTargetGroupsIterable describeLoadBalancerTargetGroupsPaginator(Consumer<DescribeLoadBalancerTargetGroupsRequest.Builder> describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client.describeLoadBalancerTargetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client .describeLoadBalancerTargetGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client.describeLoadBalancerTargetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeLoadBalancerTargetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancerTargetGroupsRequest.builder()
- Parameters:
describeLoadBalancerTargetGroupsRequest
- AConsumer
that will call methods onDescribeLoadBalancerTargetGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLoadBalancers
default DescribeLoadBalancersResponse describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using
DescribeTrafficSources
to simplify how you manage traffic sources. However, we continue to supportDescribeLoadBalancers
. You can use both the originalDescribeLoadBalancers
API operation andDescribeTrafficSources
on the same Auto Scaling group.Gets information about 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.
To determine the attachment status of the load balancer, use the
State
element in the response. When you attach a load balancer to an Auto Scaling group, the initialState
value isAdding
. The state transitions toAdded
after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions toInService
after at least one Auto Scaling instance passes the health check. When the load balancer is in theInService
state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter theInService
state.Load balancers also have an
InService
state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state isInService
, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeLoadBalancersRequest
-- Returns:
- Result of the DescribeLoadBalancers operation returned by the service.
- See Also:
-
describeLoadBalancers
default DescribeLoadBalancersResponse describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using
DescribeTrafficSources
to simplify how you manage traffic sources. However, we continue to supportDescribeLoadBalancers
. You can use both the originalDescribeLoadBalancers
API operation andDescribeTrafficSources
on the same Auto Scaling group.Gets information about 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.
To determine the attachment status of the load balancer, use the
State
element in the response. When you attach a load balancer to an Auto Scaling group, the initialState
value isAdding
. The state transitions toAdded
after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions toInService
after at least one Auto Scaling instance passes the health check. When the load balancer is in theInService
state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter theInService
state.Load balancers also have an
InService
state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state isInService
, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeLoadBalancersRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancersRequest.builder()
- Parameters:
describeLoadBalancersRequest
- AConsumer
that will call methods onDescribeLoadBalancersRequest.Builder
to create a request.- Returns:
- Result of the DescribeLoadBalancers operation returned by the service.
- See Also:
-
describeLoadBalancersPaginator
default DescribeLoadBalancersIterable describeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client .describeLoadBalancersPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)
operation.- Parameters:
describeLoadBalancersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLoadBalancersPaginator
default DescribeLoadBalancersIterable describeLoadBalancersPaginator(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client .describeLoadBalancersPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)
operation.
This is a convenience which creates an instance of the
DescribeLoadBalancersRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancersRequest.builder()
- Parameters:
describeLoadBalancersRequest
- AConsumer
that will call methods onDescribeLoadBalancersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeMetricCollectionTypes
default DescribeMetricCollectionTypesResponse describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
- Parameters:
describeMetricCollectionTypesRequest
-- Returns:
- Result of the DescribeMetricCollectionTypes operation returned by the service.
- See Also:
-
describeMetricCollectionTypes
default DescribeMetricCollectionTypesResponse describeMetricCollectionTypes(Consumer<DescribeMetricCollectionTypesRequest.Builder> describeMetricCollectionTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
This is a convenience which creates an instance of the
DescribeMetricCollectionTypesRequest.Builder
avoiding the need to create one manually viaDescribeMetricCollectionTypesRequest.builder()
- Parameters:
describeMetricCollectionTypesRequest
- AConsumer
that will call methods onDescribeMetricCollectionTypesRequest.Builder
to create a request.- Returns:
- Result of the DescribeMetricCollectionTypes operation returned by the service.
- See Also:
-
describeMetricCollectionTypes
default DescribeMetricCollectionTypesResponse describeMetricCollectionTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionDescribes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
- Returns:
- Result of the DescribeMetricCollectionTypes operation returned by the service.
- See Also:
-
describeNotificationConfigurations
default DescribeNotificationConfigurationsResponse describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
- Parameters:
describeNotificationConfigurationsRequest
-- Returns:
- Result of the DescribeNotificationConfigurations operation returned by the service.
- See Also:
-
describeNotificationConfigurations
default DescribeNotificationConfigurationsResponse describeNotificationConfigurations(Consumer<DescribeNotificationConfigurationsRequest.Builder> describeNotificationConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
This is a convenience which creates an instance of the
DescribeNotificationConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeNotificationConfigurationsRequest.builder()
- Parameters:
describeNotificationConfigurationsRequest
- AConsumer
that will call methods onDescribeNotificationConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeNotificationConfigurations operation returned by the service.
- See Also:
-
describeNotificationConfigurations
default DescribeNotificationConfigurationsResponse describeNotificationConfigurations() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionGets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
- Returns:
- Result of the DescribeNotificationConfigurations operation returned by the service.
- See Also:
-
describeNotificationConfigurationsPaginator
default DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionThis is a variant of
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client .describeNotificationConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeNotificationConfigurationsPaginator
default DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client .describeNotificationConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation.- Parameters:
describeNotificationConfigurationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeNotificationConfigurationsPaginator
default DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator(Consumer<DescribeNotificationConfigurationsRequest.Builder> describeNotificationConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client .describeNotificationConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeNotificationConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeNotificationConfigurationsRequest.builder()
- Parameters:
describeNotificationConfigurationsRequest
- AConsumer
that will call methods onDescribeNotificationConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePolicies
default DescribePoliciesResponse describePolicies(DescribePoliciesRequest describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the scaling policies in the account and Region.
- Parameters:
describePoliciesRequest
-- Returns:
- Result of the DescribePolicies operation returned by the service.
- See Also:
-
describePolicies
default DescribePoliciesResponse describePolicies(Consumer<DescribePoliciesRequest.Builder> describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the scaling policies in the account and Region.
This is a convenience which creates an instance of the
DescribePoliciesRequest.Builder
avoiding the need to create one manually viaDescribePoliciesRequest.builder()
- Parameters:
describePoliciesRequest
- AConsumer
that will call methods onDescribePoliciesRequest.Builder
to create a request.- Returns:
- Result of the DescribePolicies operation returned by the service.
- See Also:
-
describePolicies
default DescribePoliciesResponse describePolicies() throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingExceptionGets information about the scaling policies in the account and Region.
- Returns:
- Result of the DescribePolicies operation returned by the service.
- See Also:
-
describePoliciesPaginator
default DescribePoliciesIterable describePoliciesPaginator() throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingExceptionThis is a variant of
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client .describePoliciesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePoliciesPaginator
default DescribePoliciesIterable describePoliciesPaginator(DescribePoliciesRequest describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client .describePoliciesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation.- Parameters:
describePoliciesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePoliciesPaginator
default DescribePoliciesIterable describePoliciesPaginator(Consumer<DescribePoliciesRequest.Builder> describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client .describePoliciesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)
operation.
This is a convenience which creates an instance of the
DescribePoliciesRequest.Builder
avoiding the need to create one manually viaDescribePoliciesRequest.builder()
- Parameters:
describePoliciesRequest
- AConsumer
that will call methods onDescribePoliciesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeScalingActivities
default DescribeScalingActivitiesResponse describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the
StatusCode
element in the response isSuccessful
. If an attempt to launch instances failed, theStatusCode
value isFailed
orCancelled
and theStatusMessage
element in the response indicates the cause of the failure. For help interpreting theStatusMessage
, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.- Parameters:
describeScalingActivitiesRequest
-- Returns:
- Result of the DescribeScalingActivities operation returned by the service.
- See Also:
-
describeScalingActivities
default DescribeScalingActivitiesResponse describeScalingActivities(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the
StatusCode
element in the response isSuccessful
. If an attempt to launch instances failed, theStatusCode
value isFailed
orCancelled
and theStatusMessage
element in the response indicates the cause of the failure. For help interpreting theStatusMessage
, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeScalingActivitiesRequest.Builder
avoiding the need to create one manually viaDescribeScalingActivitiesRequest.builder()
- Parameters:
describeScalingActivitiesRequest
- AConsumer
that will call methods onDescribeScalingActivitiesRequest.Builder
to create a request.- Returns:
- Result of the DescribeScalingActivities operation returned by the service.
- See Also:
-
describeScalingActivities
default DescribeScalingActivitiesResponse describeScalingActivities() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionGets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the
StatusCode
element in the response isSuccessful
. If an attempt to launch instances failed, theStatusCode
value isFailed
orCancelled
and theStatusMessage
element in the response indicates the cause of the failure. For help interpreting theStatusMessage
, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Result of the DescribeScalingActivities operation returned by the service.
- See Also:
-
describeScalingActivitiesPaginator
default DescribeScalingActivitiesIterable describeScalingActivitiesPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionThis is a variant of
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client .describeScalingActivitiesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeScalingActivitiesPaginator
default DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client .describeScalingActivitiesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation.- Parameters:
describeScalingActivitiesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeScalingActivitiesPaginator
default DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client .describeScalingActivitiesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)
operation.
This is a convenience which creates an instance of the
DescribeScalingActivitiesRequest.Builder
avoiding the need to create one manually viaDescribeScalingActivitiesRequest.builder()
- Parameters:
describeScalingActivitiesRequest
- AConsumer
that will call methods onDescribeScalingActivitiesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeScalingProcessTypes
default DescribeScalingProcessTypesResponse describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
- Parameters:
describeScalingProcessTypesRequest
-- Returns:
- Result of the DescribeScalingProcessTypes operation returned by the service.
- See Also:
-
describeScalingProcessTypes
default DescribeScalingProcessTypesResponse describeScalingProcessTypes(Consumer<DescribeScalingProcessTypesRequest.Builder> describeScalingProcessTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
This is a convenience which creates an instance of the
DescribeScalingProcessTypesRequest.Builder
avoiding the need to create one manually viaDescribeScalingProcessTypesRequest.builder()
- Parameters:
describeScalingProcessTypesRequest
- AConsumer
that will call methods onDescribeScalingProcessTypesRequest.Builder
to create a request.- Returns:
- Result of the DescribeScalingProcessTypes operation returned by the service.
- See Also:
-
describeScalingProcessTypes
default DescribeScalingProcessTypesResponse describeScalingProcessTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionDescribes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
- Returns:
- Result of the DescribeScalingProcessTypes operation returned by the service.
- See Also:
-
describeScheduledActions
default DescribeScheduledActionsResponse describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
- Parameters:
describeScheduledActionsRequest
-- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- See Also:
-
describeScheduledActions
default DescribeScheduledActionsResponse describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
This is a convenience which creates an instance of the
DescribeScheduledActionsRequest.Builder
avoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()
- Parameters:
describeScheduledActionsRequest
- AConsumer
that will call methods onDescribeScheduledActionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- See Also:
-
describeScheduledActions
default DescribeScheduledActionsResponse describeScheduledActions() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionGets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- See Also:
-
describeScheduledActionsPaginator
default DescribeScheduledActionsIterable describeScheduledActionsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionThis is a variant of
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client .describeScheduledActionsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeScheduledActionsPaginator
default DescribeScheduledActionsIterable describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client .describeScheduledActionsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation.- Parameters:
describeScheduledActionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeScheduledActionsPaginator
default DescribeScheduledActionsIterable describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client .describeScheduledActionsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeScheduledActionsRequest.Builder
avoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()
- Parameters:
describeScheduledActionsRequest
- AConsumer
that will call methods onDescribeScheduledActionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTags
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeTagsRequest
-- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
describeTags
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builder
avoiding the need to create one manually viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
describeTags
default DescribeTagsResponse describeTags() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionDescribes 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 Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionThis is a variant of
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator(DescribeTagsRequest describeTagsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation.- Parameters:
describeTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)
operation.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builder
avoiding the need to create one manually viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTerminationPolicyTypes
default DescribeTerminationPolicyTypesResponse describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeTerminationPolicyTypesRequest
-- Returns:
- Result of the DescribeTerminationPolicyTypes operation returned by the service.
- See Also:
-
describeTerminationPolicyTypes
default DescribeTerminationPolicyTypesResponse describeTerminationPolicyTypes(Consumer<DescribeTerminationPolicyTypesRequest.Builder> describeTerminationPolicyTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeTerminationPolicyTypesRequest.Builder
avoiding the need to create one manually viaDescribeTerminationPolicyTypesRequest.builder()
- Parameters:
describeTerminationPolicyTypesRequest
- AConsumer
that will call methods onDescribeTerminationPolicyTypesRequest.Builder
to create a request.- Returns:
- Result of the DescribeTerminationPolicyTypes operation returned by the service.
- See Also:
-
describeTerminationPolicyTypes
default DescribeTerminationPolicyTypesResponse describeTerminationPolicyTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingExceptionDescribes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- Result of the DescribeTerminationPolicyTypes operation returned by the service.
- See Also:
-
describeTrafficSources
default DescribeTrafficSourcesResponse describeTrafficSources(DescribeTrafficSourcesRequest describeTrafficSourcesRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
- Parameters:
describeTrafficSourcesRequest
-- Returns:
- Result of the DescribeTrafficSources operation returned by the service.
- See Also:
-
describeTrafficSources
default DescribeTrafficSourcesResponse describeTrafficSources(Consumer<DescribeTrafficSourcesRequest.Builder> describeTrafficSourcesRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
This is a convenience which creates an instance of the
DescribeTrafficSourcesRequest.Builder
avoiding the need to create one manually viaDescribeTrafficSourcesRequest.builder()
- Parameters:
describeTrafficSourcesRequest
- AConsumer
that will call methods onDescribeTrafficSourcesRequest.Builder
to create a request.- Returns:
- Result of the DescribeTrafficSources operation returned by the service.
- See Also:
-
describeTrafficSourcesPaginator
default DescribeTrafficSourcesIterable describeTrafficSourcesPaginator(DescribeTrafficSourcesRequest describeTrafficSourcesRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client.describeTrafficSourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client .describeTrafficSourcesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client.describeTrafficSourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)
operation.- Parameters:
describeTrafficSourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTrafficSourcesPaginator
default DescribeTrafficSourcesIterable describeTrafficSourcesPaginator(Consumer<DescribeTrafficSourcesRequest.Builder> describeTrafficSourcesRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client.describeTrafficSourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client .describeTrafficSourcesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client.describeTrafficSourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)
operation.
This is a convenience which creates an instance of the
DescribeTrafficSourcesRequest.Builder
avoiding the need to create one manually viaDescribeTrafficSourcesRequest.builder()
- Parameters:
describeTrafficSourcesRequest
- AConsumer
that will call methods onDescribeTrafficSourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWarmPool
default DescribeWarmPoolResponse describeWarmPool(DescribeWarmPoolRequest describeWarmPoolRequest) throws InvalidNextTokenException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeWarmPoolRequest
-- Returns:
- Result of the DescribeWarmPool operation returned by the service.
- See Also:
-
describeWarmPool
default DescribeWarmPoolResponse describeWarmPool(Consumer<DescribeWarmPoolRequest.Builder> describeWarmPoolRequest) throws InvalidNextTokenException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Gets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeWarmPoolRequest.Builder
avoiding the need to create one manually viaDescribeWarmPoolRequest.builder()
- Parameters:
describeWarmPoolRequest
- AConsumer
that will call methods onDescribeWarmPoolRequest.Builder
to create a request.- Returns:
- Result of the DescribeWarmPool operation returned by the service.
- See Also:
-
describeWarmPoolPaginator
default DescribeWarmPoolIterable describeWarmPoolPaginator(DescribeWarmPoolRequest describeWarmPoolRequest) throws InvalidNextTokenException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client.describeWarmPoolPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client .describeWarmPoolPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client.describeWarmPoolPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)
operation.- Parameters:
describeWarmPoolRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWarmPoolPaginator
default DescribeWarmPoolIterable describeWarmPoolPaginator(Consumer<DescribeWarmPoolRequest.Builder> describeWarmPoolRequest) throws InvalidNextTokenException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This is a variant of
describeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client.describeWarmPoolPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client .describeWarmPoolPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client.describeWarmPoolPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)
operation.
This is a convenience which creates an instance of the
DescribeWarmPoolRequest.Builder
avoiding the need to create one manually viaDescribeWarmPoolRequest.builder()
- Parameters:
describeWarmPoolRequest
- AConsumer
that will call methods onDescribeWarmPoolRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
detachInstances
default DetachInstancesResponse detachInstances(DetachInstancesRequest detachInstancesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
- Parameters:
detachInstancesRequest
-- Returns:
- Result of the DetachInstances operation returned by the service.
- See Also:
-
detachInstances
default DetachInstancesResponse detachInstances(Consumer<DetachInstancesRequest.Builder> detachInstancesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
This is a convenience which creates an instance of the
DetachInstancesRequest.Builder
avoiding the need to create one manually viaDetachInstancesRequest.builder()
- Parameters:
detachInstancesRequest
- AConsumer
that will call methods onDetachInstancesRequest.Builder
to create a request.- Returns:
- Result of the DetachInstances operation returned by the service.
- See Also:
-
detachLoadBalancerTargetGroups
default DetachLoadBalancerTargetGroupsResponse detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using
DetachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportDetachLoadBalancerTargetGroups
. You can use both the originalDetachLoadBalancerTargetGroups
API operation andDetachTrafficSources
on the same Auto Scaling group.Detaches one or more target groups from the specified Auto Scaling group.
When you detach a target group, it enters the
Removing
state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running.You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
- Parameters:
detachLoadBalancerTargetGroupsRequest
-- Returns:
- Result of the DetachLoadBalancerTargetGroups operation returned by the service.
- See Also:
-
detachLoadBalancerTargetGroups
default DetachLoadBalancerTargetGroupsResponse detachLoadBalancerTargetGroups(Consumer<DetachLoadBalancerTargetGroupsRequest.Builder> detachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using
DetachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportDetachLoadBalancerTargetGroups
. You can use both the originalDetachLoadBalancerTargetGroups
API operation andDetachTrafficSources
on the same Auto Scaling group.Detaches one or more target groups from the specified Auto Scaling group.
When you detach a target group, it enters the
Removing
state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running.You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
This is a convenience which creates an instance of the
DetachLoadBalancerTargetGroupsRequest.Builder
avoiding the need to create one manually viaDetachLoadBalancerTargetGroupsRequest.builder()
- Parameters:
detachLoadBalancerTargetGroupsRequest
- AConsumer
that will call methods onDetachLoadBalancerTargetGroupsRequest.Builder
to create a request.- Returns:
- Result of the DetachLoadBalancerTargetGroups operation returned by the service.
- See Also:
-
detachLoadBalancers
default DetachLoadBalancersResponse detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using
DetachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportDetachLoadBalancers
. You can use both the originalDetachLoadBalancers
API operation andDetachTrafficSources
on the same Auto Scaling group.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, 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.- Parameters:
detachLoadBalancersRequest
-- Returns:
- Result of the DetachLoadBalancers operation returned by the service.
- See Also:
-
detachLoadBalancers
default DetachLoadBalancersResponse detachLoadBalancers(Consumer<DetachLoadBalancersRequest.Builder> detachLoadBalancersRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using
DetachTrafficSources
to simplify how you manage traffic sources. However, we continue to supportDetachLoadBalancers
. You can use both the originalDetachLoadBalancers
API operation andDetachTrafficSources
on the same Auto Scaling group.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, 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.
This is a convenience which creates an instance of the
DetachLoadBalancersRequest.Builder
avoiding the need to create one manually viaDetachLoadBalancersRequest.builder()
- Parameters:
detachLoadBalancersRequest
- AConsumer
that will call methods onDetachLoadBalancersRequest.Builder
to create a request.- Returns:
- Result of the DetachLoadBalancers operation returned by the service.
- See Also:
-
detachTrafficSources
default DetachTrafficSourcesResponse detachTrafficSources(DetachTrafficSourcesRequest detachTrafficSourcesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Detaches one or more traffic sources from the specified Auto Scaling group.
When you detach a traffic source, it enters the
Removing
state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.- Parameters:
detachTrafficSourcesRequest
-- Returns:
- Result of the DetachTrafficSources operation returned by the service.
- See Also:
-
detachTrafficSources
default DetachTrafficSourcesResponse detachTrafficSources(Consumer<DetachTrafficSourcesRequest.Builder> detachTrafficSourcesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Detaches one or more traffic sources from the specified Auto Scaling group.
When you detach a traffic source, it enters the
Removing
state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.
This is a convenience which creates an instance of the
DetachTrafficSourcesRequest.Builder
avoiding the need to create one manually viaDetachTrafficSourcesRequest.builder()
- Parameters:
detachTrafficSourcesRequest
- AConsumer
that will call methods onDetachTrafficSourcesRequest.Builder
to create a request.- Returns:
- Result of the DetachTrafficSources operation returned by the service.
- See Also:
-
disableMetricsCollection
default DisableMetricsCollectionResponse disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Disables group metrics collection for the specified Auto Scaling group.
- Parameters:
disableMetricsCollectionRequest
-- Returns:
- Result of the DisableMetricsCollection operation returned by the service.
- See Also:
-
disableMetricsCollection
default DisableMetricsCollectionResponse disableMetricsCollection(Consumer<DisableMetricsCollectionRequest.Builder> disableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Disables group metrics collection for the specified Auto Scaling group.
This is a convenience which creates an instance of the
DisableMetricsCollectionRequest.Builder
avoiding the need to create one manually viaDisableMetricsCollectionRequest.builder()
- Parameters:
disableMetricsCollectionRequest
- AConsumer
that will call methods onDisableMetricsCollectionRequest.Builder
to create a request.- Returns:
- Result of the DisableMetricsCollection operation returned by the service.
- See Also:
-
enableMetricsCollection
default EnableMetricsCollectionResponse enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Enables group metrics collection for the specified Auto Scaling group.
You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
enableMetricsCollectionRequest
-- Returns:
- Result of the EnableMetricsCollection operation returned by the service.
- See Also:
-
enableMetricsCollection
default EnableMetricsCollectionResponse enableMetricsCollection(Consumer<EnableMetricsCollectionRequest.Builder> enableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Enables group metrics collection for the specified Auto Scaling group.
You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
EnableMetricsCollectionRequest.Builder
avoiding the need to create one manually viaEnableMetricsCollectionRequest.builder()
- Parameters:
enableMetricsCollectionRequest
- AConsumer
that will call methods onEnableMetricsCollectionRequest.Builder
to create a request.- Returns:
- Result of the EnableMetricsCollection operation returned by the service.
- See Also:
-
enterStandby
default EnterStandbyResponse enterStandby(EnterStandbyRequest enterStandbyRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
- Parameters:
enterStandbyRequest
-- Returns:
- Result of the EnterStandby operation returned by the service.
- See Also:
-
enterStandby
default EnterStandbyResponse enterStandby(Consumer<EnterStandbyRequest.Builder> enterStandbyRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
This is a convenience which creates an instance of the
EnterStandbyRequest.Builder
avoiding the need to create one manually viaEnterStandbyRequest.builder()
- Parameters:
enterStandbyRequest
- AConsumer
that will call methods onEnterStandbyRequest.Builder
to create a request.- Returns:
- Result of the EnterStandby operation returned by the service.
- See Also:
-
executePolicy
default ExecutePolicyResponse executePolicy(ExecutePolicyRequest executePolicyRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Executes the specified policy. This can be useful for testing the design of your scaling policy.
- Parameters:
executePolicyRequest
-- Returns:
- Result of the ExecutePolicy operation returned by the service.
- See Also:
-
executePolicy
default ExecutePolicyResponse executePolicy(Consumer<ExecutePolicyRequest.Builder> executePolicyRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Executes the specified policy. This can be useful for testing the design of your scaling policy.
This is a convenience which creates an instance of the
ExecutePolicyRequest.Builder
avoiding the need to create one manually viaExecutePolicyRequest.builder()
- Parameters:
executePolicyRequest
- AConsumer
that will call methods onExecutePolicyRequest.Builder
to create a request.- Returns:
- Result of the ExecutePolicy operation returned by the service.
- See Also:
-
exitStandby
default ExitStandbyResponse exitStandby(ExitStandbyRequest exitStandbyRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
- Parameters:
exitStandbyRequest
-- Returns:
- Result of the ExitStandby operation returned by the service.
- See Also:
-
exitStandby
default ExitStandbyResponse exitStandby(Consumer<ExitStandbyRequest.Builder> exitStandbyRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
This is a convenience which creates an instance of the
ExitStandbyRequest.Builder
avoiding the need to create one manually viaExitStandbyRequest.builder()
- Parameters:
exitStandbyRequest
- AConsumer
that will call methods onExitStandbyRequest.Builder
to create a request.- Returns:
- Result of the ExitStandby operation returned by the service.
- See Also:
-
getPredictiveScalingForecast
default GetPredictiveScalingForecastResponse getPredictiveScalingForecast(GetPredictiveScalingForecastRequest getPredictiveScalingForecastRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
getPredictiveScalingForecastRequest
-- Returns:
- Result of the GetPredictiveScalingForecast operation returned by the service.
- See Also:
-
getPredictiveScalingForecast
default GetPredictiveScalingForecastResponse getPredictiveScalingForecast(Consumer<GetPredictiveScalingForecastRequest.Builder> getPredictiveScalingForecastRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
GetPredictiveScalingForecastRequest.Builder
avoiding the need to create one manually viaGetPredictiveScalingForecastRequest.builder()
- Parameters:
getPredictiveScalingForecastRequest
- AConsumer
that will call methods onGetPredictiveScalingForecastRequest.Builder
to create a request.- Returns:
- Result of the GetPredictiveScalingForecast operation returned by the service.
- See Also:
-
putLifecycleHook
default PutLifecycleHookResponse putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates a lifecycle hook for the specified Auto Scaling group.
Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
-
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(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 wait state using the RecordLifecycleActionHeartbeat API call.
-
If you finish before the timeout period ends, send a callback by 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.
- Parameters:
putLifecycleHookRequest
-- Returns:
- Result of the PutLifecycleHook operation returned by the service.
- See Also:
-
-
putLifecycleHook
default PutLifecycleHookResponse putLifecycleHook(Consumer<PutLifecycleHookRequest.Builder> putLifecycleHookRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates a lifecycle hook for the specified Auto Scaling group.
Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
-
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(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 wait state using the RecordLifecycleActionHeartbeat API call.
-
If you finish before the timeout period ends, send a callback by 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.
This is a convenience which creates an instance of the
PutLifecycleHookRequest.Builder
avoiding the need to create one manually viaPutLifecycleHookRequest.builder()
- Parameters:
putLifecycleHookRequest
- AConsumer
that will call methods onPutLifecycleHookRequest.Builder
to create a request.- Returns:
- Result of the PutLifecycleHook operation returned by the service.
- See Also:
-
-
putNotificationConfiguration
default PutNotificationConfigurationResponse putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest) throws LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException 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.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
- Parameters:
putNotificationConfigurationRequest
-- Returns:
- Result of the PutNotificationConfiguration operation returned by the service.
- See Also:
-
putNotificationConfiguration
default PutNotificationConfigurationResponse putNotificationConfiguration(Consumer<PutNotificationConfigurationRequest.Builder> putNotificationConfigurationRequest) throws LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException 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.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
This is a convenience which creates an instance of the
PutNotificationConfigurationRequest.Builder
avoiding the need to create one manually viaPutNotificationConfigurationRequest.builder()
- Parameters:
putNotificationConfigurationRequest
- AConsumer
that will call methods onPutNotificationConfigurationRequest.Builder
to create a request.- Returns:
- Result of the PutNotificationConfiguration operation returned by the service.
- See Also:
-
putScalingPolicy
default PutScalingPolicyResponse putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest) throws LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
- Parameters:
putScalingPolicyRequest
-- Returns:
- Result of the PutScalingPolicy operation returned by the service.
- See Also:
-
putScalingPolicy
default PutScalingPolicyResponse putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest) throws LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
This is a convenience which creates an instance of the
PutScalingPolicyRequest.Builder
avoiding the need to create one manually viaPutScalingPolicyRequest.builder()
- Parameters:
putScalingPolicyRequest
- AConsumer
that will call methods onPutScalingPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutScalingPolicy operation returned by the service.
- See Also:
-
putScheduledUpdateGroupAction
default PutScheduledUpdateGroupActionResponse putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates a scheduled scaling action for an Auto Scaling group.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
- Parameters:
putScheduledUpdateGroupActionRequest
-- Returns:
- Result of the PutScheduledUpdateGroupAction operation returned by the service.
- See Also:
-
putScheduledUpdateGroupAction
default PutScheduledUpdateGroupActionResponse putScheduledUpdateGroupAction(Consumer<PutScheduledUpdateGroupActionRequest.Builder> putScheduledUpdateGroupActionRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates a scheduled scaling action for an Auto Scaling group.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
This is a convenience which creates an instance of the
PutScheduledUpdateGroupActionRequest.Builder
avoiding the need to create one manually viaPutScheduledUpdateGroupActionRequest.builder()
- Parameters:
putScheduledUpdateGroupActionRequest
- AConsumer
that will call methods onPutScheduledUpdateGroupActionRequest.Builder
to create a request.- Returns:
- Result of the PutScheduledUpdateGroupAction operation returned by the service.
- See Also:
-
putWarmPool
default PutWarmPoolResponse putWarmPool(PutWarmPoolRequest putWarmPoolRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
- Parameters:
putWarmPoolRequest
-- Returns:
- Result of the PutWarmPool operation returned by the service.
- See Also:
-
putWarmPool
default PutWarmPoolResponse putWarmPool(Consumer<PutWarmPoolRequest.Builder> putWarmPoolRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
This is a convenience which creates an instance of the
PutWarmPoolRequest.Builder
avoiding the need to create one manually viaPutWarmPoolRequest.builder()
- Parameters:
putWarmPoolRequest
- AConsumer
that will call methods onPutWarmPoolRequest.Builder
to create a request.- Returns:
- Result of the PutWarmPool operation returned by the service.
- See Also:
-
recordLifecycleActionHeartbeat
default RecordLifecycleActionHeartbeatResponse recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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 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 launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(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 wait state.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
recordLifecycleActionHeartbeatRequest
-- Returns:
- Result of the RecordLifecycleActionHeartbeat operation returned by the service.
- See Also:
-
-
recordLifecycleActionHeartbeat
default RecordLifecycleActionHeartbeatResponse recordLifecycleActionHeartbeat(Consumer<RecordLifecycleActionHeartbeatRequest.Builder> recordLifecycleActionHeartbeatRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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 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 launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(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 wait state.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
RecordLifecycleActionHeartbeatRequest.Builder
avoiding the need to create one manually viaRecordLifecycleActionHeartbeatRequest.builder()
- Parameters:
recordLifecycleActionHeartbeatRequest
- AConsumer
that will call methods onRecordLifecycleActionHeartbeatRequest.Builder
to create a request.- Returns:
- Result of the RecordLifecycleActionHeartbeat operation returned by the service.
- See Also:
-
-
resumeProcesses
default ResumeProcessesResponse resumeProcesses(ResumeProcessesRequest resumeProcessesRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Resumes 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.
- Parameters:
resumeProcessesRequest
-- Returns:
- Result of the ResumeProcesses operation returned by the service.
- See Also:
-
resumeProcesses
default ResumeProcessesResponse resumeProcesses(Consumer<ResumeProcessesRequest.Builder> resumeProcessesRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Resumes 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.
This is a convenience which creates an instance of the
ResumeProcessesRequest.Builder
avoiding the need to create one manually viaResumeProcessesRequest.builder()
- Parameters:
resumeProcessesRequest
- AConsumer
that will call methods onResumeProcessesRequest.Builder
to create a request.- Returns:
- Result of the ResumeProcesses operation returned by the service.
- See Also:
-
rollbackInstanceRefresh
default RollbackInstanceRefreshResponse rollbackInstanceRefresh(RollbackInstanceRefreshRequest rollbackInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, IrreversibleInstanceRefreshException, AwsServiceException, SdkClientException, AutoScalingException Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
-
There is no desired configuration specified for the instance refresh.
-
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the
ImageId
property. -
The Auto Scaling group uses the launch template's
invalid input: '$'Latest
orinvalid input: '$'Default
version.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
- Parameters:
rollbackInstanceRefreshRequest
-- Returns:
- Result of the RollbackInstanceRefresh operation returned by the service.
- See Also:
-
-
rollbackInstanceRefresh
default RollbackInstanceRefreshResponse rollbackInstanceRefresh(Consumer<RollbackInstanceRefreshRequest.Builder> rollbackInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, IrreversibleInstanceRefreshException, AwsServiceException, SdkClientException, AutoScalingException Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
-
There is no desired configuration specified for the instance refresh.
-
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the
ImageId
property. -
The Auto Scaling group uses the launch template's
invalid input: '$'Latest
orinvalid input: '$'Default
version.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
This is a convenience which creates an instance of the
RollbackInstanceRefreshRequest.Builder
avoiding the need to create one manually viaRollbackInstanceRefreshRequest.builder()
- Parameters:
rollbackInstanceRefreshRequest
- AConsumer
that will call methods onRollbackInstanceRefreshRequest.Builder
to create a request.- Returns:
- Result of the RollbackInstanceRefresh operation returned by the service.
- See Also:
-
-
setDesiredCapacity
default SetDesiredCapacityResponse setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Sets 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.
- Parameters:
setDesiredCapacityRequest
-- Returns:
- Result of the SetDesiredCapacity operation returned by the service.
- See Also:
-
setDesiredCapacity
default SetDesiredCapacityResponse setDesiredCapacity(Consumer<SetDesiredCapacityRequest.Builder> setDesiredCapacityRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Sets 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.
This is a convenience which creates an instance of the
SetDesiredCapacityRequest.Builder
avoiding the need to create one manually viaSetDesiredCapacityRequest.builder()
- Parameters:
setDesiredCapacityRequest
- AConsumer
that will call methods onSetDesiredCapacityRequest.Builder
to create a request.- Returns:
- Result of the SetDesiredCapacity operation returned by the service.
- See Also:
-
setInstanceHealth
default SetInstanceHealthResponse setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
- Parameters:
setInstanceHealthRequest
-- Returns:
- Result of the SetInstanceHealth operation returned by the service.
- See Also:
-
setInstanceHealth
default SetInstanceHealthResponse setInstanceHealth(Consumer<SetInstanceHealthRequest.Builder> setInstanceHealthRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException 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.
This is a convenience which creates an instance of the
SetInstanceHealthRequest.Builder
avoiding the need to create one manually viaSetInstanceHealthRequest.builder()
- Parameters:
setInstanceHealthRequest
- AConsumer
that will call methods onSetInstanceHealthRequest.Builder
to create a request.- Returns:
- Result of the SetInstanceHealth operation returned by the service.
- See Also:
-
setInstanceProtection
default SetInstanceProtectionResponse setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using 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.
- Parameters:
setInstanceProtectionRequest
-- Returns:
- Result of the SetInstanceProtection operation returned by the service.
- See Also:
-
setInstanceProtection
default SetInstanceProtectionResponse setInstanceProtection(Consumer<SetInstanceProtectionRequest.Builder> setInstanceProtectionRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using 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.
This is a convenience which creates an instance of the
SetInstanceProtectionRequest.Builder
avoiding the need to create one manually viaSetInstanceProtectionRequest.builder()
- Parameters:
setInstanceProtectionRequest
- AConsumer
that will call methods onSetInstanceProtectionRequest.Builder
to create a request.- Returns:
- Result of the SetInstanceProtection operation returned by the service.
- See Also:
-
startInstanceRefresh
default StartInstanceRefreshResponse startInstanceRefresh(StartInstanceRefreshRequest startInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, InstanceRefreshInProgressException, AwsServiceException, SdkClientException, AutoScalingException Starts an instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. 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 that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in
Standby
state or protected from scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API.If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the
AutoRollback
property in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.- Parameters:
startInstanceRefreshRequest
-- Returns:
- Result of the StartInstanceRefresh operation returned by the service.
- See Also:
-
startInstanceRefresh
default StartInstanceRefreshResponse startInstanceRefresh(Consumer<StartInstanceRefreshRequest.Builder> startInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, InstanceRefreshInProgressException, AwsServiceException, SdkClientException, AutoScalingException Starts an instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. 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 that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in
Standby
state or protected from scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API.If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the
AutoRollback
property in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.
This is a convenience which creates an instance of the
StartInstanceRefreshRequest.Builder
avoiding the need to create one manually viaStartInstanceRefreshRequest.builder()
- Parameters:
startInstanceRefreshRequest
- AConsumer
that will call methods onStartInstanceRefreshRequest.Builder
to create a request.- Returns:
- Result of the StartInstanceRefresh operation returned by the service.
- See Also:
-
suspendProcesses
default SuspendProcessesResponse suspendProcesses(SuspendProcessesRequest suspendProcessesRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the
Launch
orTerminate
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.
- Parameters:
suspendProcessesRequest
-- Returns:
- Result of the SuspendProcesses operation returned by the service.
- See Also:
-
suspendProcesses
default SuspendProcessesResponse suspendProcesses(Consumer<SuspendProcessesRequest.Builder> suspendProcessesRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the
Launch
orTerminate
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.
This is a convenience which creates an instance of the
SuspendProcessesRequest.Builder
avoiding the need to create one manually viaSuspendProcessesRequest.builder()
- Parameters:
suspendProcessesRequest
- AConsumer
that will call methods onSuspendProcessesRequest.Builder
to create a request.- Returns:
- Result of the SuspendProcesses operation returned by the service.
- See Also:
-
terminateInstanceInAutoScalingGroup
default TerminateInstanceInAutoScalingGroupResponse terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
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.
- Parameters:
terminateInstanceInAutoScalingGroupRequest
-- Returns:
- Result of the TerminateInstanceInAutoScalingGroup operation returned by the service.
- See Also:
-
terminateInstanceInAutoScalingGroup
default TerminateInstanceInAutoScalingGroupResponse terminateInstanceInAutoScalingGroup(Consumer<TerminateInstanceInAutoScalingGroupRequest.Builder> terminateInstanceInAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
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.
This is a convenience which creates an instance of the
TerminateInstanceInAutoScalingGroupRequest.Builder
avoiding the need to create one manually viaTerminateInstanceInAutoScalingGroupRequest.builder()
- Parameters:
terminateInstanceInAutoScalingGroupRequest
- AConsumer
that will call methods onTerminateInstanceInAutoScalingGroupRequest.Builder
to create a request.- Returns:
- Result of the TerminateInstanceInAutoScalingGroup operation returned by the service.
- See Also:
-
updateAutoScalingGroup
default UpdateAutoScalingGroupResponse updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException We 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 property that you want to change. Any properties 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
, orMinSize
:-
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 forDesiredCapacity
, and the newMinSize
is larger than the current size of the group, this sets the group'sDesiredCapacity
to the newMinSize
value. -
If you specify a new value for
MaxSize
without specifying a value forDesiredCapacity
, and the newMaxSize
is smaller than the current size of the group, this sets the group'sDesiredCapacity
to the newMaxSize
value.
To see which properties 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.
- Parameters:
updateAutoScalingGroupRequest
-- Returns:
- Result of the UpdateAutoScalingGroup operation returned by the service.
- See Also:
-
-
updateAutoScalingGroup
default UpdateAutoScalingGroupResponse updateAutoScalingGroup(Consumer<UpdateAutoScalingGroupRequest.Builder> updateAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException We 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 property that you want to change. Any properties 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
, orMinSize
:-
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 forDesiredCapacity
, and the newMinSize
is larger than the current size of the group, this sets the group'sDesiredCapacity
to the newMinSize
value. -
If you specify a new value for
MaxSize
without specifying a value forDesiredCapacity
, and the newMaxSize
is smaller than the current size of the group, this sets the group'sDesiredCapacity
to the newMaxSize
value.
To see which properties 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.
This is a convenience which creates an instance of the
UpdateAutoScalingGroupRequest.Builder
avoiding the need to create one manually viaUpdateAutoScalingGroupRequest.builder()
- Parameters:
updateAutoScalingGroupRequest
- AConsumer
that will call methods onUpdateAutoScalingGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateAutoScalingGroup operation returned by the service.
- See Also:
-
-
waiter
Create an instance ofAutoScalingWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
AutoScalingWaiter
-
create
Create aAutoScalingClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAutoScalingClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-