autoscaling: Auto Scaling

Description Usage Arguments Value Service syntax Operations Examples

View source: R/autoscaling_service.R

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

1
autoscaling(config = list())

Arguments

config

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

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.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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_instances Attaches one or more EC2 instances to the specified Auto Scaling group
attach_load_balancers To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead
attach_load_balancer_target_groups Attaches one or more target groups to the specified Auto Scaling group
batch_delete_scheduled_action Deletes one or more scheduled actions for the specified Auto Scaling group
batch_put_scheduled_update_group_action Creates or updates one or more scheduled scaling actions for an Auto Scaling group
cancel_instance_refresh Cancels an instance refresh operation in progress
complete_lifecycle_action Completes the lifecycle action for the specified token or instance with the specified result
create_auto_scaling_group We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2
create_launch_configuration Creates a launch configuration
create_or_update_tags Creates or updates tags for the specified Auto Scaling group
delete_auto_scaling_group Deletes the specified Auto Scaling group
delete_launch_configuration Deletes the specified launch configuration
delete_lifecycle_hook Deletes the specified lifecycle hook
delete_notification_configuration Deletes the specified notification
delete_policy Deletes the specified scaling policy
delete_scheduled_action Deletes the specified scheduled action
delete_tags Deletes the specified tags
describe_account_limits Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account
describe_adjustment_types Describes the available adjustment types for Amazon EC2 Auto Scaling scaling policies
describe_auto_scaling_groups Describes one or more Auto Scaling groups
describe_auto_scaling_instances Describes one or more Auto Scaling instances
describe_auto_scaling_notification_types Describes the notification types that are supported by Amazon EC2 Auto Scaling
describe_instance_refreshes Describes one or more instance refreshes
describe_launch_configurations Describes one or more launch configurations
describe_lifecycle_hooks Describes the lifecycle hooks for the specified Auto Scaling group
describe_lifecycle_hook_types Describes the available types of lifecycle hooks
describe_load_balancers Describes the load balancers for the specified Auto Scaling group
describe_load_balancer_target_groups Describes the target groups for the specified Auto Scaling group
describe_metric_collection_types Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling
describe_notification_configurations Describes the notification actions associated with the specified Auto Scaling group
describe_policies Describes the policies for the specified Auto Scaling group
describe_scaling_activities Describes one or more scaling activities for the specified Auto Scaling group
describe_scaling_process_types Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs
describe_scheduled_actions Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time
describe_tags Describes the specified tags
describe_termination_policy_types Describes the termination policies supported by Amazon EC2 Auto Scaling
detach_instances Removes one or more instances from the specified Auto Scaling group
detach_load_balancers Detaches one or more Classic Load Balancers from the specified Auto Scaling group
detach_load_balancer_target_groups Detaches one or more target groups from the specified Auto Scaling group
disable_metrics_collection Disables group metrics for the specified Auto Scaling group
enable_metrics_collection Enables group metrics for the specified Auto Scaling group
enter_standby Moves the specified instances into the standby state
execute_policy Executes the specified policy
exit_standby Moves the specified instances out of the standby state
put_lifecycle_hook Creates or updates a lifecycle hook for the specified Auto Scaling group
put_notification_configuration Configures an Auto Scaling group to send notifications when specified events take place
put_scaling_policy Creates or updates a scaling policy for an Auto Scaling group
put_scheduled_update_group_action Creates or updates a scheduled scaling action for an Auto Scaling group
record_lifecycle_action_heartbeat Records a heartbeat for the lifecycle action associated with the specified token or instance
resume_processes Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group
set_desired_capacity Sets the size of the specified Auto Scaling group
set_instance_health Sets the health status of the specified instance
set_instance_protection Updates the instance protection settings of the specified instances
start_instance_refresh Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances
suspend_processes Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group
terminate_instance_in_auto_scaling_group Terminates the specified instance and optionally adjusts the desired group size
update_auto_scaling_group We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
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"
  )
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.