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.SSM.Types.Runbook

Description

Synopsis

data Runbook = Runbook' {
- documentVersion :: Maybe Text
- maxConcurrency :: Maybe Text
- maxErrors :: Maybe Text
- parameters :: Maybe (HashMap Text [Text])
- targetLocations :: Maybe (NonEmpty TargetLocation)
- targetMaps :: Maybe [HashMap Text [Text]]
- targetParameterName :: Maybe Text
- targets :: Maybe [Target]
- documentName :: Text
}
newRunbook :: Text -> Runbook
runbook_documentVersion :: Lens' Runbook (Maybe Text)
runbook_maxConcurrency :: Lens' Runbook (Maybe Text)
runbook_maxErrors :: Lens' Runbook (Maybe Text)
runbook_parameters :: Lens' Runbook (Maybe (HashMap Text [Text]))
runbook_targetLocations :: Lens' Runbook (Maybe (NonEmpty TargetLocation))
runbook_targetMaps :: Lens' Runbook (Maybe [HashMap Text [Text]])
runbook_targetParameterName :: Lens' Runbook (Maybe Text)
runbook_targets :: Lens' Runbook (Maybe [Target])
runbook_documentName :: Lens' Runbook Text

Documentation

data Runbook Source #

Information about an Automation runbook used in a runbook workflow in Change Manager.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

See: newRunbook smart constructor.

Constructors

Runbook'

Fields

documentVersion :: Maybe Text
The version of the Automation runbook used in a runbook workflow.
maxConcurrency :: Maybe Text
The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.
maxErrors :: Maybe Text
The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.
parameters :: Maybe (HashMap Text [Text])
The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.
targetLocations :: Maybe (NonEmpty TargetLocation)
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
targetMaps :: Maybe [HashMap Text [Text]]
A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.
targetParameterName :: Maybe Text
The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.
targets :: Maybe [Target]
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.
documentName :: Text
The name of the Automation runbook used in a runbook workflow.

Instances

Instances details

FromJSON Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook Methods parseJSON :: Value -> Parser Runbook # parseJSONList :: Value -> Parser [Runbook] #
ToJSON Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook Methods toJSON :: Runbook -> Value # toEncoding :: Runbook -> Encoding # toJSONList :: [Runbook] -> Value # toEncodingList :: [Runbook] -> Encoding #
Generic Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook Associated Types type Rep Runbook :: Type -> Type # Methods from :: Runbook -> Rep Runbook x # to :: Rep Runbook x -> Runbook #
Read Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook Methods readsPrec :: Int -> ReadS Runbook # readList :: ReadS [Runbook] # readPrec :: ReadPrec Runbook # readListPrec :: ReadPrec [Runbook] #
Show Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook Methods showsPrec :: Int -> Runbook -> ShowS # show :: Runbook -> String # showList :: [Runbook] -> ShowS #
NFData Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook Methods rnf :: Runbook -> () #
Eq Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook Methods (==) :: Runbook -> Runbook -> Bool # (/=) :: Runbook -> Runbook -> Bool #
Hashable Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook Methods hashWithSalt :: Int -> Runbook -> Int # hash :: Runbook -> Int #
type Rep Runbook Source #
Instance details Defined in Amazonka.SSM.Types.Runbook type Rep Runbook = D1 ('MetaData "Runbook" "Amazonka.SSM.Types.Runbook" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "Runbook'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))) :: ((S1 ('MetaSel ('Just "targetLocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty TargetLocation))) :: S1 ('MetaSel ('Just "targetMaps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HashMap Text [Text]]))) :: (S1 ('MetaSel ('Just "targetParameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target])) :: S1 ('MetaSel ('Just "documentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRunbook Source #

Arguments

:: Text	`$sel:documentName:Runbook'`
-> Runbook

Create a value of Runbook 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:documentVersion:Runbook', runbook_documentVersion - The version of the Automation runbook used in a runbook workflow.

$sel:maxConcurrency:Runbook', runbook_maxConcurrency - The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

$sel:maxErrors:Runbook', runbook_maxErrors - The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

$sel:parameters:Runbook', runbook_parameters - The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

$sel:targetLocations:Runbook', runbook_targetLocations - Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

$sel:targetMaps:Runbook', runbook_targetMaps - A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

$sel:targetParameterName:Runbook', runbook_targetParameterName - The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

$sel:targets:Runbook', runbook_targets - A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

$sel:documentName:Runbook', runbook_documentName - The name of the Automation runbook used in a runbook workflow.

runbook_documentVersion :: Lens' Runbook (Maybe Text) Source #

The version of the Automation runbook used in a runbook workflow.

runbook_maxConcurrency :: Lens' Runbook (Maybe Text) Source #

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

runbook_maxErrors :: Lens' Runbook (Maybe Text) Source #

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

runbook_parameters :: Lens' Runbook (Maybe (HashMap Text [Text])) Source #

The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

runbook_targetLocations :: Lens' Runbook (Maybe (NonEmpty TargetLocation)) Source #

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

runbook_targetMaps :: Lens' Runbook (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

runbook_targetParameterName :: Lens' Runbook (Maybe Text) Source #

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

runbook_targets :: Lens' Runbook (Maybe [Target]) Source #

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

runbook_documentName :: Lens' Runbook Text Source #

The name of the Automation runbook used in a runbook workflow.