Amazonka.SSM.Types.Association

Documentation

data Association

Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

See: newAssociation smart constructor.

Constructors

Association'

Fields

• associationId :: Maybe Text

  The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

• associationName :: Maybe Text

  The association name.

• associationVersion :: Maybe Text

  The association version.

• documentVersion :: Maybe Text

  The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

  State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

• instanceId :: Maybe Text

  The managed node ID.

• lastExecutionDate :: Maybe POSIX

  The date on which the association was last run.

• name :: Maybe Text

  The name of the SSM document.

• overview :: Maybe AssociationOverview

  Information about the association.

• scheduleExpression :: Maybe Text

  A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

• scheduleOffset :: Maybe Natural

  Number of days to wait after the scheduled day to run an association.

• targetMaps :: Maybe [HashMap Text [Text]]

  A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

• targets :: Maybe [Target]

  The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

Instances

FromJSON Association

Defined in Amazonka.SSM.Types.Association

Methods

parseJSON :: Value -> Parser Association

parseJSONList :: Value -> Parser [Association]

Generic Association

Defined in Amazonka.SSM.Types.Association

Associated Types

type Rep Association :: Type -> Type

Methods

from :: Association -> Rep Association x

to :: Rep Association x -> Association

Read Association

Defined in Amazonka.SSM.Types.Association

Methods

readsPrec :: Int -> ReadS Association

readList :: ReadS [Association]

readPrec :: ReadPrec Association

readListPrec :: ReadPrec [Association]

Show Association

Defined in Amazonka.SSM.Types.Association

Methods

showsPrec :: Int -> Association -> ShowS

show :: Association -> String

showList :: [Association] -> ShowS

NFData Association

Defined in Amazonka.SSM.Types.Association

Methods

rnf :: Association -> ()

Eq Association

Defined in Amazonka.SSM.Types.Association

Methods

(==) :: Association -> Association -> Bool

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

Hashable Association

Defined in Amazonka.SSM.Types.Association

Methods

hashWithSalt :: Int -> Association -> Int

hash :: Association -> Int

type Rep Association

Defined in Amazonka.SSM.Types.Association

type Rep Association = D1 ('MetaData "Association" "Amazonka.SSM.Types.Association" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "Association'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "associationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "associationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "associationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastExecutionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "overview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssociationOverview)) :*: S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "scheduleOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "targetMaps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HashMap Text [Text]])) :*: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target])))))))

newAssociation :: Association

Create a value of Association 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:associationId:Association', association_associationId - The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

$sel:associationName:Association', association_associationName - The association name.

$sel:associationVersion:Association', association_associationVersion - The association version.

$sel:documentVersion:Association', association_documentVersion - The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

$sel:instanceId:Association', association_instanceId - The managed node ID.

$sel:lastExecutionDate:Association', association_lastExecutionDate - The date on which the association was last run.

$sel:name:Association', association_name - The name of the SSM document.

$sel:overview:Association', association_overview - Information about the association.

$sel:scheduleExpression:Association', association_scheduleExpression - A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

$sel:scheduleOffset:Association', association_scheduleOffset - Number of days to wait after the scheduled day to run an association.

$sel:targetMaps:Association', association_targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

$sel:targets:Association', association_targets - The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

association_associationId :: Lens' Association (Maybe Text)

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

association_associationName :: Lens' Association (Maybe Text)

The association name.

association_associationVersion :: Lens' Association (Maybe Text)

The association version.

association_documentVersion :: Lens' Association (Maybe Text)

The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

association_instanceId :: Lens' Association (Maybe Text)

The managed node ID.

association_lastExecutionDate :: Lens' Association (Maybe UTCTime)

The date on which the association was last run.

association_name :: Lens' Association (Maybe Text)

The name of the SSM document.

association_overview :: Lens' Association (Maybe AssociationOverview)

Information about the association.

association_scheduleExpression :: Lens' Association (Maybe Text)

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

association_scheduleOffset :: Lens' Association (Maybe Natural)

Number of days to wait after the scheduled day to run an association.

association_targetMaps :: Lens' Association (Maybe [HashMap Text [Text]])

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

association_targets :: Lens' Association (Maybe [Target])

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.