Class CfnScheduledAction.Builder

java.lang.Object
software.amazon.awscdk.services.autoscaling.CfnScheduledAction.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnScheduledAction>
Enclosing class:
CfnScheduledAction

@Stability(Stable) public static final class CfnScheduledAction.Builder extends Object implements software.amazon.jsii.Builder<CfnScheduledAction>
A fluent builder for CfnScheduledAction.
  • Method Details

    • create

      @Stability(Stable) public static CfnScheduledAction.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnScheduledAction.Builder.
    • autoScalingGroupName

      @Stability(Stable) public CfnScheduledAction.Builder autoScalingGroupName(String autoScalingGroupName)
      The name of the Auto Scaling group.

      Parameters:
      autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.
      Returns:
      this
    • desiredCapacity

      @Stability(Stable) public CfnScheduledAction.Builder desiredCapacity(Number 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.

      You must specify at least one of the following properties: MaxSize , MinSize , or DesiredCapacity .

      Parameters:
      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. This parameter is required.
      Returns:
      this
    • endTime

      @Stability(Stable) public CfnScheduledAction.Builder endTime(String endTime)
      The date and time for the recurring schedule to end, in UTC.

      For example, "2021-06-01T00:00:00Z" .

      Parameters:
      endTime - The date and time for the recurring schedule to end, in UTC. This parameter is required.
      Returns:
      this
    • maxSize

      @Stability(Stable) public CfnScheduledAction.Builder maxSize(Number maxSize)
      The maximum size of the Auto Scaling group.

      Parameters:
      maxSize - The maximum size of the Auto Scaling group. This parameter is required.
      Returns:
      this
    • minSize

      @Stability(Stable) public CfnScheduledAction.Builder minSize(Number minSize)
      The minimum size of the Auto Scaling group.

      Parameters:
      minSize - The minimum size of the Auto Scaling group. This parameter is required.
      Returns:
      this
    • recurrence

      @Stability(Stable) public CfnScheduledAction.Builder recurrence(String recurrence)
      The recurring schedule for this action.

      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.

      Cron expressions use Universal Coordinated Time (UTC) by default.

      Parameters:
      recurrence - The recurring schedule for this action. This parameter is required.
      Returns:
      this
    • startTime

      @Stability(Stable) public CfnScheduledAction.Builder startTime(String 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, "2021-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.

      Parameters:
      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, "2021-06-01T00:00:00Z" ). This parameter is required.
      Returns:
      this
    • timeZone

      @Stability(Stable) public CfnScheduledAction.Builder timeZone(String timeZone)
      Specifies the time zone for a cron expression.

      If a time zone is not provided, UTC is used by default.

      Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti ). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones .

      Parameters:
      timeZone - Specifies the time zone for a cron expression. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public CfnScheduledAction build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnScheduledAction>
      Returns:
      a newly built instance of CfnScheduledAction.