Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSMIncidents.Types.SsmAutomation

Description

Synopsis

Documentation

data SsmAutomation Source #

Details about the Systems Manager automation document that will be used as a runbook during an incident.

See: newSsmAutomation smart constructor.

Constructors

SsmAutomation'

Fields

targetAccount :: Maybe SsmTargetAccount
The account that the automation document will be run in. This can be in either the management account or an application account.
parameters :: Maybe (HashMap Text [Text])
The key-value pair parameters to use when running the automation document.
documentVersion :: Maybe Text
The automation document's version to use when running.
documentName :: Text
The automation document's name.
roleArn :: Text
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

Instances

Instances details

Eq SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation Methods (==) :: SsmAutomation -> SsmAutomation -> Bool # (/=) :: SsmAutomation -> SsmAutomation -> Bool #
Read SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation Methods readsPrec :: Int -> ReadS SsmAutomation # readList :: ReadS [SsmAutomation] # readPrec :: ReadPrec SsmAutomation # readListPrec :: ReadPrec [SsmAutomation] #
Show SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation Methods showsPrec :: Int -> SsmAutomation -> ShowS # show :: SsmAutomation -> String # showList :: [SsmAutomation] -> ShowS #
Generic SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation Associated Types type Rep SsmAutomation :: Type -> Type # Methods from :: SsmAutomation -> Rep SsmAutomation x # to :: Rep SsmAutomation x -> SsmAutomation #
NFData SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation Methods rnf :: SsmAutomation -> () #
Hashable SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation Methods hashWithSalt :: Int -> SsmAutomation -> Int # hash :: SsmAutomation -> Int #
ToJSON SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation Methods toJSON :: SsmAutomation -> Value # toEncoding :: SsmAutomation -> Encoding # toJSONList :: [SsmAutomation] -> Value # toEncodingList :: [SsmAutomation] -> Encoding #
FromJSON SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation Methods parseJSON :: Value -> Parser SsmAutomation # parseJSONList :: Value -> Parser [SsmAutomation] #
type Rep SsmAutomation Source #
Instance details Defined in Amazonka.SSMIncidents.Types.SsmAutomation type Rep SsmAutomation = D1 ('MetaData "SsmAutomation" "Amazonka.SSMIncidents.Types.SsmAutomation" "libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents" 'False) (C1 ('MetaCons "SsmAutomation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "targetAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SsmTargetAccount)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text])))) :: (S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSsmAutomation Source #

Arguments

:: Text	`$sel:documentName:SsmAutomation'`
-> Text	`$sel:roleArn:SsmAutomation'`
-> SsmAutomation

Create a value of SsmAutomation 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:targetAccount:SsmAutomation', ssmAutomation_targetAccount - The account that the automation document will be run in. This can be in either the management account or an application account.

$sel:parameters:SsmAutomation', ssmAutomation_parameters - The key-value pair parameters to use when running the automation document.

$sel:documentVersion:SsmAutomation', ssmAutomation_documentVersion - The automation document's version to use when running.

$sel:documentName:SsmAutomation', ssmAutomation_documentName - The automation document's name.

$sel:roleArn:SsmAutomation', ssmAutomation_roleArn - The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

ssmAutomation_targetAccount :: Lens' SsmAutomation (Maybe SsmTargetAccount) Source #

The account that the automation document will be run in. This can be in either the management account or an application account.

ssmAutomation_parameters :: Lens' SsmAutomation (Maybe (HashMap Text [Text])) Source #

The key-value pair parameters to use when running the automation document.

ssmAutomation_documentVersion :: Lens' SsmAutomation (Maybe Text) Source #

The automation document's version to use when running.

ssmAutomation_documentName :: Lens' SsmAutomation Text Source #

The automation document's name.

ssmAutomation_roleArn :: Lens' SsmAutomation Text Source #

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.