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.MGN.Types.SsmDocument

Description

Documentation

data SsmDocument Source #

AWS Systems Manager Document.

See: newSsmDocument smart constructor.

Constructors

SsmDocument'

Fields

mustSucceedForCutover :: Maybe Bool
If true, Cutover will not be enabled if the document has failed.
parameters :: Maybe (HashMap Text [SsmParameterStoreParameter])
AWS Systems Manager Document parameters.
timeoutSeconds :: Maybe Natural
AWS Systems Manager Document timeout seconds.
actionName :: Text
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName :: Text
AWS Systems Manager Document name or full ARN.

Instances

Instances details

FromJSON SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument Methods parseJSON :: Value -> Parser SsmDocument # parseJSONList :: Value -> Parser [SsmDocument] #
ToJSON SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument Methods toJSON :: SsmDocument -> Value # toEncoding :: SsmDocument -> Encoding # toJSONList :: [SsmDocument] -> Value # toEncodingList :: [SsmDocument] -> Encoding #
Generic SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument Associated Types type Rep SsmDocument :: Type -> Type # Methods from :: SsmDocument -> Rep SsmDocument x # to :: Rep SsmDocument x -> SsmDocument #
Read SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument Methods readsPrec :: Int -> ReadS SsmDocument # readList :: ReadS [SsmDocument] # readPrec :: ReadPrec SsmDocument # readListPrec :: ReadPrec [SsmDocument] #
Show SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument Methods showsPrec :: Int -> SsmDocument -> ShowS # show :: SsmDocument -> String # showList :: [SsmDocument] -> ShowS #
NFData SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument Methods rnf :: SsmDocument -> () #
Eq SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument Methods (==) :: SsmDocument -> SsmDocument -> Bool # (/=) :: SsmDocument -> SsmDocument -> Bool #
Hashable SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument Methods hashWithSalt :: Int -> SsmDocument -> Int # hash :: SsmDocument -> Int #
type Rep SsmDocument Source #
Instance details Defined in Amazonka.MGN.Types.SsmDocument type Rep SsmDocument = D1 ('MetaData "SsmDocument" "Amazonka.MGN.Types.SsmDocument" "amazonka-mgn-2.0-BuezedRYkBsCUJQfnWhjEk" 'False) (C1 ('MetaCons "SsmDocument'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mustSucceedForCutover") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [SsmParameterStoreParameter])))) :: (S1 ('MetaSel ('Just "timeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "actionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "ssmDocumentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSsmDocument Source #

Arguments

:: Text	`$sel:actionName:SsmDocument'`
-> Text	`$sel:ssmDocumentName:SsmDocument'`
-> SsmDocument

Create a value of SsmDocument 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:mustSucceedForCutover:SsmDocument', ssmDocument_mustSucceedForCutover - If true, Cutover will not be enabled if the document has failed.

$sel:parameters:SsmDocument', ssmDocument_parameters - AWS Systems Manager Document parameters.

$sel:timeoutSeconds:SsmDocument', ssmDocument_timeoutSeconds - AWS Systems Manager Document timeout seconds.

$sel:actionName:SsmDocument', ssmDocument_actionName - User-friendly name for the AWS Systems Manager Document.

$sel:ssmDocumentName:SsmDocument', ssmDocument_ssmDocumentName - AWS Systems Manager Document name or full ARN.

ssmDocument_mustSucceedForCutover :: Lens' SsmDocument (Maybe Bool) Source #

If true, Cutover will not be enabled if the document has failed.

ssmDocument_parameters :: Lens' SsmDocument (Maybe (HashMap Text [SsmParameterStoreParameter])) Source #

AWS Systems Manager Document parameters.

ssmDocument_timeoutSeconds :: Lens' SsmDocument (Maybe Natural) Source #

AWS Systems Manager Document timeout seconds.

ssmDocument_actionName :: Lens' SsmDocument Text Source #

User-friendly name for the AWS Systems Manager Document.

ssmDocument_ssmDocumentName :: Lens' SsmDocument Text Source #

AWS Systems Manager Document name or full ARN.