Client

autoscaling

R Documentation

Auto Scaling¶

Description¶

Amazon EC2 Auto Scaling

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.

Usage¶

autoscaling(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

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

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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¶

svc <- autoscaling(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

attach_instances: Attaches one or more EC2 instances to the specified Auto Scaling group
attach_load_balancers: This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types
attach_load_balancer_target_groups: This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types
attach_traffic_sources: Attaches one or more traffic sources to the specified Auto Scaling group
batch_delete_scheduled_action: Deletes one or more scheduled actions for the specified Auto Scaling group; Creates or updates one or more scheduled scaling actions for an Auto Scaling group
cancel_instance_refresh: Cancels an instance refresh or rollback that is 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
delete_warm_pool: Deletes the warm pool for the specified Auto Scaling group
describe_account_limits: Describes the current Amazon EC2 Auto Scaling resource quotas for your account
describe_adjustment_types: Describes the available adjustment types for step scaling and simple scaling policies
describe_auto_scaling_groups: Gets information about the Auto Scaling groups in the account and Region
describe_auto_scaling_instances: Gets information about the Auto Scaling instances in the account and Region; Describes the notification types that are supported by Amazon EC2 Auto Scaling
describe_instance_refreshes: Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks
describe_launch_configurations: Gets information about the launch configurations in the account and Region
describe_lifecycle_hooks: Gets information about the lifecycle hooks for the specified Auto Scaling group
describe_lifecycle_hook_types: Describes the available types of lifecycle hooks
describe_load_balancers: This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types
describe_load_balancer_target_groups: This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types
describe_metric_collection_types: Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling
describe_notification_configurations: Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups
describe_policies: Gets information about the scaling policies in the account and Region
describe_scaling_activities: Gets information about the scaling activities in the account and Region
describe_scaling_process_types: Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs
describe_scheduled_actions: Gets information about the scheduled actions 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
describe_traffic_sources: Gets information about the traffic sources for the specified Auto Scaling group
describe_warm_pool: Gets information about a warm pool and its instances
detach_instances: Removes one or more instances from the specified Auto Scaling group
detach_load_balancers: This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types
detach_load_balancer_target_groups: This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types
detach_traffic_sources: Detaches one or more traffic sources from the specified Auto Scaling group
disable_metrics_collection: Disables group metrics collection for the specified Auto Scaling group
enable_metrics_collection: Enables group metrics collection 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
get_predictive_scaling_forecast: Retrieves the forecast data for a predictive scaling policy
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
put_warm_pool: Creates or updates a warm pool for the specified 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
rollback_instance_refresh: Cancels an instance refresh that is in progress and rolls back any changes that it made
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 an instance refresh
suspend_processes: Suspends the specified auto scaling processes, or all processes, for the specified 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¶

## 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)