AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::UpdateAssociationRequest Class Reference

#include <UpdateAssociationRequest.h>

+ Inheritance diagram for Aws::SSM::Model::UpdateAssociationRequest:

Public Member Functions

 UpdateAssociationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAssociationId () const
 
bool AssociationIdHasBeenSet () const
 
void SetAssociationId (const Aws::String &value)
 
void SetAssociationId (Aws::String &&value)
 
void SetAssociationId (const char *value)
 
UpdateAssociationRequestWithAssociationId (const Aws::String &value)
 
UpdateAssociationRequestWithAssociationId (Aws::String &&value)
 
UpdateAssociationRequestWithAssociationId (const char *value)
 
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
void SetParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
UpdateAssociationRequestWithParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
UpdateAssociationRequestWithParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
UpdateAssociationRequestAddParameters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
UpdateAssociationRequestAddParameters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
UpdateAssociationRequestAddParameters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
UpdateAssociationRequestAddParameters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
UpdateAssociationRequestAddParameters (const char *key, Aws::Vector< Aws::String > &&value)
 
UpdateAssociationRequestAddParameters (const char *key, const Aws::Vector< Aws::String > &value)
 
const Aws::StringGetDocumentVersion () const
 
bool DocumentVersionHasBeenSet () const
 
void SetDocumentVersion (const Aws::String &value)
 
void SetDocumentVersion (Aws::String &&value)
 
void SetDocumentVersion (const char *value)
 
UpdateAssociationRequestWithDocumentVersion (const Aws::String &value)
 
UpdateAssociationRequestWithDocumentVersion (Aws::String &&value)
 
UpdateAssociationRequestWithDocumentVersion (const char *value)
 
const Aws::StringGetScheduleExpression () const
 
bool ScheduleExpressionHasBeenSet () const
 
void SetScheduleExpression (const Aws::String &value)
 
void SetScheduleExpression (Aws::String &&value)
 
void SetScheduleExpression (const char *value)
 
UpdateAssociationRequestWithScheduleExpression (const Aws::String &value)
 
UpdateAssociationRequestWithScheduleExpression (Aws::String &&value)
 
UpdateAssociationRequestWithScheduleExpression (const char *value)
 
const InstanceAssociationOutputLocationGetOutputLocation () const
 
bool OutputLocationHasBeenSet () const
 
void SetOutputLocation (const InstanceAssociationOutputLocation &value)
 
void SetOutputLocation (InstanceAssociationOutputLocation &&value)
 
UpdateAssociationRequestWithOutputLocation (const InstanceAssociationOutputLocation &value)
 
