amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.Types.DocumentRequires

Description

 
Synopsis

Documentation

data DocumentRequires Source #

An SSM document required by the current document.

See: newDocumentRequires smart constructor.

Constructors

DocumentRequires' 

Fields

  • requireType :: Maybe Text

    The document type of the required SSM document.

  • version :: Maybe Text

    The document version required by the current document.

  • versionName :: Maybe Text

    An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

  • name :: Text

    The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

Instances

Instances details
FromJSON DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

ToJSON DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

Generic DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

Associated Types

type Rep DocumentRequires :: Type -> Type #

Read DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

Show DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

NFData DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

Methods

rnf :: DocumentRequires -> () #

Eq DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

Hashable DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

type Rep DocumentRequires Source # 
Instance details

Defined in Amazonka.SSM.Types.DocumentRequires

type Rep DocumentRequires = D1 ('MetaData "DocumentRequires" "Amazonka.SSM.Types.DocumentRequires" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DocumentRequires'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requireType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDocumentRequires Source #

Create a value of DocumentRequires 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:requireType:DocumentRequires', documentRequires_requireType - The document type of the required SSM document.

$sel:version:DocumentRequires', documentRequires_version - The document version required by the current document.

$sel:versionName:DocumentRequires', documentRequires_versionName - An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

$sel:name:DocumentRequires', documentRequires_name - The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

documentRequires_requireType :: Lens' DocumentRequires (Maybe Text) Source #

The document type of the required SSM document.

documentRequires_version :: Lens' DocumentRequires (Maybe Text) Source #

The document version required by the current document.

documentRequires_versionName :: Lens' DocumentRequires (Maybe Text) Source #

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

documentRequires_name :: Lens' DocumentRequires Text Source #

The name of the required SSM document. The name can be an Amazon Resource Name (ARN).