/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Describes the association of a Amazon Web Services Systems Manager document
* (SSM document) and a managed node.See Also:
AWS
* API Reference
The name of the SSM document that contains the configuration information for * the managed node. You can specify Command or Automation runbooks.
You can * specify Amazon Web Services-predefined documents, documents you created, or a * document that is shared with you from another account.
For 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:aws: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.
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.
A description of the parameters for a document.
*/ inline const Aws::MapSpecify the target for the association. 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.
*/ inline const Aws::String& GetAutomationTargetParameterName() const{ return m_automationTargetParameterName; } inline bool AutomationTargetParameterNameHasBeenSet() const { return m_automationTargetParameterNameHasBeenSet; } inline void SetAutomationTargetParameterName(const Aws::String& value) { m_automationTargetParameterNameHasBeenSet = true; m_automationTargetParameterName = value; } inline void SetAutomationTargetParameterName(Aws::String&& value) { m_automationTargetParameterNameHasBeenSet = true; m_automationTargetParameterName = std::move(value); } inline void SetAutomationTargetParameterName(const char* value) { m_automationTargetParameterNameHasBeenSet = true; m_automationTargetParameterName.assign(value); } inline CreateAssociationBatchRequestEntry& WithAutomationTargetParameterName(const Aws::String& value) { SetAutomationTargetParameterName(value); return *this;} inline CreateAssociationBatchRequestEntry& WithAutomationTargetParameterName(Aws::String&& value) { SetAutomationTargetParameterName(std::move(value)); return *this;} inline CreateAssociationBatchRequestEntry& WithAutomationTargetParameterName(const char* value) { SetAutomationTargetParameterName(value); return *this;} ///@} ///@{ /** *The document version.
*/ inline const Aws::String& GetDocumentVersion() const{ return m_documentVersion; } inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; } inline void SetDocumentVersion(const Aws::String& value) { m_documentVersionHasBeenSet = true; m_documentVersion = value; } inline void SetDocumentVersion(Aws::String&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::move(value); } inline void SetDocumentVersion(const char* value) { m_documentVersionHasBeenSet = true; m_documentVersion.assign(value); } inline CreateAssociationBatchRequestEntry& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;} inline CreateAssociationBatchRequestEntry& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;} inline CreateAssociationBatchRequestEntry& WithDocumentVersion(const char* value) { SetDocumentVersion(value); return *this;} ///@} ///@{ /** *The managed nodes targeted by the request.
*/ inline const Aws::VectorA cron expression that specifies a schedule when the association runs.
*/ inline const Aws::String& GetScheduleExpression() const{ return m_scheduleExpression; } inline bool ScheduleExpressionHasBeenSet() const { return m_scheduleExpressionHasBeenSet; } inline void SetScheduleExpression(const Aws::String& value) { m_scheduleExpressionHasBeenSet = true; m_scheduleExpression = value; } inline void SetScheduleExpression(Aws::String&& value) { m_scheduleExpressionHasBeenSet = true; m_scheduleExpression = std::move(value); } inline void SetScheduleExpression(const char* value) { m_scheduleExpressionHasBeenSet = true; m_scheduleExpression.assign(value); } inline CreateAssociationBatchRequestEntry& WithScheduleExpression(const Aws::String& value) { SetScheduleExpression(value); return *this;} inline CreateAssociationBatchRequestEntry& WithScheduleExpression(Aws::String&& value) { SetScheduleExpression(std::move(value)); return *this;} inline CreateAssociationBatchRequestEntry& WithScheduleExpression(const char* value) { SetScheduleExpression(value); return *this;} ///@} ///@{ /** *An S3 bucket where you want to store the results of this request.
*/ inline const InstanceAssociationOutputLocation& GetOutputLocation() const{ return m_outputLocation; } inline bool OutputLocationHasBeenSet() const { return m_outputLocationHasBeenSet; } inline void SetOutputLocation(const InstanceAssociationOutputLocation& value) { m_outputLocationHasBeenSet = true; m_outputLocation = value; } inline void SetOutputLocation(InstanceAssociationOutputLocation&& value) { m_outputLocationHasBeenSet = true; m_outputLocation = std::move(value); } inline CreateAssociationBatchRequestEntry& WithOutputLocation(const InstanceAssociationOutputLocation& value) { SetOutputLocation(value); return *this;} inline CreateAssociationBatchRequestEntry& WithOutputLocation(InstanceAssociationOutputLocation&& value) { SetOutputLocation(std::move(value)); return *this;} ///@} ///@{ /** *Specify a descriptive name for the association.
*/ inline const Aws::String& GetAssociationName() const{ return m_associationName; } inline bool AssociationNameHasBeenSet() const { return m_associationNameHasBeenSet; } inline void SetAssociationName(const Aws::String& value) { m_associationNameHasBeenSet = true; m_associationName = value; } inline void SetAssociationName(Aws::String&& value) { m_associationNameHasBeenSet = true; m_associationName = std::move(value); } inline void SetAssociationName(const char* value) { m_associationNameHasBeenSet = true; m_associationName.assign(value); } inline CreateAssociationBatchRequestEntry& WithAssociationName(const Aws::String& value) { SetAssociationName(value); return *this;} inline CreateAssociationBatchRequestEntry& WithAssociationName(Aws::String&& value) { SetAssociationName(std::move(value)); return *this;} inline CreateAssociationBatchRequestEntry& WithAssociationName(const char* value) { SetAssociationName(value); return *this;} ///@} ///@{ /** *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.
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.
The severity level to assign to the association.
*/ inline const AssociationComplianceSeverity& GetComplianceSeverity() const{ return m_complianceSeverity; } inline bool ComplianceSeverityHasBeenSet() const { return m_complianceSeverityHasBeenSet; } inline void SetComplianceSeverity(const AssociationComplianceSeverity& value) { m_complianceSeverityHasBeenSet = true; m_complianceSeverity = value; } inline void SetComplianceSeverity(AssociationComplianceSeverity&& value) { m_complianceSeverityHasBeenSet = true; m_complianceSeverity = std::move(value); } inline CreateAssociationBatchRequestEntry& WithComplianceSeverity(const AssociationComplianceSeverity& value) { SetComplianceSeverity(value); return *this;} inline CreateAssociationBatchRequestEntry& WithComplianceSeverity(AssociationComplianceSeverity&& value) { SetComplianceSeverity(std::move(value)); return *this;} ///@} ///@{ /** *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.
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.
*/ inline bool GetApplyOnlyAtCronInterval() const{ return m_applyOnlyAtCronInterval; } inline bool ApplyOnlyAtCronIntervalHasBeenSet() const { return m_applyOnlyAtCronIntervalHasBeenSet; } inline void SetApplyOnlyAtCronInterval(bool value) { m_applyOnlyAtCronIntervalHasBeenSet = true; m_applyOnlyAtCronInterval = value; } inline CreateAssociationBatchRequestEntry& WithApplyOnlyAtCronInterval(bool value) { SetApplyOnlyAtCronInterval(value); return *this;} ///@} ///@{ /** *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.
*/ inline const Aws::VectorUse this action to create an association in multiple Regions and multiple * accounts.
*/ inline const Aws::VectorNumber of days to wait after the scheduled day to run an association.
*/ inline int GetScheduleOffset() const{ return m_scheduleOffset; } inline bool ScheduleOffsetHasBeenSet() const { return m_scheduleOffsetHasBeenSet; } inline void SetScheduleOffset(int value) { m_scheduleOffsetHasBeenSet = true; m_scheduleOffset = value; } inline CreateAssociationBatchRequestEntry& WithScheduleOffset(int value) { SetScheduleOffset(value); return *this;} ///@} ///@{ /** *The number of hours the association can run before it is canceled. Duration * applies to associations that are currently running, and any pending and in * progress commands on all targets. If a target was taken offline for the * association to run, it is made available again immediately, without a reboot. *
The Duration parameter applies only when both these
* conditions are true:
The association for which you specify a * duration is cancelable according to the parameters of the SSM command document * or Automation runbook associated with this execution.
The
* command specifies the ApplyOnlyAtCronInterval
* parameter, which means that the association doesn't run immediately
* after it is created, but only according to the specified schedule.
A key-value mapping of document parameters to target resources. Both Targets * and TargetMaps can't be specified together.
*/ inline const Aws::Vector