UpdateAssociationRequestWithOutputLocation (InstanceAssociationOutputLocation &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateAssociationRequestWithName (const Aws::String &value)
 
UpdateAssociationRequestWithName (Aws::String &&value)
 
UpdateAssociationRequestWithName (const char *value)
 
const Aws::Vector< Target > & GetTargets () const
 
bool TargetsHasBeenSet () const
 
void SetTargets (const Aws::Vector< Target > &value)
 
void SetTargets (Aws::Vector< Target > &&value)
 
UpdateAssociationRequestWithTargets (const Aws::Vector< Target > &value)
 
UpdateAssociationRequestWithTargets (Aws::Vector< Target > &&value)
 
UpdateAssociationRequestAddTargets (const Target &value)
 
UpdateAssociationRequestAddTargets (Target &&value)
 
const Aws::StringGetAssociationName () const
 
bool AssociationNameHasBeenSet () const
 
void SetAssociationName (const Aws::String &value)
 
void SetAssociationName (Aws::String &&value)
 
void SetAssociationName (const char *value)
 
UpdateAssociationRequestWithAssociationName (const Aws::String &value)
 
UpdateAssociationRequestWithAssociationName (Aws::String &&value)
 
UpdateAssociationRequestWithAssociationName (const char *value)
 
const Aws::StringGetAssociationVersion () const
 
bool AssociationVersionHasBeenSet () const
 
void SetAssociationVersion (const Aws::String &value)
 
void SetAssociationVersion (Aws::String &&value)
 
void SetAssociationVersion (const char *value)
 
UpdateAssociationRequestWithAssociationVersion (const Aws::String &value)
 
UpdateAssociationRequestWithAssociationVersion (Aws::String &&value)
 
UpdateAssociationRequestWithAssociationVersion (const char *value)
 
const Aws::StringGetAutomationTargetParameterName () const
 
bool AutomationTargetParameterNameHasBeenSet () const
 
void SetAutomationTargetParameterName (const Aws::String &value)
 
void SetAutomationTargetParameterName (Aws::String &&value)
 
void SetAutomationTargetParameterName (const char *value)
 
UpdateAssociationRequestWithAutomationTargetParameterName (const Aws::String &value)
 
UpdateAssociationRequestWithAutomationTargetParameterName (Aws::String &&value)
 
UpdateAssociationRequestWithAutomationTargetParameterName (const char *value)
 
const Aws::StringGetMaxErrors () const
 
bool MaxErrorsHasBeenSet () const
 
void SetMaxErrors (const Aws::String &value)
 
void SetMaxErrors (Aws::String &&value)
 
void SetMaxErrors (const char *value)
 
UpdateAssociationRequestWithMaxErrors (const Aws::String &value)
 
UpdateAssociationRequestWithMaxErrors (Aws::String &&value)
 
UpdateAssociationRequestWithMaxErrors (const char *value)
 
const Aws::StringGetMaxConcurrency () const
 
bool MaxConcurrencyHasBeenSet () const
 
void SetMaxConcurrency (const Aws::String &value)
 
void SetMaxConcurrency (Aws::String &&value)
 
void SetMaxConcurrency (const char *value)
 
UpdateAssociationRequestWithMaxConcurrency (const Aws::String &value)
 
UpdateAssociationRequestWithMaxConcurrency (Aws::String &&value)
 
UpdateAssociationRequestWithMaxConcurrency (const char *value)
 
const AssociationComplianceSeverityGetComplianceSeverity () const
 
bool ComplianceSeverityHasBeenSet () const
 
void SetComplianceSeverity (const AssociationComplianceSeverity &value)
 
void SetComplianceSeverity (AssociationComplianceSeverity &&value)
 
UpdateAssociationRequestWithComplianceSeverity (const AssociationComplianceSeverity &value)
 
UpdateAssociationRequestWithComplianceSeverity (AssociationComplianceSeverity &&value)
 
const AssociationSyncComplianceGetSyncCompliance () const
 
bool SyncComplianceHasBeenSet () const
 
void SetSyncCompliance (const AssociationSyncCompliance &value)
 
void SetSyncCompliance (AssociationSyncCompliance &&value)
 
UpdateAssociationRequestWithSyncCompliance (const AssociationSyncCompliance &value)
 
UpdateAssociationRequestWithSyncCompliance (AssociationSyncCompliance &&value)
 
bool GetApplyOnlyAtCronInterval () const
 
bool ApplyOnlyAtCronIntervalHasBeenSet () const
 
void SetApplyOnlyAtCronInterval (bool value)
 
UpdateAssociationRequestWithApplyOnlyAtCronInterval (bool value)
 
const Aws::Vector< Aws::String > & GetCalendarNames () const
 
bool CalendarNamesHasBeenSet () const
 
void SetCalendarNames (const Aws::Vector< Aws::String > &value)
 
void SetCalendarNames (Aws::Vector< Aws::String > &&value)
 
UpdateAssociationRequestWithCalendarNames (const Aws::Vector< Aws::String > &value)
 
UpdateAssociationRequestWithCalendarNames (Aws::Vector< Aws::String > &&value)
 
UpdateAssociationRequestAddCalendarNames (const Aws::String &value)
 
UpdateAssociationRequestAddCalendarNames (Aws::String &&value)
 
UpdateAssociationRequestAddCalendarNames (const char *value)
 
const Aws::Vector< TargetLocation > & GetTargetLocations () const
 
bool TargetLocationsHasBeenSet () const
 
void SetTargetLocations (const Aws::Vector< TargetLocation > &value)
 
void SetTargetLocations (Aws::Vector< TargetLocation > &&value)
 
UpdateAssociationRequestWithTargetLocations (const Aws::Vector< TargetLocation > &value)
 
UpdateAssociationRequestWithTargetLocations (Aws::Vector< TargetLocation > &&value)
 
UpdateAssociationRequestAddTargetLocations (const TargetLocation &value)
 
UpdateAssociationRequestAddTargetLocations (TargetLocation &&value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 28 of file UpdateAssociationRequest.h.

Constructor & Destructor Documentation

◆ UpdateAssociationRequest()

Aws::SSM::Model::UpdateAssociationRequest::UpdateAssociationRequest ( )

Member Function Documentation

◆ AddCalendarNames() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddCalendarNames ( Aws::String &&  value)
inline

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.

Definition at line 1115 of file UpdateAssociationRequest.h.

◆ AddCalendarNames() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddCalendarNames ( const Aws::String value)
inline

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.

Definition at line 1106 of file UpdateAssociationRequest.h.

◆ AddCalendarNames() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddCalendarNames ( const char *  value)
inline

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.

Definition at line 1124 of file UpdateAssociationRequest.h.

◆ AddParameters() [1/6]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddParameters ( Aws::String &&  key,
Aws::Vector< Aws::String > &&  value 
)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 163 of file UpdateAssociationRequest.h.

◆ AddParameters() [2/6]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddParameters ( Aws::String &&  key,
const Aws::Vector< Aws::String > &  value 
)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 147 of file UpdateAssociationRequest.h.

◆ AddParameters() [3/6]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddParameters ( const Aws::String key,
Aws::Vector< Aws::String > &&  value 
)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 155 of file UpdateAssociationRequest.h.

◆ AddParameters() [4/6]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddParameters ( const Aws::String key,
const Aws::Vector< Aws::String > &  value 
)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 139 of file UpdateAssociationRequest.h.

◆ AddParameters() [5/6]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddParameters ( const char *  key,
Aws::Vector< Aws::String > &&  value 
)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 171 of file UpdateAssociationRequest.h.

◆ AddParameters() [6/6]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddParameters ( const char *  key,
const Aws::Vector< Aws::String > &  value 
)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 179 of file UpdateAssociationRequest.h.

◆ AddTargetLocations() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddTargetLocations ( const TargetLocation value)
inline

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 update an association in multiple Regions and multiple accounts.

Definition at line 1174 of file UpdateAssociationRequest.h.

◆ AddTargetLocations() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddTargetLocations ( TargetLocation &&  value)
inline

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 update an association in multiple Regions and multiple accounts.

Definition at line 1181 of file UpdateAssociationRequest.h.

◆ AddTargets() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddTargets ( const Target value)
inline

The targets of the association.

Definition at line 465 of file UpdateAssociationRequest.h.

◆ AddTargets() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::AddTargets ( Target &&  value)
inline

The targets of the association.

Definition at line 470 of file UpdateAssociationRequest.h.

◆ ApplyOnlyAtCronIntervalHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::ApplyOnlyAtCronIntervalHasBeenSet ( ) const
inline

By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.

Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

Definition at line 1016 of file UpdateAssociationRequest.h.

◆ AssociationIdHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::AssociationIdHasBeenSet ( ) const
inline

The ID of the association you want to update.

Definition at line 52 of file UpdateAssociationRequest.h.

◆ AssociationNameHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::AssociationNameHasBeenSet ( ) const
inline

The name of the association that you want to update.

Definition at line 481 of file UpdateAssociationRequest.h.

◆ AssociationVersionHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::AssociationVersionHasBeenSet ( ) const
inline

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Definition at line 528 of file UpdateAssociationRequest.h.

◆ AutomationTargetParameterNameHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::AutomationTargetParameterNameHasBeenSet ( ) const
inline

Specify 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.

Definition at line 591 of file UpdateAssociationRequest.h.

◆ CalendarNamesHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::CalendarNamesHasBeenSet ( ) const
inline

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.

Definition at line 1061 of file UpdateAssociationRequest.h.

◆ ComplianceSeverityHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::ComplianceSeverityHasBeenSet ( ) const
inline

The severity level to assign to the association.

Definition at line 878 of file UpdateAssociationRequest.h.

◆ DocumentVersionHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::DocumentVersionHasBeenSet ( ) const
inline

The document version you want update for the association.

Definition at line 190 of file UpdateAssociationRequest.h.

◆ GetApplyOnlyAtCronInterval()

bool Aws::SSM::Model::UpdateAssociationRequest::GetApplyOnlyAtCronInterval ( ) const
inline

By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.

Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

Definition at line 1003 of file UpdateAssociationRequest.h.

◆ GetAssociationId()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetAssociationId ( ) const
inline

The ID of the association you want to update.

Definition at line 47 of file UpdateAssociationRequest.h.

◆ GetAssociationName()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetAssociationName ( ) const
inline

The name of the association that you want to update.

Definition at line 476 of file UpdateAssociationRequest.h.

◆ GetAssociationVersion()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetAssociationVersion ( ) const
inline

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Definition at line 520 of file UpdateAssociationRequest.h.

◆ GetAutomationTargetParameterName()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetAutomationTargetParameterName ( ) const
inline

Specify 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.

Definition at line 584 of file UpdateAssociationRequest.h.

◆ GetCalendarNames()

const Aws::Vector<Aws::String>& Aws::SSM::Model::UpdateAssociationRequest::GetCalendarNames ( ) const
inline

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.

Definition at line 1052 of file UpdateAssociationRequest.h.

◆ GetComplianceSeverity()

const AssociationComplianceSeverity& Aws::SSM::Model::UpdateAssociationRequest::GetComplianceSeverity ( ) const
inline

The severity level to assign to the association.

Definition at line 873 of file UpdateAssociationRequest.h.

◆ GetDocumentVersion()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetDocumentVersion ( ) const
inline

The document version you want update for the association.

Definition at line 185 of file UpdateAssociationRequest.h.

◆ GetMaxConcurrency()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetMaxConcurrency ( ) const
inline

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Definition at line 783 of file UpdateAssociationRequest.h.

◆ GetMaxErrors()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetMaxErrors ( ) const
inline

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 instances 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.

Definition at line 651 of file UpdateAssociationRequest.h.

◆ GetName()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetName ( ) const
inline

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

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 document (SSM document) 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.

Definition at line 317 of file UpdateAssociationRequest.h.

◆ GetOutputLocation()

const InstanceAssociationOutputLocation& Aws::SSM::Model::UpdateAssociationRequest::GetOutputLocation ( ) const
inline

An S3 bucket where you want to store the results of this request.

Definition at line 275 of file UpdateAssociationRequest.h.

◆ GetParameters()

const Aws::Map<Aws::String, Aws::Vector<Aws::String> >& Aws::SSM::Model::UpdateAssociationRequest::GetParameters ( ) const
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 91 of file UpdateAssociationRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::UpdateAssociationRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

◆ GetScheduleExpression()

const Aws::String& Aws::SSM::Model::UpdateAssociationRequest::GetScheduleExpression ( ) const
inline

The cron expression used to schedule the association that you want to update.

Definition at line 227 of file UpdateAssociationRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SSM::Model::UpdateAssociationRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file UpdateAssociationRequest.h.

◆ GetSyncCompliance()

const AssociationSyncCompliance& Aws::SSM::Model::UpdateAssociationRequest::GetSyncCompliance ( ) const
inline

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.

Definition at line 914 of file UpdateAssociationRequest.h.

◆ GetTargetLocations()

const Aws::Vector<TargetLocation>& Aws::SSM::Model::UpdateAssociationRequest::GetTargetLocations ( ) const
inline

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 update an association in multiple Regions and multiple accounts.

Definition at line 1132 of file UpdateAssociationRequest.h.

◆ GetTargets()

const Aws::Vector<Target>& Aws::SSM::Model::UpdateAssociationRequest::GetTargets ( ) const
inline

The targets of the association.

Definition at line 435 of file UpdateAssociationRequest.h.

◆ MaxConcurrencyHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::MaxConcurrencyHasBeenSet ( ) const
inline

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Definition at line 795 of file UpdateAssociationRequest.h.

◆ MaxErrorsHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::MaxErrorsHasBeenSet ( ) const
inline

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 instances 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.

Definition at line 668 of file UpdateAssociationRequest.h.

◆ NameHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::NameHasBeenSet ( ) const
inline

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

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 document (SSM document) 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.

Definition at line 333 of file UpdateAssociationRequest.h.

◆ OutputLocationHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::OutputLocationHasBeenSet ( ) const
inline

An S3 bucket where you want to store the results of this request.

Definition at line 280 of file UpdateAssociationRequest.h.

◆ ParametersHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::ParametersHasBeenSet ( ) const
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 99 of file UpdateAssociationRequest.h.

◆ ScheduleExpressionHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::ScheduleExpressionHasBeenSet ( ) const
inline

The cron expression used to schedule the association that you want to update.

Definition at line 233 of file UpdateAssociationRequest.h.

◆ SerializePayload()

Aws::String Aws::SSM::Model::UpdateAssociationRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplyOnlyAtCronInterval()

void Aws::SSM::Model::UpdateAssociationRequest::SetApplyOnlyAtCronInterval ( bool  value)
inline

By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.

Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

Definition at line 1029 of file UpdateAssociationRequest.h.

◆ SetAssociationId() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationId ( Aws::String &&  value)
inline

The ID of the association you want to update.

Definition at line 62 of file UpdateAssociationRequest.h.

◆ SetAssociationId() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationId ( const Aws::String value)
inline

The ID of the association you want to update.

Definition at line 57 of file UpdateAssociationRequest.h.

◆ SetAssociationId() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationId ( const char *  value)
inline

The ID of the association you want to update.

Definition at line 67 of file UpdateAssociationRequest.h.

◆ SetAssociationName() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationName ( Aws::String &&  value)
inline

The name of the association that you want to update.

Definition at line 491 of file UpdateAssociationRequest.h.

◆ SetAssociationName() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationName ( const Aws::String value)
inline

The name of the association that you want to update.

Definition at line 486 of file UpdateAssociationRequest.h.

◆ SetAssociationName() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationName ( const char *  value)
inline

The name of the association that you want to update.

Definition at line 496 of file UpdateAssociationRequest.h.

◆ SetAssociationVersion() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationVersion ( Aws::String &&  value)
inline

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Definition at line 544 of file UpdateAssociationRequest.h.

◆ SetAssociationVersion() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationVersion ( const Aws::String value)
inline

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Definition at line 536 of file UpdateAssociationRequest.h.

◆ SetAssociationVersion() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAssociationVersion ( const char *  value)
inline

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Definition at line 552 of file UpdateAssociationRequest.h.

◆ SetAutomationTargetParameterName() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAutomationTargetParameterName ( Aws::String &&  value)
inline

Specify 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.

Definition at line 605 of file UpdateAssociationRequest.h.

◆ SetAutomationTargetParameterName() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAutomationTargetParameterName ( const Aws::String value)
inline

Specify 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.

Definition at line 598 of file UpdateAssociationRequest.h.

◆ SetAutomationTargetParameterName() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetAutomationTargetParameterName ( const char *  value)
inline

Specify 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.

Definition at line 612 of file UpdateAssociationRequest.h.

◆ SetCalendarNames() [1/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetCalendarNames ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 1079 of file UpdateAssociationRequest.h.

◆ SetCalendarNames() [2/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetCalendarNames ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 1070 of file UpdateAssociationRequest.h.

◆ SetComplianceSeverity() [1/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetComplianceSeverity ( AssociationComplianceSeverity &&  value)
inline

The severity level to assign to the association.

Definition at line 888 of file UpdateAssociationRequest.h.

◆ SetComplianceSeverity() [2/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetComplianceSeverity ( const AssociationComplianceSeverity value)
inline

The severity level to assign to the association.

Definition at line 883 of file UpdateAssociationRequest.h.

◆ SetDocumentVersion() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetDocumentVersion ( Aws::String &&  value)
inline

The document version you want update for the association.

Definition at line 200 of file UpdateAssociationRequest.h.

◆ SetDocumentVersion() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetDocumentVersion ( const Aws::String value)
inline

The document version you want update for the association.

Definition at line 195 of file UpdateAssociationRequest.h.

◆ SetDocumentVersion() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetDocumentVersion ( const char *  value)
inline

The document version you want update for the association.

Definition at line 205 of file UpdateAssociationRequest.h.

◆ SetMaxConcurrency() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetMaxConcurrency ( Aws::String &&  value)
inline

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Definition at line 819 of file UpdateAssociationRequest.h.

◆ SetMaxConcurrency() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetMaxConcurrency ( const Aws::String value)
inline

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Definition at line 807 of file UpdateAssociationRequest.h.

◆ SetMaxConcurrency() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetMaxConcurrency ( const char *  value)
inline

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Definition at line 831 of file UpdateAssociationRequest.h.

◆ SetMaxErrors() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetMaxErrors ( Aws::String &&  value)
inline

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 instances 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.

Definition at line 702 of file UpdateAssociationRequest.h.

◆ SetMaxErrors() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetMaxErrors ( const Aws::String value)
inline

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 instances 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.

Definition at line 685 of file UpdateAssociationRequest.h.

◆ SetMaxErrors() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetMaxErrors ( const char *  value)
inline

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 instances 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.

Definition at line 719 of file UpdateAssociationRequest.h.

◆ SetName() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetName ( Aws::String &&  value)
inline

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

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 document (SSM document) 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.

Definition at line 365 of file UpdateAssociationRequest.h.

◆ SetName() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetName ( const Aws::String value)
inline

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

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 document (SSM document) 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.

Definition at line 349 of file UpdateAssociationRequest.h.

◆ SetName() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetName ( const char *  value)
inline

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

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 document (SSM document) 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.

Definition at line 381 of file UpdateAssociationRequest.h.

◆ SetOutputLocation() [1/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetOutputLocation ( const InstanceAssociationOutputLocation value)
inline

An S3 bucket where you want to store the results of this request.

Definition at line 285 of file UpdateAssociationRequest.h.

◆ SetOutputLocation() [2/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetOutputLocation ( InstanceAssociationOutputLocation &&  value)
inline

An S3 bucket where you want to store the results of this request.

Definition at line 290 of file UpdateAssociationRequest.h.

◆ SetParameters() [1/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetParameters ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 115 of file UpdateAssociationRequest.h.

◆ SetParameters() [2/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetParameters ( const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &  value)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 107 of file UpdateAssociationRequest.h.

◆ SetScheduleExpression() [1/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetScheduleExpression ( Aws::String &&  value)
inline

The cron expression used to schedule the association that you want to update.

Definition at line 245 of file UpdateAssociationRequest.h.

◆ SetScheduleExpression() [2/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetScheduleExpression ( const Aws::String value)
inline

The cron expression used to schedule the association that you want to update.

Definition at line 239 of file UpdateAssociationRequest.h.

◆ SetScheduleExpression() [3/3]

void Aws::SSM::Model::UpdateAssociationRequest::SetScheduleExpression ( const char *  value)
inline

The cron expression used to schedule the association that you want to update.

Definition at line 251 of file UpdateAssociationRequest.h.

◆ SetSyncCompliance() [1/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetSyncCompliance ( AssociationSyncCompliance &&  value)
inline

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.

Definition at line 959 of file UpdateAssociationRequest.h.

◆ SetSyncCompliance() [2/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetSyncCompliance ( const AssociationSyncCompliance value)
inline

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.

Definition at line 944 of file UpdateAssociationRequest.h.

◆ SetTargetLocations() [1/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetTargetLocations ( Aws::Vector< TargetLocation > &&  value)
inline

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 update an association in multiple Regions and multiple accounts.

Definition at line 1153 of file UpdateAssociationRequest.h.

◆ SetTargetLocations() [2/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetTargetLocations ( const Aws::Vector< TargetLocation > &  value)
inline

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 update an association in multiple Regions and multiple accounts.

Definition at line 1146 of file UpdateAssociationRequest.h.

◆ SetTargets() [1/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetTargets ( Aws::Vector< Target > &&  value)
inline

The targets of the association.

Definition at line 450 of file UpdateAssociationRequest.h.

◆ SetTargets() [2/2]

void Aws::SSM::Model::UpdateAssociationRequest::SetTargets ( const Aws::Vector< Target > &  value)
inline

The targets of the association.

Definition at line 445 of file UpdateAssociationRequest.h.

◆ SyncComplianceHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::SyncComplianceHasBeenSet ( ) const
inline

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.

Definition at line 929 of file UpdateAssociationRequest.h.

◆ TargetLocationsHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::TargetLocationsHasBeenSet ( ) const
inline

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 update an association in multiple Regions and multiple accounts.

Definition at line 1139 of file UpdateAssociationRequest.h.

◆ TargetsHasBeenSet()

bool Aws::SSM::Model::UpdateAssociationRequest::TargetsHasBeenSet ( ) const
inline

The targets of the association.

Definition at line 440 of file UpdateAssociationRequest.h.

◆ WithApplyOnlyAtCronInterval()

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithApplyOnlyAtCronInterval ( bool  value)
inline

By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.

Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

Definition at line 1042 of file UpdateAssociationRequest.h.

◆ WithAssociationId() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationId ( Aws::String &&  value)
inline

The ID of the association you want to update.

Definition at line 77 of file UpdateAssociationRequest.h.

◆ WithAssociationId() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationId ( const Aws::String value)
inline

The ID of the association you want to update.

Definition at line 72 of file UpdateAssociationRequest.h.

◆ WithAssociationId() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationId ( const char *  value)
inline

The ID of the association you want to update.

Definition at line 82 of file UpdateAssociationRequest.h.

◆ WithAssociationName() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationName ( Aws::String &&  value)
inline

The name of the association that you want to update.

Definition at line 506 of file UpdateAssociationRequest.h.

◆ WithAssociationName() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationName ( const Aws::String value)
inline

The name of the association that you want to update.

Definition at line 501 of file UpdateAssociationRequest.h.

◆ WithAssociationName() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationName ( const char *  value)
inline

The name of the association that you want to update.

Definition at line 511 of file UpdateAssociationRequest.h.

◆ WithAssociationVersion() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationVersion ( Aws::String &&  value)
inline

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Definition at line 568 of file UpdateAssociationRequest.h.

◆ WithAssociationVersion() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationVersion ( const Aws::String value)
inline

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Definition at line 560 of file UpdateAssociationRequest.h.

◆ WithAssociationVersion() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAssociationVersion ( const char *  value)
inline

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Definition at line 576 of file UpdateAssociationRequest.h.

◆ WithAutomationTargetParameterName() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAutomationTargetParameterName ( Aws::String &&  value)
inline

Specify 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.

Definition at line 626 of file UpdateAssociationRequest.h.

◆ WithAutomationTargetParameterName() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAutomationTargetParameterName ( const Aws::String value)
inline

Specify 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.

Definition at line 619 of file UpdateAssociationRequest.h.

◆ WithAutomationTargetParameterName() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithAutomationTargetParameterName ( const char *  value)
inline

Specify 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.

Definition at line 633 of file UpdateAssociationRequest.h.

◆ WithCalendarNames() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithCalendarNames ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 1097 of file UpdateAssociationRequest.h.

◆ WithCalendarNames() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithCalendarNames ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 1088 of file UpdateAssociationRequest.h.

◆ WithComplianceSeverity() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithComplianceSeverity ( AssociationComplianceSeverity &&  value)
inline

The severity level to assign to the association.

Definition at line 898 of file UpdateAssociationRequest.h.

◆ WithComplianceSeverity() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithComplianceSeverity ( const AssociationComplianceSeverity value)
inline

The severity level to assign to the association.

Definition at line 893 of file UpdateAssociationRequest.h.

◆ WithDocumentVersion() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithDocumentVersion ( Aws::String &&  value)
inline

The document version you want update for the association.

Definition at line 215 of file UpdateAssociationRequest.h.

◆ WithDocumentVersion() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithDocumentVersion ( const Aws::String value)
inline

The document version you want update for the association.

Definition at line 210 of file UpdateAssociationRequest.h.

◆ WithDocumentVersion() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithDocumentVersion ( const char *  value)
inline

The document version you want update for the association.

Definition at line 220 of file UpdateAssociationRequest.h.

◆ WithMaxConcurrency() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithMaxConcurrency ( Aws::String &&  value)
inline

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Definition at line 855 of file UpdateAssociationRequest.h.

◆ WithMaxConcurrency() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithMaxConcurrency ( const Aws::String value)
inline

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Definition at line 843 of file UpdateAssociationRequest.h.

◆ WithMaxConcurrency() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithMaxConcurrency ( const char *  value)
inline

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Definition at line 867 of file UpdateAssociationRequest.h.

◆ WithMaxErrors() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithMaxErrors ( Aws::String &&  value)
inline

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 instances 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.

Definition at line 753 of file UpdateAssociationRequest.h.

◆ WithMaxErrors() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithMaxErrors ( const Aws::String value)
inline

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 instances 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.

Definition at line 736 of file UpdateAssociationRequest.h.

◆ WithMaxErrors() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithMaxErrors ( const char *  value)
inline

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 instances 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.

Definition at line 770 of file UpdateAssociationRequest.h.

◆ WithName() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithName ( Aws::String &&  value)
inline

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

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 document (SSM document) 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.

Definition at line 413 of file UpdateAssociationRequest.h.

◆ WithName() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithName ( const Aws::String value)
inline

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

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 document (SSM document) 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.

Definition at line 397 of file UpdateAssociationRequest.h.

◆ WithName() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithName ( const char *  value)
inline

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

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 document (SSM document) 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.

Definition at line 429 of file UpdateAssociationRequest.h.

◆ WithOutputLocation() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithOutputLocation ( const InstanceAssociationOutputLocation value)
inline

An S3 bucket where you want to store the results of this request.

Definition at line 295 of file UpdateAssociationRequest.h.

◆ WithOutputLocation() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithOutputLocation ( InstanceAssociationOutputLocation &&  value)
inline

An S3 bucket where you want to store the results of this request.

Definition at line 300 of file UpdateAssociationRequest.h.

◆ WithParameters() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithParameters ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 131 of file UpdateAssociationRequest.h.

◆ WithParameters() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithParameters ( const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &  value)
inline

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

Definition at line 123 of file UpdateAssociationRequest.h.

◆ WithScheduleExpression() [1/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithScheduleExpression ( Aws::String &&  value)
inline

The cron expression used to schedule the association that you want to update.

Definition at line 263 of file UpdateAssociationRequest.h.

◆ WithScheduleExpression() [2/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithScheduleExpression ( const Aws::String value)
inline

The cron expression used to schedule the association that you want to update.

Definition at line 257 of file UpdateAssociationRequest.h.

◆ WithScheduleExpression() [3/3]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithScheduleExpression ( const char *  value)
inline

The cron expression used to schedule the association that you want to update.

Definition at line 269 of file UpdateAssociationRequest.h.

◆ WithSyncCompliance() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithSyncCompliance ( AssociationSyncCompliance &&  value)
inline

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.

Definition at line 989 of file UpdateAssociationRequest.h.

◆ WithSyncCompliance() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithSyncCompliance ( const AssociationSyncCompliance value)
inline

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.

Definition at line 974 of file UpdateAssociationRequest.h.

◆ WithTargetLocations() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithTargetLocations ( Aws::Vector< TargetLocation > &&  value)
inline

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 update an association in multiple Regions and multiple accounts.

Definition at line 1167 of file UpdateAssociationRequest.h.

◆ WithTargetLocations() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithTargetLocations ( const Aws::Vector< TargetLocation > &  value)
inline

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 update an association in multiple Regions and multiple accounts.

Definition at line 1160 of file UpdateAssociationRequest.h.

◆ WithTargets() [1/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithTargets ( Aws::Vector< Target > &&  value)
inline

The targets of the association.

Definition at line 460 of file UpdateAssociationRequest.h.

◆ WithTargets() [2/2]

UpdateAssociationRequest& Aws::SSM::Model::UpdateAssociationRequest::WithTargets ( const Aws::Vector< Target > &  value)
inline

The targets of the association.

Definition at line 455 of file UpdateAssociationRequest.h.


The documentation for this class was generated from the following file: