Learn R Programming

paws (version 0.1.12)

autoscaling: Auto Scaling

Description

Amazon EC2 Auto Scaling

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.

For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.

Usage

autoscaling(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- autoscaling(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

attach_instancesAttaches one or more EC2 instances to the specified Auto Scaling group
attach_load_balancersTo attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead
attach_load_balancer_target_groupsAttaches one or more target groups to the specified Auto Scaling group
batch_delete_scheduled_actionDeletes one or more scheduled actions for the specified Auto Scaling group
batch_put_scheduled_update_group_actionCreates or updates one or more scheduled scaling actions for an Auto Scaling group
cancel_instance_refreshCancels an instance refresh operation in progress
complete_lifecycle_actionCompletes the lifecycle action for the specified token or instance with the specified result
create_auto_scaling_groupWe strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2
create_launch_configurationCreates a launch configuration
create_or_update_tagsCreates or updates tags for the specified Auto Scaling group
delete_auto_scaling_groupDeletes the specified Auto Scaling group
delete_launch_configurationDeletes the specified launch configuration
delete_lifecycle_hookDeletes the specified lifecycle hook
delete_notification_configurationDeletes the specified notification
delete_policyDeletes the specified scaling policy
delete_scheduled_actionDeletes the specified scheduled action
delete_tagsDeletes the specified tags
describe_account_limitsDescribes the current Amazon EC2 Auto Scaling resource quotas for your AWS account
describe_adjustment_typesDescribes the available adjustment types for Amazon EC2 Auto Scaling scaling policies
describe_auto_scaling_groupsDescribes one or more Auto Scaling groups
describe_auto_scaling_instancesDescribes one or more Auto Scaling instances
describe_auto_scaling_notification_typesDescribes the notification types that are supported by Amazon EC2 Auto Scaling
describe_instance_refreshesDescribes one or more instance refreshes
describe_launch_configurationsDescribes one or more launch configurations
describe_lifecycle_hooksDescribes the lifecycle hooks for the specified Auto Scaling group
describe_lifecycle_hook_typesDescribes the available types of lifecycle hooks
describe_load_balancersDescribes the load balancers for the specified Auto Scaling group
describe_load_balancer_target_groupsDescribes the target groups for the specified Auto Scaling group
describe_metric_collection_typesDescribes the available CloudWatch metrics for Amazon EC2 Auto Scaling
describe_notification_configurationsDescribes the notification actions associated with the specified Auto Scaling group
describe_policiesDescribes the policies for the specified Auto Scaling group
describe_scaling_activitiesDescribes one or more scaling activities for the specified Auto Scaling group
describe_scaling_process_typesDescribes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs
describe_scheduled_actionsDescribes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time
describe_tagsDescribes the specified tags
describe_termination_policy_typesDescribes the termination policies supported by Amazon EC2 Auto Scaling
detach_instancesRemoves one or more instances from the specified Auto Scaling group
detach_load_balancersDetaches one or more Classic Load Balancers from the specified Auto Scaling group
detach_load_balancer_target_groupsDetaches one or more target groups from the specified Auto Scaling group
disable_metrics_collectionDisables group metrics for the specified Auto Scaling group
enable_metrics_collectionEnables group metrics for the specified Auto Scaling group
enter_standbyMoves the specified instances into the standby state
execute_policyExecutes the specified policy
exit_standbyMoves the specified instances out of the standby state
put_lifecycle_hookCreates or updates a lifecycle hook for the specified Auto Scaling group
put_notification_configurationConfigures an Auto Scaling group to send notifications when specified events take place
put_scaling_policyCreates or updates a scaling policy for an Auto Scaling group
put_scheduled_update_group_actionCreates or updates a scheduled scaling action for an Auto Scaling group
record_lifecycle_action_heartbeatRecords a heartbeat for the lifecycle action associated with the specified token or instance
resume_processesResumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group
set_desired_capacitySets the size of the specified Auto Scaling group
set_instance_healthSets the health status of the specified instance
set_instance_protectionUpdates the instance protection settings of the specified instances
start_instance_refreshStarts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances
suspend_processesSuspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group
terminate_instance_in_auto_scaling_groupTerminates the specified instance and optionally adjusts the desired group size
update_auto_scaling_groupWe strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2

Examples

Run this code
if (FALSE) {
svc <- autoscaling()
# This example attaches the specified instance to the specified Auto
# Scaling group.
svc$attach_instances(
  AutoScalingGroupName = "my-auto-scaling-group",
  InstanceIds = list(
    "i-93633f9b"
  )
)
}

Run the code above in your browser using DataLab