paws.management: autoscaling_put_scheduled_update_group_action – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

autoscaling_put_scheduled_update_group_action

Creates or updates a scheduled scaling action for an Auto Scaling group

Description

Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.

Usage

autoscaling_put_scheduled_update_group_action(AutoScalingGroupName,
  ScheduledActionName, Time, StartTime, EndTime, Recurrence, MinSize,
  MaxSize, DesiredCapacity)

Arguments

`AutoScalingGroupName`	[required] The name of the Auto Scaling group.
`ScheduledActionName`	[required] The name of this scaling action.
`Time`	This parameter is no longer used.
`StartTime`	The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, `"2019-06-01T00:00:00Z"`). If you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence. If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
`EndTime`	The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
`Recurrence`	The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, `"30 0 1 1,6,12 *"`). For more information about this format, see Crontab. When `StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops.
`MinSize`	The minimum size of the Auto Scaling group.
`MaxSize`	The maximum size of the Auto Scaling group.
`DesiredCapacity`	The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.

Value

An empty list.

Request syntax

svc$put_scheduled_update_group_action(
  AutoScalingGroupName = "string",
  ScheduledActionName = "string",
  Time = as.POSIXct(
    "2015-01-01"
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Recurrence = "string",
  MinSize = 123,
  MaxSize = 123,
  DesiredCapacity = 123
)

Examples

## Not run: 
# This example adds the specified scheduled action to the specified Auto
# Scaling group.
svc$put_scheduled_update_group_action(
  AutoScalingGroupName = "my-auto-scaling-group",
  DesiredCapacity = 4L,
  EndTime = "2014-05-12T08:00:00Z",
  MaxSize = 6L,
  MinSize = 2L,
  ScheduledActionName = "my-scheduled-action",
  StartTime = "2014-05-12T08:00:00Z"
)

## End(Not run)

paws.management

Amazon Web Services Management & Governance Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release