amazonka-ssm-1.6.0: Amazon Simple Systems Manager (SSM) SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SSM.CreateMaintenanceWindow

Contents

Description

Creates a new Maintenance Window.

Synopsis

Creating a Request

createMaintenanceWindow #

Creates a value of CreateMaintenanceWindow with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cmwClientToken - User-provided idempotency token.
  • cmwDescription - An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows.
  • cmwName - The name of the Maintenance Window.
  • cmwSchedule - The schedule of the Maintenance Window in the form of a cron or rate expression.
  • cmwDuration - The duration of the Maintenance Window in hours.
  • cmwCutoff - The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
  • cmwAllowUnassociatedTargets - Enables a Maintenance Window task to execute on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window.

data CreateMaintenanceWindow #

See: createMaintenanceWindow smart constructor.

Instances

Eq CreateMaintenanceWindow # 
Data CreateMaintenanceWindow # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateMaintenanceWindow -> c CreateMaintenanceWindow #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateMaintenanceWindow #

toConstr :: CreateMaintenanceWindow -> Constr #

dataTypeOf :: CreateMaintenanceWindow -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateMaintenanceWindow) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateMaintenanceWindow) #

gmapT :: (forall b. Data b => b -> b) -> CreateMaintenanceWindow -> CreateMaintenanceWindow #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateMaintenanceWindow -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateMaintenanceWindow -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateMaintenanceWindow -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateMaintenanceWindow -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateMaintenanceWindow -> m CreateMaintenanceWindow #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateMaintenanceWindow -> m CreateMaintenanceWindow #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateMaintenanceWindow -> m CreateMaintenanceWindow #

Show CreateMaintenanceWindow # 
Generic CreateMaintenanceWindow # 
Hashable CreateMaintenanceWindow # 
ToJSON CreateMaintenanceWindow # 
NFData CreateMaintenanceWindow # 

Methods

rnf :: CreateMaintenanceWindow -> () #

AWSRequest CreateMaintenanceWindow # 
ToHeaders CreateMaintenanceWindow # 
ToPath CreateMaintenanceWindow # 
ToQuery CreateMaintenanceWindow # 
type Rep CreateMaintenanceWindow # 
type Rep CreateMaintenanceWindow = D1 * (MetaData "CreateMaintenanceWindow" "Network.AWS.SSM.CreateMaintenanceWindow" "amazonka-ssm-1.6.0-3Tt35jiaR0xLZVuK0jt4Pc" False) (C1 * (MetaCons "CreateMaintenanceWindow'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cmwClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cmwDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) (S1 * (MetaSel (Just Symbol "_cmwName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cmwSchedule") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cmwDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cmwCutoff") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat)) (S1 * (MetaSel (Just Symbol "_cmwAllowUnassociatedTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool))))))
type Rs CreateMaintenanceWindow # 

Request Lenses

cmwClientToken :: Lens' CreateMaintenanceWindow (Maybe Text) #

User-provided idempotency token.

cmwDescription :: Lens' CreateMaintenanceWindow (Maybe Text) #

An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows.

cmwName :: Lens' CreateMaintenanceWindow Text #

The name of the Maintenance Window.

cmwSchedule :: Lens' CreateMaintenanceWindow Text #

The schedule of the Maintenance Window in the form of a cron or rate expression.

cmwDuration :: Lens' CreateMaintenanceWindow Natural #

The duration of the Maintenance Window in hours.

cmwCutoff :: Lens' CreateMaintenanceWindow Natural #

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

cmwAllowUnassociatedTargets :: Lens' CreateMaintenanceWindow Bool #

Enables a Maintenance Window task to execute on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window.

Destructuring the Response

createMaintenanceWindowResponse #

Creates a value of CreateMaintenanceWindowResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateMaintenanceWindowResponse #

See: createMaintenanceWindowResponse smart constructor.

Instances

Eq CreateMaintenanceWindowResponse # 
Data CreateMaintenanceWindowResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateMaintenanceWindowResponse -> c CreateMaintenanceWindowResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateMaintenanceWindowResponse #

toConstr :: CreateMaintenanceWindowResponse -> Constr #

dataTypeOf :: CreateMaintenanceWindowResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateMaintenanceWindowResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateMaintenanceWindowResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateMaintenanceWindowResponse -> CreateMaintenanceWindowResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateMaintenanceWindowResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateMaintenanceWindowResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateMaintenanceWindowResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateMaintenanceWindowResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateMaintenanceWindowResponse -> m CreateMaintenanceWindowResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateMaintenanceWindowResponse -> m CreateMaintenanceWindowResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateMaintenanceWindowResponse -> m CreateMaintenanceWindowResponse #

Read CreateMaintenanceWindowResponse # 
Show CreateMaintenanceWindowResponse # 
Generic CreateMaintenanceWindowResponse # 
NFData CreateMaintenanceWindowResponse # 
type Rep CreateMaintenanceWindowResponse # 
type Rep CreateMaintenanceWindowResponse = D1 * (MetaData "CreateMaintenanceWindowResponse" "Network.AWS.SSM.CreateMaintenanceWindow" "amazonka-ssm-1.6.0-3Tt35jiaR0xLZVuK0jt4Pc" False) (C1 * (MetaCons "CreateMaintenanceWindowResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cmwrsWindowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cmwrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cmwrsWindowId :: Lens' CreateMaintenanceWindowResponse (Maybe Text) #

The ID of the created Maintenance Window.