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.PutScheduledUpdateGroupAction

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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

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

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

Synopsis

Creating a Request

data PutScheduledUpdateGroupAction Source #

See: newPutScheduledUpdateGroupAction smart constructor.

Constructors

PutScheduledUpdateGroupAction'

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. 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.
endTime :: Maybe ISO8601
The date and time for the recurring schedule to end, in UTC. For example, "2021-06-01T00:00:00Z".
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 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.
startTime :: Maybe ISO8601
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.
time :: Maybe ISO8601
This property is no longer used.
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.
autoScalingGroupName :: Text
The name of the Auto Scaling group.
scheduledActionName :: Text
The name of this scaling action.

Instances

Instances details

ToHeaders PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods toHeaders :: PutScheduledUpdateGroupAction -> [Header] #
ToPath PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods toPath :: PutScheduledUpdateGroupAction -> ByteString #
ToQuery PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods toQuery :: PutScheduledUpdateGroupAction -> QueryString #
AWSRequest PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Associated Types type AWSResponse PutScheduledUpdateGroupAction # Methods request :: (Service -> Service) -> PutScheduledUpdateGroupAction -> Request PutScheduledUpdateGroupAction # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutScheduledUpdateGroupAction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutScheduledUpdateGroupAction))) #
Generic PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Associated Types type Rep PutScheduledUpdateGroupAction :: Type -> Type # Methods from :: PutScheduledUpdateGroupAction -> Rep PutScheduledUpdateGroupAction x # to :: Rep PutScheduledUpdateGroupAction x -> PutScheduledUpdateGroupAction #
Read PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods readsPrec :: Int -> ReadS PutScheduledUpdateGroupAction # readList :: ReadS [PutScheduledUpdateGroupAction] # readPrec :: ReadPrec PutScheduledUpdateGroupAction # readListPrec :: ReadPrec [PutScheduledUpdateGroupAction] #
Show PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods showsPrec :: Int -> PutScheduledUpdateGroupAction -> ShowS # show :: PutScheduledUpdateGroupAction -> String # showList :: [PutScheduledUpdateGroupAction] -> ShowS #
NFData PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods rnf :: PutScheduledUpdateGroupAction -> () #
Eq PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods (==) :: PutScheduledUpdateGroupAction -> PutScheduledUpdateGroupAction -> Bool # (/=) :: PutScheduledUpdateGroupAction -> PutScheduledUpdateGroupAction -> Bool #
Hashable PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods hashWithSalt :: Int -> PutScheduledUpdateGroupAction -> Int # hash :: PutScheduledUpdateGroupAction -> Int #
type AWSResponse PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction type AWSResponse PutScheduledUpdateGroupAction = PutScheduledUpdateGroupActionResponse
type Rep PutScheduledUpdateGroupAction Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction type Rep PutScheduledUpdateGroupAction = D1 ('MetaData "PutScheduledUpdateGroupAction" "Amazonka.AutoScaling.PutScheduledUpdateGroupAction" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "PutScheduledUpdateGroupAction'" '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 "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "timeZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "scheduledActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newPutScheduledUpdateGroupAction Source #

Arguments

:: Text	`PutScheduledUpdateGroupAction`
-> Text	`PutScheduledUpdateGroupAction`
-> PutScheduledUpdateGroupAction

Create a value of PutScheduledUpdateGroupAction 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:

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_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.

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_endTime - The date and time for the recurring schedule to end, in UTC. For example, "2021-06-01T00:00:00Z".

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_maxSize - The maximum size of the Auto Scaling group.

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_minSize - The minimum size of the Auto Scaling group.

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_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.

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_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.

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_time - This property is no longer used.

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_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.

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_autoScalingGroupName - The name of the Auto Scaling group.

PutScheduledUpdateGroupAction, putScheduledUpdateGroupAction_scheduledActionName - The name of this scaling action.

Request Lenses

putScheduledUpdateGroupAction_desiredCapacity :: Lens' PutScheduledUpdateGroupAction (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. 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.

putScheduledUpdateGroupAction_endTime :: Lens' PutScheduledUpdateGroupAction (Maybe UTCTime) Source #

The date and time for the recurring schedule to end, in UTC. For example, "2021-06-01T00:00:00Z".

putScheduledUpdateGroupAction_maxSize :: Lens' PutScheduledUpdateGroupAction (Maybe Int) Source #

The maximum size of the Auto Scaling group.

putScheduledUpdateGroupAction_minSize :: Lens' PutScheduledUpdateGroupAction (Maybe Int) Source #

The minimum size of the Auto Scaling group.

putScheduledUpdateGroupAction_recurrence :: Lens' PutScheduledUpdateGroupAction (Maybe Text) Source #

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.

putScheduledUpdateGroupAction_startTime :: Lens' PutScheduledUpdateGroupAction (Maybe UTCTime) Source #

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.

putScheduledUpdateGroupAction_time :: Lens' PutScheduledUpdateGroupAction (Maybe UTCTime) Source #

This property is no longer used.

putScheduledUpdateGroupAction_timeZone :: Lens' PutScheduledUpdateGroupAction (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.

putScheduledUpdateGroupAction_autoScalingGroupName :: Lens' PutScheduledUpdateGroupAction Text Source #

The name of the Auto Scaling group.

putScheduledUpdateGroupAction_scheduledActionName :: Lens' PutScheduledUpdateGroupAction Text Source #

The name of this scaling action.

Destructuring the Response

data PutScheduledUpdateGroupActionResponse Source #

See: newPutScheduledUpdateGroupActionResponse smart constructor.

Constructors

PutScheduledUpdateGroupActionResponse'

Instances

Instances details

Generic PutScheduledUpdateGroupActionResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Associated Types type Rep PutScheduledUpdateGroupActionResponse :: Type -> Type # Methods from :: PutScheduledUpdateGroupActionResponse -> Rep PutScheduledUpdateGroupActionResponse x # to :: Rep PutScheduledUpdateGroupActionResponse x -> PutScheduledUpdateGroupActionResponse #
Read PutScheduledUpdateGroupActionResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods readsPrec :: Int -> ReadS PutScheduledUpdateGroupActionResponse # readList :: ReadS [PutScheduledUpdateGroupActionResponse] # readPrec :: ReadPrec PutScheduledUpdateGroupActionResponse # readListPrec :: ReadPrec [PutScheduledUpdateGroupActionResponse] #
Show PutScheduledUpdateGroupActionResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods showsPrec :: Int -> PutScheduledUpdateGroupActionResponse -> ShowS # show :: PutScheduledUpdateGroupActionResponse -> String # showList :: [PutScheduledUpdateGroupActionResponse] -> ShowS #
NFData PutScheduledUpdateGroupActionResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods rnf :: PutScheduledUpdateGroupActionResponse -> () #
Eq PutScheduledUpdateGroupActionResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction Methods (==) :: PutScheduledUpdateGroupActionResponse -> PutScheduledUpdateGroupActionResponse -> Bool # (/=) :: PutScheduledUpdateGroupActionResponse -> PutScheduledUpdateGroupActionResponse -> Bool #
type Rep PutScheduledUpdateGroupActionResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutScheduledUpdateGroupAction type Rep PutScheduledUpdateGroupActionResponse = D1 ('MetaData "PutScheduledUpdateGroupActionResponse" "Amazonka.AutoScaling.PutScheduledUpdateGroupAction" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "PutScheduledUpdateGroupActionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutScheduledUpdateGroupActionResponse :: PutScheduledUpdateGroupActionResponse Source #

Create a value of PutScheduledUpdateGroupActionResponse with all optional fields omitted.

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