amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.CreateInstanceEventWindow

Description

Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.

You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.

You can create up to 200 event windows per Amazon Web Services Region.

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.

Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.

Event windows are not applicable for:

  • Expedited scheduled events and network maintenance events.
  • Unscheduled maintenance such as AutoRecovery and unplanned reboots.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

Synopsis

Creating a Request

data CreateInstanceEventWindow Source #

See: newCreateInstanceEventWindow smart constructor.

Constructors

CreateInstanceEventWindow' 

Fields

  • cronExpression :: Maybe Text

    The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.

    Constraints:

    • Only hour and day of the week values are supported.
    • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
    • The minute, month, and year must be specified by *.
    • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
    • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
    • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

    For more information about cron expressions, see cron on the Wikipedia website.

  • dryRun :: Maybe Bool

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • name :: Maybe Text

    The name of the event window.

  • tagSpecifications :: Maybe [TagSpecification]

    The tags to apply to the event window.

  • timeRanges :: Maybe [InstanceEventWindowTimeRangeRequest]

    The time range for the event window. If you specify a time range, you can't specify a cron expression.

Instances

Instances details
ToHeaders CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

toHeaders :: CreateInstanceEventWindow -> [Header] #

ToPath CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

toPath :: CreateInstanceEventWindow -> ByteString #

ToQuery CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

toQuery :: CreateInstanceEventWindow -> QueryString #

AWSRequest CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Associated Types

type AWSResponse CreateInstanceEventWindow #

Methods

request :: (Service -> Service) -> CreateInstanceEventWindow -> Request CreateInstanceEventWindow #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateInstanceEventWindow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateInstanceEventWindow))) #

Generic CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Associated Types

type Rep CreateInstanceEventWindow :: Type -> Type #

Methods

from :: CreateInstanceEventWindow -> Rep CreateInstanceEventWindow x #

to :: Rep CreateInstanceEventWindow x -> CreateInstanceEventWindow #

Read CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

readsPrec :: Int -> ReadS CreateInstanceEventWindow #

readList :: ReadS [CreateInstanceEventWindow] #

readPrec :: ReadPrec CreateInstanceEventWindow #

readListPrec :: ReadPrec [CreateInstanceEventWindow] #

Show CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

showsPrec :: Int -> CreateInstanceEventWindow -> ShowS #

show :: CreateInstanceEventWindow -> String #

showList :: [CreateInstanceEventWindow] -> ShowS #

NFData CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

rnf :: CreateInstanceEventWindow -> () #

Eq CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

(==) :: CreateInstanceEventWindow -> CreateInstanceEventWindow -> Bool #

(/=) :: CreateInstanceEventWindow -> CreateInstanceEventWindow -> Bool #

Hashable CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

hashWithSalt :: Int -> CreateInstanceEventWindow -> Int #

hash :: CreateInstanceEventWindow -> Int #

type AWSResponse CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

type AWSResponse CreateInstanceEventWindow = CreateInstanceEventWindowResponse
type Rep CreateInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

type Rep CreateInstanceEventWindow = D1 ('MetaData "CreateInstanceEventWindow" "Amazonka.EC2.CreateInstanceEventWindow" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateInstanceEventWindow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cronExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])) :*: S1 ('MetaSel ('Just "timeRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceEventWindowTimeRangeRequest]))))))

newCreateInstanceEventWindow :: CreateInstanceEventWindow Source #

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

CreateInstanceEventWindow, createInstanceEventWindow_cronExpression - The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.

Constraints:

  • Only hour and day of the week values are supported.
  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
  • The minute, month, and year must be specified by *.
  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

$sel:dryRun:CreateInstanceEventWindow', createInstanceEventWindow_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

CreateInstanceEventWindow, createInstanceEventWindow_name - The name of the event window.

CreateInstanceEventWindow, createInstanceEventWindow_tagSpecifications - The tags to apply to the event window.

CreateInstanceEventWindow, createInstanceEventWindow_timeRanges - The time range for the event window. If you specify a time range, you can't specify a cron expression.

Request Lenses

createInstanceEventWindow_cronExpression :: Lens' CreateInstanceEventWindow (Maybe Text) Source #

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.

Constraints:

  • Only hour and day of the week values are supported.
  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
  • The minute, month, and year must be specified by *.
  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

createInstanceEventWindow_dryRun :: Lens' CreateInstanceEventWindow (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

createInstanceEventWindow_name :: Lens' CreateInstanceEventWindow (Maybe Text) Source #

The name of the event window.

createInstanceEventWindow_tagSpecifications :: Lens' CreateInstanceEventWindow (Maybe [TagSpecification]) Source #

The tags to apply to the event window.

createInstanceEventWindow_timeRanges :: Lens' CreateInstanceEventWindow (Maybe [InstanceEventWindowTimeRangeRequest]) Source #

The time range for the event window. If you specify a time range, you can't specify a cron expression.

Destructuring the Response

data CreateInstanceEventWindowResponse Source #

See: newCreateInstanceEventWindowResponse smart constructor.

Constructors

CreateInstanceEventWindowResponse' 

Fields

Instances

Instances details
Generic CreateInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Associated Types

type Rep CreateInstanceEventWindowResponse :: Type -> Type #

Methods

from :: CreateInstanceEventWindowResponse -> Rep CreateInstanceEventWindowResponse x #

to :: Rep CreateInstanceEventWindowResponse x -> CreateInstanceEventWindowResponse #

Read CreateInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

readsPrec :: Int -> ReadS CreateInstanceEventWindowResponse #

readList :: ReadS [CreateInstanceEventWindowResponse] #

readPrec :: ReadPrec CreateInstanceEventWindowResponse #

readListPrec :: ReadPrec [CreateInstanceEventWindowResponse] #

Show CreateInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

showsPrec :: Int -> CreateInstanceEventWindowResponse -> ShowS #

show :: CreateInstanceEventWindowResponse -> String #

showList :: [CreateInstanceEventWindowResponse] -> ShowS #

NFData CreateInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

rnf :: CreateInstanceEventWindowResponse -> () #

Eq CreateInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

Methods

(==) :: CreateInstanceEventWindowResponse -> CreateInstanceEventWindowResponse -> Bool #

(/=) :: CreateInstanceEventWindowResponse -> CreateInstanceEventWindowResponse -> Bool #

type Rep CreateInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateInstanceEventWindow

type Rep CreateInstanceEventWindowResponse = D1 ('MetaData "CreateInstanceEventWindowResponse" "Amazonka.EC2.CreateInstanceEventWindow" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateInstanceEventWindowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceEventWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceEventWindow)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateInstanceEventWindowResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateInstanceEventWindowResponse'

-> CreateInstanceEventWindowResponse 

Create a value of CreateInstanceEventWindowResponse 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:instanceEventWindow:CreateInstanceEventWindowResponse', createInstanceEventWindowResponse_instanceEventWindow - Information about the event window.

$sel:httpStatus:CreateInstanceEventWindowResponse', createInstanceEventWindowResponse_httpStatus - The response's http status code.

Response Lenses

createInstanceEventWindowResponse_instanceEventWindow :: Lens' CreateInstanceEventWindowResponse (Maybe InstanceEventWindow) Source #

Information about the event window.

createInstanceEventWindowResponse_httpStatus :: Lens' CreateInstanceEventWindowResponse Int Source #

The response's http status code.