Amazonka.SSMIncidents.Types.SsmAutomation

Documentation

data SsmAutomation

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

See: newSsmAutomation smart constructor.

Constructors

SsmAutomation'

Fields

• documentVersion :: Maybe Text

  The automation document's version to use when running.

• dynamicParameters :: Maybe (HashMap Text DynamicSsmParameterValue)

  The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

• parameters :: Maybe (HashMap Text [Text])

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

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

• 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

FromJSON SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

Methods

parseJSON :: Value -> Parser SsmAutomation

parseJSONList :: Value -> Parser [SsmAutomation]

ToJSON SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

Methods

toJSON :: SsmAutomation -> Value

toEncoding :: SsmAutomation -> Encoding

toJSONList :: [SsmAutomation] -> Value

toEncodingList :: [SsmAutomation] -> Encoding

Generic SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

Associated Types

type Rep SsmAutomation :: Type -> Type

Methods

from :: SsmAutomation -> Rep SsmAutomation x

to :: Rep SsmAutomation x -> SsmAutomation

Read SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

Methods

readsPrec :: Int -> ReadS SsmAutomation

readList :: ReadS [SsmAutomation]

readPrec :: ReadPrec SsmAutomation

readListPrec :: ReadPrec [SsmAutomation]

Show SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

Methods

showsPrec :: Int -> SsmAutomation -> ShowS

show :: SsmAutomation -> String

showList :: [SsmAutomation] -> ShowS

NFData SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

Methods

rnf :: SsmAutomation -> ()

Eq SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

Methods

(==) :: SsmAutomation -> SsmAutomation -> Bool

(/=) :: SsmAutomation -> SsmAutomation -> Bool

Hashable SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

Methods

hashWithSalt :: Int -> SsmAutomation -> Int

hash :: SsmAutomation -> Int

type Rep SsmAutomation

Defined in Amazonka.SSMIncidents.Types.SsmAutomation

type Rep SsmAutomation = D1 ('MetaData "SsmAutomation" "Amazonka.SSMIncidents.Types.SsmAutomation" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "SsmAutomation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dynamicParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text DynamicSsmParameterValue))) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))) :*: (S1 ('MetaSel ('Just "targetAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SsmTargetAccount)) :*: (S1 ('MetaSel ('Just "documentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSsmAutomation

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:documentVersion:SsmAutomation', ssmAutomation_documentVersion - The automation document's version to use when running.

$sel:dynamicParameters:SsmAutomation', ssmAutomation_dynamicParameters - The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

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

$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: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_documentVersion :: Lens' SsmAutomation (Maybe Text)

The automation document's version to use when running.

ssmAutomation_dynamicParameters :: Lens' SsmAutomation (Maybe (HashMap Text DynamicSsmParameterValue))

The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

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

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

ssmAutomation_targetAccount :: Lens' SsmAutomation (Maybe SsmTargetAccount)

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

ssmAutomation_documentName :: Lens' SsmAutomation Text

The automation document's name.

ssmAutomation_roleArn :: Lens' SsmAutomation Text

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