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 |
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
Synopsis
- data CreateAssociation = CreateAssociation' {
- alarmConfiguration :: Maybe AlarmConfiguration
- applyOnlyAtCronInterval :: Maybe Bool
- associationName :: Maybe Text
- automationTargetParameterName :: Maybe Text
- calendarNames :: Maybe [Text]
- complianceSeverity :: Maybe AssociationComplianceSeverity
- documentVersion :: Maybe Text
- instanceId :: Maybe Text
- maxConcurrency :: Maybe Text
- maxErrors :: Maybe Text
- outputLocation :: Maybe InstanceAssociationOutputLocation
- parameters :: Maybe (Sensitive (HashMap Text [Text]))
- scheduleExpression :: Maybe Text
- scheduleOffset :: Maybe Natural
- syncCompliance :: Maybe AssociationSyncCompliance
- tags :: Maybe [Tag]
- targetLocations :: Maybe (NonEmpty TargetLocation)
- targetMaps :: Maybe [HashMap Text [Text]]
- targets :: Maybe [Target]
- name :: Text
- newCreateAssociation :: Text -> CreateAssociation
- createAssociation_alarmConfiguration :: Lens' CreateAssociation (Maybe AlarmConfiguration)
- createAssociation_applyOnlyAtCronInterval :: Lens' CreateAssociation (Maybe Bool)
- createAssociation_associationName :: Lens' CreateAssociation (Maybe Text)
- createAssociation_automationTargetParameterName :: Lens' CreateAssociation (Maybe Text)
- createAssociation_calendarNames :: Lens' CreateAssociation (Maybe [Text])
- createAssociation_complianceSeverity :: Lens' CreateAssociation (Maybe AssociationComplianceSeverity)
- createAssociation_documentVersion :: Lens' CreateAssociation (Maybe Text)
- createAssociation_instanceId :: Lens' CreateAssociation (Maybe Text)
- createAssociation_maxConcurrency :: Lens' CreateAssociation (Maybe Text)
- createAssociation_maxErrors :: Lens' CreateAssociation (Maybe Text)
- createAssociation_outputLocation :: Lens' CreateAssociation (Maybe InstanceAssociationOutputLocation)
- createAssociation_parameters :: Lens' CreateAssociation (Maybe (HashMap Text [Text]))
- createAssociation_scheduleExpression :: Lens' CreateAssociation (Maybe Text)
- createAssociation_scheduleOffset :: Lens' CreateAssociation (Maybe Natural)
- createAssociation_syncCompliance :: Lens' CreateAssociation (Maybe AssociationSyncCompliance)
- createAssociation_tags :: Lens' CreateAssociation (Maybe [Tag])
- createAssociation_targetLocations :: Lens' CreateAssociation (Maybe (NonEmpty TargetLocation))
- createAssociation_targetMaps :: Lens' CreateAssociation (Maybe [HashMap Text [Text]])
- createAssociation_targets :: Lens' CreateAssociation (Maybe [Target])
- createAssociation_name :: Lens' CreateAssociation Text
- data CreateAssociationResponse = CreateAssociationResponse' {}
- newCreateAssociationResponse :: Int -> CreateAssociationResponse
- createAssociationResponse_associationDescription :: Lens' CreateAssociationResponse (Maybe AssociationDescription)
- createAssociationResponse_httpStatus :: Lens' CreateAssociationResponse Int
Creating a Request
data CreateAssociation Source #
See: newCreateAssociation
smart constructor.
CreateAssociation' | |
|
Instances
Create a value of CreateAssociation
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:
CreateAssociation
, createAssociation_alarmConfiguration
- Undocumented member.
CreateAssociation
, createAssociation_applyOnlyAtCronInterval
- By default, when you create a new association, the system runs it
immediately after it is created and then according to the schedule you
specified. Specify this option if you don't want an association to run
immediately after you create it. This parameter isn't supported for
rate expressions.
CreateAssociation
, createAssociation_associationName
- Specify a descriptive name for the association.
CreateAssociation
, createAssociation_automationTargetParameterName
- Choose the parameter that will define how your automation will branch
out. This target is required for associations that use an Automation
runbook and target resources by using rate controls. Automation is a
capability of Amazon Web Services Systems Manager.
CreateAssociation
, createAssociation_calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type
documents you want to gate your associations under. The associations
only run when that change calendar is open. For more information, see
Amazon Web Services Systems Manager Change Calendar.
CreateAssociation
, createAssociation_complianceSeverity
- The severity level to assign to the association.
CreateAssociation
, createAssociation_documentVersion
- The document version you want to associate with the target(s). Can be a
specific version or the default version.
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
.
CreateAssociation
, createAssociation_instanceId
- The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an
association, use the Targets
parameter. Requests that include the
parameter InstanceID
with Systems Manager documents (SSM documents)
that use schema version 2.0 or later will fail. In addition, if you use
the parameter InstanceId
, you can't use the parameters
AssociationName
, DocumentVersion
, MaxErrors
, MaxConcurrency
,
OutputLocation
, or ScheduleExpression
. To use these parameters, you
must use the Targets
parameter.
CreateAssociation
, createAssociation_maxConcurrency
- The maximum number of targets allowed to run the association at the same
time. You can specify a number, for example 10, or a percentage of the
target set, for example 10%. The default value is 100%, which means all
targets run the association at the same time.
If a new managed node starts and attempts to run an association while
Systems Manager is running MaxConcurrency
associations, the
association is allowed to run. During the next association interval, the
new managed node will process its association within the limit specified
for MaxConcurrency
.
CreateAssociation
, createAssociation_maxErrors
- The number of errors that are allowed before the system stops sending
requests to run the association on additional targets. You can specify
either an absolute number of errors, for example 10, or a percentage of
the target set, for example 10%. If you specify 3, for example, the
system stops sending requests when the fourth error is received. If you
specify 0, then the system stops sending requests after the first error
is returned. If you run an association on 50 managed nodes and set
MaxError
to 10%, then the system stops sending the request when the
sixth error is received.
Executions that are already running an association when MaxErrors
is
reached are allowed to complete, but some of these executions may fail
as well. If you need to ensure that there won't be more than max-errors
failed executions, set MaxConcurrency
to 1 so that executions proceed
one at a time.
CreateAssociation
, createAssociation_outputLocation
- An Amazon Simple Storage Service (Amazon S3) bucket where you want to
store the output details of the request.
CreateAssociation
, createAssociation_parameters
- The parameters for the runtime configuration of the document.
CreateAssociation
, createAssociation_scheduleExpression
- A cron expression when the association will be applied to the target(s).
CreateAssociation
, createAssociation_scheduleOffset
- Number of days to wait after the scheduled day to run an association.
For example, if you specified a cron schedule of
cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the
association each Sunday after the second Thursday of the month. For more
information about cron schedules for associations, see
Reference: Cron and rate expressions for Systems Manager
in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the system not to run an association
immediately after you create it.
CreateAssociation
, createAssociation_syncCompliance
- The mode for generating association compliance. You can specify AUTO
or MANUAL
. In AUTO
mode, the system uses the status of the
association execution to determine the compliance status. If the
association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the
association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter
for the PutComplianceItems API operation. In this case, compliance data
isn't managed by State Manager. It is managed by your direct call to
the PutComplianceItems API operation.
By default, all associations use AUTO
mode.
CreateAssociation
, createAssociation_tags
- Adds or overwrites one or more tags for a State Manager association.
Tags are metadata that you can assign to your Amazon Web Services
resources. Tags enable you to categorize your resources in different
ways, for example, by purpose, owner, or environment. Each tag consists
of a key and an optional value, both of which you define.
CreateAssociation
, createAssociation_targetLocations
- A location is a combination of Amazon Web Services Regions and Amazon
Web Services accounts where you want to run the association. Use this
action to create an association in multiple Regions and multiple
accounts.
CreateAssociation
, createAssociation_targetMaps
- A key-value mapping of document parameters to target resources. Both
Targets and TargetMaps can't be specified together.
CreateAssociation
, createAssociation_targets
- The targets for the association. You can target managed nodes by using
tags, Amazon Web Services resource groups, all managed nodes in an
Amazon Web Services account, or individual managed node IDs. You can
target all managed nodes in an Amazon Web Services account by specifying
the InstanceIds
key with a value of *
. For more information about
choosing targets for an association, see
Using targets and rate controls with State Manager associations
in the Amazon Web Services Systems Manager User Guide.
CreateAssociation
, createAssociation_name
- The name of the SSM Command document or Automation runbook that contains
the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:
partition
:ssm:
region
:
account-id
:document/
document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you
created in your account, you only need to specify the document name. For
example, AWS-ApplyPatchBaseline
or My-Document
.
Request Lenses
createAssociation_alarmConfiguration :: Lens' CreateAssociation (Maybe AlarmConfiguration) Source #
Undocumented member.
createAssociation_applyOnlyAtCronInterval :: Lens' CreateAssociation (Maybe Bool) Source #
By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
createAssociation_associationName :: Lens' CreateAssociation (Maybe Text) Source #
Specify a descriptive name for the association.
createAssociation_automationTargetParameterName :: Lens' CreateAssociation (Maybe Text) Source #
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
createAssociation_calendarNames :: Lens' CreateAssociation (Maybe [Text]) Source #
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
createAssociation_complianceSeverity :: Lens' CreateAssociation (Maybe AssociationComplianceSeverity) Source #
The severity level to assign to the association.
createAssociation_documentVersion :: Lens' CreateAssociation (Maybe Text) Source #
The document version you want to associate with the target(s). Can be a specific version or the default version.
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
.
createAssociation_instanceId :: Lens' CreateAssociation (Maybe Text) Source #
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an
association, use the Targets
parameter. Requests that include the
parameter InstanceID
with Systems Manager documents (SSM documents)
that use schema version 2.0 or later will fail. In addition, if you use
the parameter InstanceId
, you can't use the parameters
AssociationName
, DocumentVersion
, MaxErrors
, MaxConcurrency
,
OutputLocation
, or ScheduleExpression
. To use these parameters, you
must use the Targets
parameter.
createAssociation_maxConcurrency :: Lens' CreateAssociation (Maybe Text) Source #
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while
Systems Manager is running MaxConcurrency
associations, the
association is allowed to run. During the next association interval, the
new managed node will process its association within the limit specified
for MaxConcurrency
.
createAssociation_maxErrors :: Lens' CreateAssociation (Maybe Text) Source #
The number of errors that are allowed before the system stops sending
requests to run the association on additional targets. You can specify
either an absolute number of errors, for example 10, or a percentage of
the target set, for example 10%. If you specify 3, for example, the
system stops sending requests when the fourth error is received. If you
specify 0, then the system stops sending requests after the first error
is returned. If you run an association on 50 managed nodes and set
MaxError
to 10%, then the system stops sending the request when the
sixth error is received.
Executions that are already running an association when MaxErrors
is
reached are allowed to complete, but some of these executions may fail
as well. If you need to ensure that there won't be more than max-errors
failed executions, set MaxConcurrency
to 1 so that executions proceed
one at a time.
createAssociation_outputLocation :: Lens' CreateAssociation (Maybe InstanceAssociationOutputLocation) Source #
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
createAssociation_parameters :: Lens' CreateAssociation (Maybe (HashMap Text [Text])) Source #
The parameters for the runtime configuration of the document.
createAssociation_scheduleExpression :: Lens' CreateAssociation (Maybe Text) Source #
A cron expression when the association will be applied to the target(s).
createAssociation_scheduleOffset :: Lens' CreateAssociation (Maybe Natural) Source #
Number of days to wait after the scheduled day to run an association.
For example, if you specified a cron schedule of
cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the
association each Sunday after the second Thursday of the month. For more
information about cron schedules for associations, see
Reference: Cron and rate expressions for Systems Manager
in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the system not to run an association
immediately after you create it.
createAssociation_syncCompliance :: Lens' CreateAssociation (Maybe AssociationSyncCompliance) Source #
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In AUTO
mode, the system uses the status of the
association execution to determine the compliance status. If the
association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the
association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter
for the PutComplianceItems API operation. In this case, compliance data
isn't managed by State Manager. It is managed by your direct call to
the PutComplianceItems API operation.
By default, all associations use AUTO
mode.
createAssociation_tags :: Lens' CreateAssociation (Maybe [Tag]) Source #
Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
createAssociation_targetLocations :: Lens' CreateAssociation (Maybe (NonEmpty TargetLocation)) Source #
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
createAssociation_targetMaps :: Lens' CreateAssociation (Maybe [HashMap Text [Text]]) Source #
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
createAssociation_targets :: Lens' CreateAssociation (Maybe [Target]) Source #
The targets for the association. You can target managed nodes by using
tags, Amazon Web Services resource groups, all managed nodes in an
Amazon Web Services account, or individual managed node IDs. You can
target all managed nodes in an Amazon Web Services account by specifying
the InstanceIds
key with a value of *
. For more information about
choosing targets for an association, see
Using targets and rate controls with State Manager associations
in the Amazon Web Services Systems Manager User Guide.
createAssociation_name :: Lens' CreateAssociation Text Source #
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:
partition
:ssm:
region
:
account-id
:document/
document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you
created in your account, you only need to specify the document name. For
example, AWS-ApplyPatchBaseline
or My-Document
.
Destructuring the Response
data CreateAssociationResponse Source #
See: newCreateAssociationResponse
smart constructor.
CreateAssociationResponse' | |
|
Instances
newCreateAssociationResponse Source #
Create a value of CreateAssociationResponse
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:associationDescription:CreateAssociationResponse'
, createAssociationResponse_associationDescription
- Information about the association.
$sel:httpStatus:CreateAssociationResponse'
, createAssociationResponse_httpStatus
- The response's http status code.
Response Lenses
createAssociationResponse_associationDescription :: Lens' CreateAssociationResponse (Maybe AssociationDescription) Source #
Information about the association.
createAssociationResponse_httpStatus :: Lens' CreateAssociationResponse Int Source #
The response's http status code.