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

Description

Documentation

data DocumentParameter Source #

Parameters specified in a System Manager document that run on the server when the command is run.

See: newDocumentParameter smart constructor.

Constructors

DocumentParameter'

Fields

name :: Maybe Text
The name of the parameter.
defaultValue :: Maybe Text
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
type' :: Maybe DocumentParameterType
The type of parameter. The type can be either String or StringList.
description :: Maybe Text
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

Instances

Instances details

Eq DocumentParameter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentParameter Methods (==) :: DocumentParameter -> DocumentParameter -> Bool # (/=) :: DocumentParameter -> DocumentParameter -> Bool #
Read DocumentParameter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentParameter Methods readsPrec :: Int -> ReadS DocumentParameter # readList :: ReadS [DocumentParameter] # readPrec :: ReadPrec DocumentParameter # readListPrec :: ReadPrec [DocumentParameter] #
Show DocumentParameter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentParameter Methods showsPrec :: Int -> DocumentParameter -> ShowS # show :: DocumentParameter -> String # showList :: [DocumentParameter] -> ShowS #
Generic DocumentParameter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentParameter Associated Types type Rep DocumentParameter :: Type -> Type # Methods from :: DocumentParameter -> Rep DocumentParameter x # to :: Rep DocumentParameter x -> DocumentParameter #
NFData DocumentParameter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentParameter Methods rnf :: DocumentParameter -> () #
Hashable DocumentParameter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentParameter Methods hashWithSalt :: Int -> DocumentParameter -> Int # hash :: DocumentParameter -> Int #
FromJSON DocumentParameter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentParameter Methods parseJSON :: Value -> Parser DocumentParameter # parseJSONList :: Value -> Parser [DocumentParameter] #
type Rep DocumentParameter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentParameter type Rep DocumentParameter = D1 ('MetaData "DocumentParameter" "Amazonka.SSM.Types.DocumentParameter" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DocumentParameter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentParameterType)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentParameter :: DocumentParameter Source #

Create a value of DocumentParameter 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:name:DocumentParameter', documentParameter_name - The name of the parameter.

$sel:defaultValue:DocumentParameter', documentParameter_defaultValue - If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

$sel:type':DocumentParameter', documentParameter_type - The type of parameter. The type can be either String or StringList.

$sel:description:DocumentParameter', documentParameter_description - A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

documentParameter_name :: Lens' DocumentParameter (Maybe Text) Source #

The name of the parameter.

documentParameter_defaultValue :: Lens' DocumentParameter (Maybe Text) Source #

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

documentParameter_type :: Lens' DocumentParameter (Maybe DocumentParameterType) Source #

The type of parameter. The type can be either String or StringList.

documentParameter_description :: Lens' DocumentParameter (Maybe Text) Source #

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.