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 |
Synopsis
- data AssociationDescription = AssociationDescription' {
- alarmConfiguration :: Maybe AlarmConfiguration
- applyOnlyAtCronInterval :: Maybe Bool
- associationId :: Maybe Text
- associationName :: Maybe Text
- associationVersion :: Maybe Text
- automationTargetParameterName :: Maybe Text
- calendarNames :: Maybe [Text]
- complianceSeverity :: Maybe AssociationComplianceSeverity
- date :: Maybe POSIX
- documentVersion :: Maybe Text
- instanceId :: Maybe Text
- lastExecutionDate :: Maybe POSIX
- lastSuccessfulExecutionDate :: Maybe POSIX
- lastUpdateAssociationDate :: Maybe POSIX
- maxConcurrency :: Maybe Text
- maxErrors :: Maybe Text
- name :: Maybe Text
- outputLocation :: Maybe InstanceAssociationOutputLocation
- overview :: Maybe AssociationOverview
- parameters :: Maybe (Sensitive (HashMap Text [Text]))
- scheduleExpression :: Maybe Text
- scheduleOffset :: Maybe Natural
- status :: Maybe AssociationStatus
- syncCompliance :: Maybe AssociationSyncCompliance
- targetLocations :: Maybe (NonEmpty TargetLocation)
- targetMaps :: Maybe [HashMap Text [Text]]
- targets :: Maybe [Target]
- triggeredAlarms :: Maybe (NonEmpty AlarmStateInformation)
- newAssociationDescription :: AssociationDescription
- associationDescription_alarmConfiguration :: Lens' AssociationDescription (Maybe AlarmConfiguration)
- associationDescription_applyOnlyAtCronInterval :: Lens' AssociationDescription (Maybe Bool)
- associationDescription_associationId :: Lens' AssociationDescription (Maybe Text)
- associationDescription_associationName :: Lens' AssociationDescription (Maybe Text)
- associationDescription_associationVersion :: Lens' AssociationDescription (Maybe Text)
- associationDescription_automationTargetParameterName :: Lens' AssociationDescription (Maybe Text)
- associationDescription_calendarNames :: Lens' AssociationDescription (Maybe [Text])
- associationDescription_complianceSeverity :: Lens' AssociationDescription (Maybe AssociationComplianceSeverity)
- associationDescription_date :: Lens' AssociationDescription (Maybe UTCTime)
- associationDescription_documentVersion :: Lens' AssociationDescription (Maybe Text)
- associationDescription_instanceId :: Lens' AssociationDescription (Maybe Text)
- associationDescription_lastExecutionDate :: Lens' AssociationDescription (Maybe UTCTime)
- associationDescription_lastSuccessfulExecutionDate :: Lens' AssociationDescription (Maybe UTCTime)
- associationDescription_lastUpdateAssociationDate :: Lens' AssociationDescription (Maybe UTCTime)
- associationDescription_maxConcurrency :: Lens' AssociationDescription (Maybe Text)
- associationDescription_maxErrors :: Lens' AssociationDescription (Maybe Text)
- associationDescription_name :: Lens' AssociationDescription (Maybe Text)
- associationDescription_outputLocation :: Lens' AssociationDescription (Maybe InstanceAssociationOutputLocation)
- associationDescription_overview :: Lens' AssociationDescription (Maybe AssociationOverview)
- associationDescription_parameters :: Lens' AssociationDescription (Maybe (HashMap Text [Text]))
- associationDescription_scheduleExpression :: Lens' AssociationDescription (Maybe Text)
- associationDescription_scheduleOffset :: Lens' AssociationDescription (Maybe Natural)
- associationDescription_status :: Lens' AssociationDescription (Maybe AssociationStatus)
- associationDescription_syncCompliance :: Lens' AssociationDescription (Maybe AssociationSyncCompliance)
- associationDescription_targetLocations :: Lens' AssociationDescription (Maybe (NonEmpty TargetLocation))
- associationDescription_targetMaps :: Lens' AssociationDescription (Maybe [HashMap Text [Text]])
- associationDescription_targets :: Lens' AssociationDescription (Maybe [Target])
- associationDescription_triggeredAlarms :: Lens' AssociationDescription (Maybe (NonEmpty AlarmStateInformation))
Documentation
data AssociationDescription Source #
Describes the parameters for a document.
See: newAssociationDescription
smart constructor.
AssociationDescription' | |
|
Instances
newAssociationDescription :: AssociationDescription Source #
Create a value of AssociationDescription
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:alarmConfiguration:AssociationDescription'
, associationDescription_alarmConfiguration
- Undocumented member.
$sel:applyOnlyAtCronInterval:AssociationDescription'
, associationDescription_applyOnlyAtCronInterval
- By default, when you create a new associations, 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.
$sel:associationId:AssociationDescription'
, associationDescription_associationId
- The association ID.
$sel:associationName:AssociationDescription'
, associationDescription_associationName
- The association name.
$sel:associationVersion:AssociationDescription'
, associationDescription_associationVersion
- The association version.
$sel:automationTargetParameterName:AssociationDescription'
, associationDescription_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.
$sel:calendarNames:AssociationDescription'
, associationDescription_calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type
documents your associations are gated under. The associations only run
when that change calendar is open. For more information, see
Amazon Web Services Systems Manager Change Calendar.
$sel:complianceSeverity:AssociationDescription'
, associationDescription_complianceSeverity
- The severity level that is assigned to the association.
AssociationDescription
, associationDescription_date
- The date when the association was made.
$sel:documentVersion:AssociationDescription'
, associationDescription_documentVersion
- The document version.
$sel:instanceId:AssociationDescription'
, associationDescription_instanceId
- The managed node ID.
$sel:lastExecutionDate:AssociationDescription'
, associationDescription_lastExecutionDate
- The date on which the association was last run.
$sel:lastSuccessfulExecutionDate:AssociationDescription'
, associationDescription_lastSuccessfulExecutionDate
- The last date on which the association was successfully run.
$sel:lastUpdateAssociationDate:AssociationDescription'
, associationDescription_lastUpdateAssociationDate
- The date when the association was last updated.
$sel:maxConcurrency:AssociationDescription'
, associationDescription_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
.
$sel:maxErrors:AssociationDescription'
, associationDescription_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.
AssociationDescription
, associationDescription_name
- The name of the SSM document.
$sel:outputLocation:AssociationDescription'
, associationDescription_outputLocation
- An S3 bucket where you want to store the output details of the request.
$sel:overview:AssociationDescription'
, associationDescription_overview
- Information about the association.
$sel:parameters:AssociationDescription'
, associationDescription_parameters
- A description of the parameters for a document.
$sel:scheduleExpression:AssociationDescription'
, associationDescription_scheduleExpression
- A cron expression that specifies a schedule when the association runs.
$sel:scheduleOffset:AssociationDescription'
, associationDescription_scheduleOffset
- Number of days to wait after the scheduled day to run an association.
AssociationDescription
, associationDescription_status
- The association status.
$sel:syncCompliance:AssociationDescription'
, associationDescription_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, a capability of Amazon Web Services
Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
$sel:targetLocations:AssociationDescription'
, associationDescription_targetLocations
- The combination of Amazon Web Services Regions and Amazon Web Services
accounts where you want to run the association.
$sel:targetMaps:AssociationDescription'
, associationDescription_targetMaps
- A key-value mapping of document parameters to target resources. Both
Targets and TargetMaps can't be specified together.
$sel:targets:AssociationDescription'
, associationDescription_targets
- The managed nodes targeted by the request.
$sel:triggeredAlarms:AssociationDescription'
, associationDescription_triggeredAlarms
- The CloudWatch alarm that was invoked during the association.
associationDescription_alarmConfiguration :: Lens' AssociationDescription (Maybe AlarmConfiguration) Source #
Undocumented member.
associationDescription_applyOnlyAtCronInterval :: Lens' AssociationDescription (Maybe Bool) Source #
By default, when you create a new associations, 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.
associationDescription_associationId :: Lens' AssociationDescription (Maybe Text) Source #
The association ID.
associationDescription_associationName :: Lens' AssociationDescription (Maybe Text) Source #
The association name.
associationDescription_associationVersion :: Lens' AssociationDescription (Maybe Text) Source #
The association version.
associationDescription_automationTargetParameterName :: Lens' AssociationDescription (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.
associationDescription_calendarNames :: Lens' AssociationDescription (Maybe [Text]) Source #
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
associationDescription_complianceSeverity :: Lens' AssociationDescription (Maybe AssociationComplianceSeverity) Source #
The severity level that is assigned to the association.
associationDescription_date :: Lens' AssociationDescription (Maybe UTCTime) Source #
The date when the association was made.
associationDescription_documentVersion :: Lens' AssociationDescription (Maybe Text) Source #
The document version.
associationDescription_instanceId :: Lens' AssociationDescription (Maybe Text) Source #
The managed node ID.
associationDescription_lastExecutionDate :: Lens' AssociationDescription (Maybe UTCTime) Source #
The date on which the association was last run.
associationDescription_lastSuccessfulExecutionDate :: Lens' AssociationDescription (Maybe UTCTime) Source #
The last date on which the association was successfully run.
associationDescription_lastUpdateAssociationDate :: Lens' AssociationDescription (Maybe UTCTime) Source #
The date when the association was last updated.
associationDescription_maxConcurrency :: Lens' AssociationDescription (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
.
associationDescription_maxErrors :: Lens' AssociationDescription (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.
associationDescription_name :: Lens' AssociationDescription (Maybe Text) Source #
The name of the SSM document.
associationDescription_outputLocation :: Lens' AssociationDescription (Maybe InstanceAssociationOutputLocation) Source #
An S3 bucket where you want to store the output details of the request.
associationDescription_overview :: Lens' AssociationDescription (Maybe AssociationOverview) Source #
Information about the association.
associationDescription_parameters :: Lens' AssociationDescription (Maybe (HashMap Text [Text])) Source #
A description of the parameters for a document.
associationDescription_scheduleExpression :: Lens' AssociationDescription (Maybe Text) Source #
A cron expression that specifies a schedule when the association runs.
associationDescription_scheduleOffset :: Lens' AssociationDescription (Maybe Natural) Source #
Number of days to wait after the scheduled day to run an association.
associationDescription_status :: Lens' AssociationDescription (Maybe AssociationStatus) Source #
The association status.
associationDescription_syncCompliance :: Lens' AssociationDescription (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, a capability of Amazon Web Services
Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
associationDescription_targetLocations :: Lens' AssociationDescription (Maybe (NonEmpty TargetLocation)) Source #
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
associationDescription_targetMaps :: Lens' AssociationDescription (Maybe [HashMap Text [Text]]) Source #
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
associationDescription_targets :: Lens' AssociationDescription (Maybe [Target]) Source #
The managed nodes targeted by the request.
associationDescription_triggeredAlarms :: Lens' AssociationDescription (Maybe (NonEmpty AlarmStateInformation)) Source #
The CloudWatch alarm that was invoked during the association.