Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest

Description

Synopsis

Documentation

data ScheduledUpdateGroupActionRequest Source #

Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

See: newScheduledUpdateGroupActionRequest smart constructor.

Constructors

ScheduledUpdateGroupActionRequest'

Fields

desiredCapacity :: Maybe Int
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
endTime :: Maybe ISO8601
The date and time for the recurring schedule to end, in UTC.
maxSize :: Maybe Int
The maximum size of the Auto Scaling group.
minSize :: Maybe Int
The minimum size of the Auto Scaling group.
recurrence :: Maybe Text
The recurring schedule for the 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.
Cron expressions use Universal Coordinated Time (UTC) by default.
startTime :: Maybe ISO8601
The date and time for the 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 the action in the past, Amazon EC2 Auto Scaling returns an error message.
timeZone :: Maybe Text
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.
scheduledActionName :: Text
The name of the scaling action.

Instances

Instances details

ToQuery ScheduledUpdateGroupActionRequest Source #
Instance details Defined in Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest Methods toQuery :: ScheduledUpdateGroupActionRequest -> QueryString #
Generic ScheduledUpdateGroupActionRequest Source #
Instance details Defined in Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest Associated Types type Rep ScheduledUpdateGroupActionRequest :: Type -> Type # Methods from :: ScheduledUpdateGroupActionRequest -> Rep ScheduledUpdateGroupActionRequest x # to :: Rep ScheduledUpdateGroupActionRequest x -> ScheduledUpdateGroupActionRequest #
Read ScheduledUpdateGroupActionRequest Source #
Instance details Defined in Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest Methods readsPrec :: Int -> ReadS ScheduledUpdateGroupActionRequest # readList :: ReadS [ScheduledUpdateGroupActionRequest] # readPrec :: ReadPrec ScheduledUpdateGroupActionRequest # readListPrec :: ReadPrec [ScheduledUpdateGroupActionRequest] #
Show ScheduledUpdateGroupActionRequest Source #
Instance details Defined in Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest Methods showsPrec :: Int -> ScheduledUpdateGroupActionRequest -> ShowS # show :: ScheduledUpdateGroupActionRequest -> String # showList :: [ScheduledUpdateGroupActionRequest] -> ShowS #
NFData ScheduledUpdateGroupActionRequest Source #
Instance details Defined in Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest Methods rnf :: ScheduledUpdateGroupActionRequest -> () #
Eq ScheduledUpdateGroupActionRequest Source #
Instance details Defined in Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest Methods (==) :: ScheduledUpdateGroupActionRequest -> ScheduledUpdateGroupActionRequest -> Bool # (/=) :: ScheduledUpdateGroupActionRequest -> ScheduledUpdateGroupActionRequest -> Bool #
Hashable ScheduledUpdateGroupActionRequest Source #
Instance details Defined in Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest Methods hashWithSalt :: Int -> ScheduledUpdateGroupActionRequest -> Int # hash :: ScheduledUpdateGroupActionRequest -> Int #
type Rep ScheduledUpdateGroupActionRequest Source #
Instance details Defined in Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest type Rep ScheduledUpdateGroupActionRequest = D1 ('MetaData "ScheduledUpdateGroupActionRequest" "Amazonka.AutoScaling.Types.ScheduledUpdateGroupActionRequest" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "ScheduledUpdateGroupActionRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "desiredCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "maxSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "minSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "recurrence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "timeZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scheduledActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newScheduledUpdateGroupActionRequest Source #

Arguments

:: Text	`$sel:scheduledActionName:ScheduledUpdateGroupActionRequest'`
-> ScheduledUpdateGroupActionRequest

Create a value of ScheduledUpdateGroupActionRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:desiredCapacity:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_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.

$sel:endTime:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_endTime - The date and time for the recurring schedule to end, in UTC.

$sel:maxSize:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_maxSize - The maximum size of the Auto Scaling group.

$sel:minSize:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_minSize - The minimum size of the Auto Scaling group.

$sel:recurrence:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_recurrence - The recurring schedule for the 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.

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

$sel:startTime:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_startTime - The date and time for the 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 the action in the past, Amazon EC2 Auto Scaling returns an error message.

$sel:timeZone:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_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.

$sel:scheduledActionName:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_scheduledActionName - The name of the scaling action.

scheduledUpdateGroupActionRequest_desiredCapacity :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int) Source #

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

scheduledUpdateGroupActionRequest_endTime :: Lens' ScheduledUpdateGroupActionRequest (Maybe UTCTime) Source #

The date and time for the recurring schedule to end, in UTC.

scheduledUpdateGroupActionRequest_maxSize :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int) Source #

The maximum size of the Auto Scaling group.

scheduledUpdateGroupActionRequest_minSize :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int) Source #

The minimum size of the Auto Scaling group.

scheduledUpdateGroupActionRequest_recurrence :: Lens' ScheduledUpdateGroupActionRequest (Maybe Text) Source #

The recurring schedule for the 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.

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

scheduledUpdateGroupActionRequest_startTime :: Lens' ScheduledUpdateGroupActionRequest (Maybe UTCTime) Source #

The date and time for the 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 the action in the past, Amazon EC2 Auto Scaling returns an error message.

scheduledUpdateGroupActionRequest_timeZone :: Lens' ScheduledUpdateGroupActionRequest (Maybe Text) Source #

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.

scheduledUpdateGroupActionRequest_scheduledActionName :: Lens' ScheduledUpdateGroupActionRequest Text Source #

The name of the scaling action.