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::String &	GetAssociationId () const
bool	AssociationIdHasBeenSet () const
void	SetAssociationId (const Aws::String &value)
void	SetAssociationId (Aws::String &&value)
void	SetAssociationId (const char *value)
UpdateAssociationRequest &	WithAssociationId (const Aws::String &value)
UpdateAssociationRequest &	WithAssociationId (Aws::String &&value)
UpdateAssociationRequest &	WithAssociationId (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)
UpdateAssociationRequest &	WithParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
UpdateAssociationRequest &	WithParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
UpdateAssociationRequest &	AddParameters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
UpdateAssociationRequest &	AddParameters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
UpdateAssociationRequest &	AddParameters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
UpdateAssociationRequest &	AddParameters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
UpdateAssociationRequest &	AddParameters (const char *key, Aws::Vector< Aws::String > &&value)
UpdateAssociationRequest &	AddParameters (const char *key, const Aws::Vector< Aws::String > &value)
const Aws::String &	GetDocumentVersion () const
bool	DocumentVersionHasBeenSet () const
void	SetDocumentVersion (const Aws::String &value)
void	SetDocumentVersion (Aws::String &&value)
void	SetDocumentVersion (const char *value)
UpdateAssociationRequest &	WithDocumentVersion (const Aws::String &value)
UpdateAssociationRequest &	WithDocumentVersion (Aws::String &&value)
UpdateAssociationRequest &	WithDocumentVersion (const char *value)
const Aws::String &	GetScheduleExpression () const
bool	ScheduleExpressionHasBeenSet () const
void	SetScheduleExpression (const Aws::String &value)
void	SetScheduleExpression (Aws::String &&value)
void	SetScheduleExpression (const char *value)
UpdateAssociationRequest &	WithScheduleExpression (const Aws::String &value)
UpdateAssociationRequest &	WithScheduleExpression (Aws::String &&value)
UpdateAssociationRequest &	WithScheduleExpression (const char *value)
const InstanceAssociationOutputLocation &	GetOutputLocation () const
bool	OutputLocationHasBeenSet () const
void	SetOutputLocation (const InstanceAssociationOutputLocation &value)
void	SetOutputLocation (InstanceAssociationOutputLocation &&value)
UpdateAssociationRequest &	WithOutputLocation (const InstanceAssociationOutputLocation &value)
UpdateAssociationRequest &	WithOutputLocation (InstanceAssociationOutputLocation &&value)
const Aws::String &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const Aws::String &value)
void	SetName (Aws::String &&value)
void	SetName (const char *value)
UpdateAssociationRequest &	WithName (const Aws::String &value)
UpdateAssociationRequest &	WithName (Aws::String &&value)
UpdateAssociationRequest &	WithName (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)
UpdateAssociationRequest &	WithTargets (const Aws::Vector< Target > &value)
UpdateAssociationRequest &	WithTargets (Aws::Vector< Target > &&value)
UpdateAssociationRequest &	AddTargets (const Target &value)
UpdateAssociationRequest &	AddTargets (Target &&value)
const Aws::String &	GetAssociationName () const
bool	AssociationNameHasBeenSet () const
void	SetAssociationName (const Aws::String &value)
void	SetAssociationName (Aws::String &&value)
void	SetAssociationName (const char *value)
UpdateAssociationRequest &	WithAssociationName (const Aws::String &value)
UpdateAssociationRequest &	WithAssociationName (Aws::String &&value)
UpdateAssociationRequest &	WithAssociationName (const char *value)
const Aws::String &	GetAssociationVersion () const
bool	AssociationVersionHasBeenSet () const
void	SetAssociationVersion (const Aws::String &value)
void	SetAssociationVersion (Aws::String &&value)
void	SetAssociationVersion (const char *value)
UpdateAssociationRequest &	WithAssociationVersion (const Aws::String &value)
UpdateAssociationRequest &	WithAssociationVersion (Aws::String &&value)
UpdateAssociationRequest &	WithAssociationVersion (const char *value)
const Aws::String &	GetAutomationTargetParameterName () const
bool	AutomationTargetParameterNameHasBeenSet () const
void	SetAutomationTargetParameterName (const Aws::String &value)
void	SetAutomationTargetParameterName (Aws::String &&value)
void	SetAutomationTargetParameterName (const char *value)
UpdateAssociationRequest &	WithAutomationTargetParameterName (const Aws::String &value)
UpdateAssociationRequest &	WithAutomationTargetParameterName (Aws::String &&value)
UpdateAssociationRequest &	WithAutomationTargetParameterName (const char *value)
const Aws::String &	GetMaxErrors () const
bool	MaxErrorsHasBeenSet () const
void	SetMaxErrors (const Aws::String &value)
void	SetMaxErrors (Aws::String &&value)
void	SetMaxErrors (const char *value)
UpdateAssociationRequest &	WithMaxErrors (const Aws::String &value)
UpdateAssociationRequest &	WithMaxErrors (Aws::String &&value)
UpdateAssociationRequest &	WithMaxErrors (const char *value)
const Aws::String &	GetMaxConcurrency () const
bool	MaxConcurrencyHasBeenSet () const
void	SetMaxConcurrency (const Aws::String &value)
void	SetMaxConcurrency (Aws::String &&value)
void	SetMaxConcurrency (const char *value)
UpdateAssociationRequest &	WithMaxConcurrency (const Aws::String &value)
UpdateAssociationRequest &	WithMaxConcurrency (Aws::String &&value)
UpdateAssociationRequest &	WithMaxConcurrency (const char *value)
const AssociationComplianceSeverity &	GetComplianceSeverity () const
bool	ComplianceSeverityHasBeenSet () const
void	SetComplianceSeverity (const AssociationComplianceSeverity &value)
void	SetComplianceSeverity (AssociationComplianceSeverity &&value)
UpdateAssociationRequest &	WithComplianceSeverity (const AssociationComplianceSeverity &value)
UpdateAssociationRequest &	WithComplianceSeverity (AssociationComplianceSeverity &&value)
const AssociationSyncCompliance &	GetSyncCompliance () const
bool	SyncComplianceHasBeenSet () const
void	SetSyncCompliance (const AssociationSyncCompliance &value)
void	SetSyncCompliance (AssociationSyncCompliance &&value)
UpdateAssociationRequest &	WithSyncCompliance (const AssociationSyncCompliance &value)
UpdateAssociationRequest &	WithSyncCompliance (AssociationSyncCompliance &&value)
bool	GetApplyOnlyAtCronInterval () const
bool	ApplyOnlyAtCronIntervalHasBeenSet () const
void	SetApplyOnlyAtCronInterval (bool value)
UpdateAssociationRequest &	WithApplyOnlyAtCronInterval (bool 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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 27 of file UpdateAssociationRequest.h.

Constructor & Destructor Documentation

UpdateAssociationRequest()

Aws::SSM::Model::UpdateAssociationRequest::UpdateAssociationRequest

(

)

Member Function Documentation

AddParameters() [1/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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 131 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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 138 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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 145 of file UpdateAssociationRequest.h.

AddParameters() [4/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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 152 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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 159 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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 166 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 452 of file UpdateAssociationRequest.h.

AddTargets() [2/2]

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

inline

The targets of the association.

Definition at line 457 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.

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 993 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 51 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 468 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 515 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 document and target resources by using rate controls.

Definition at line 578 of file UpdateAssociationRequest.h.

ComplianceSeverityHasBeenSet()

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

inline

The severity level to assign to the association.

Definition at line 857 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 177 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.

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 981 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 46 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 463 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 507 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 document and target resources by using rate controls.

Definition at line 571 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 852 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 172 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 762 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 637 of file UpdateAssociationRequest.h.

GetName()

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

inline

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 304 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 262 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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 89 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 214 of file UpdateAssociationRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

Definition at line 893 of file UpdateAssociationRequest.h.

GetTargets()

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

inline

The targets of the association.

Definition at line 422 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 774 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 653 of file UpdateAssociationRequest.h.

NameHasBeenSet()

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

inline

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 320 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 267 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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 96 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 220 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.

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 1005 of file UpdateAssociationRequest.h.

SetAssociationId() [1/3]

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

inline

The ID of the association you want to update.

Definition at line 56 of file UpdateAssociationRequest.h.

SetAssociationId() [2/3]

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

inline

The ID of the association you want to update.

Definition at line 61 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 66 of file UpdateAssociationRequest.h.

SetAssociationName() [1/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 473 of file UpdateAssociationRequest.h.

SetAssociationName() [2/3]

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

inline

The name of the association that you want to update.

Definition at line 478 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 483 of file UpdateAssociationRequest.h.

SetAssociationVersion() [1/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 523 of file UpdateAssociationRequest.h.

SetAssociationVersion() [2/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 531 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 539 of file UpdateAssociationRequest.h.

SetAutomationTargetParameterName() [1/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 document and target resources by using rate controls.

Definition at line 585 of file UpdateAssociationRequest.h.

SetAutomationTargetParameterName() [2/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 document and target resources by using rate controls.

Definition at line 592 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 document and target resources by using rate controls.

Definition at line 599 of file UpdateAssociationRequest.h.

SetComplianceSeverity() [1/2]

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

inline

The severity level to assign to the association.

Definition at line 862 of file UpdateAssociationRequest.h.

SetComplianceSeverity() [2/2]

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

inline

The severity level to assign to the association.

Definition at line 867 of file UpdateAssociationRequest.h.

SetDocumentVersion() [1/3]

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

inline

The document version you want update for the association.

Definition at line 182 of file UpdateAssociationRequest.h.

SetDocumentVersion() [2/3]

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

inline

The document version you want update for the association.

Definition at line 187 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 192 of file UpdateAssociationRequest.h.

SetMaxConcurrency() [1/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 786 of file UpdateAssociationRequest.h.

SetMaxConcurrency() [2/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 798 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 810 of file UpdateAssociationRequest.h.

SetMaxErrors() [1/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 669 of file UpdateAssociationRequest.h.

SetMaxErrors() [2/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 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 701 of file UpdateAssociationRequest.h.

SetName() [1/3]

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

inline

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 336 of file UpdateAssociationRequest.h.

SetName() [2/3]

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

inline

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 352 of file UpdateAssociationRequest.h.

SetName() [3/3]

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

inline

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 368 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 272 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 277 of file UpdateAssociationRequest.h.

SetParameters() [1/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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 103 of file UpdateAssociationRequest.h.

SetParameters() [2/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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 110 of file UpdateAssociationRequest.h.

SetScheduleExpression() [1/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 226 of file UpdateAssociationRequest.h.

SetScheduleExpression() [2/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 232 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 238 of file UpdateAssociationRequest.h.

SetSyncCompliance() [1/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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

Definition at line 923 of file UpdateAssociationRequest.h.

SetSyncCompliance() [2/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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

Definition at line 938 of file UpdateAssociationRequest.h.

SetTargets() [1/2]

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

inline

The targets of the association.

Definition at line 432 of file UpdateAssociationRequest.h.

SetTargets() [2/2]

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

inline

The targets of the association.

Definition at line 437 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

Definition at line 908 of file UpdateAssociationRequest.h.

TargetsHasBeenSet()

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

inline

The targets of the association.

Definition at line 427 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.

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 1017 of file UpdateAssociationRequest.h.

WithAssociationId() [1/3]

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

inline

The ID of the association you want to update.

Definition at line 71 of file UpdateAssociationRequest.h.

WithAssociationId() [2/3]

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

inline

The ID of the association you want to update.

Definition at line 76 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 81 of file UpdateAssociationRequest.h.

WithAssociationName() [1/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 488 of file UpdateAssociationRequest.h.

WithAssociationName() [2/3]

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

inline

The name of the association that you want to update.

Definition at line 493 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 498 of file UpdateAssociationRequest.h.

WithAssociationVersion() [1/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 547 of file UpdateAssociationRequest.h.

WithAssociationVersion() [2/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 555 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 563 of file UpdateAssociationRequest.h.

WithAutomationTargetParameterName() [1/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 document and target resources by using rate controls.

Definition at line 606 of file UpdateAssociationRequest.h.

WithAutomationTargetParameterName() [2/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 document and target resources by using rate controls.

Definition at line 613 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 document and target resources by using rate controls.

Definition at line 620 of file UpdateAssociationRequest.h.

WithComplianceSeverity() [1/2]

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

inline

The severity level to assign to the association.

Definition at line 872 of file UpdateAssociationRequest.h.

WithComplianceSeverity() [2/2]

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

inline

The severity level to assign to the association.

Definition at line 877 of file UpdateAssociationRequest.h.

WithDocumentVersion() [1/3]

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

inline

The document version you want update for the association.

Definition at line 197 of file UpdateAssociationRequest.h.

WithDocumentVersion() [2/3]

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

inline

The document version you want update for the association.

Definition at line 202 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 207 of file UpdateAssociationRequest.h.

WithMaxConcurrency() [1/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 822 of file UpdateAssociationRequest.h.

WithMaxConcurrency() [2/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 834 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 846 of file UpdateAssociationRequest.h.

WithMaxErrors() [1/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 717 of file UpdateAssociationRequest.h.

WithMaxErrors() [2/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 733 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 749 of file UpdateAssociationRequest.h.

WithName() [1/3]

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

inline

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 384 of file UpdateAssociationRequest.h.

WithName() [2/3]

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

inline

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 400 of file UpdateAssociationRequest.h.

WithName() [3/3]

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

inline

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 416 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 282 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 287 of file UpdateAssociationRequest.h.

WithParameters() [1/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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 117 of file UpdateAssociationRequest.h.

WithParameters() [2/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, you can reference the parameter using {{ssm:parameter-name}}

Definition at line 124 of file UpdateAssociationRequest.h.

WithScheduleExpression() [1/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 244 of file UpdateAssociationRequest.h.

WithScheduleExpression() [2/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 250 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 256 of file UpdateAssociationRequest.h.

WithSyncCompliance() [1/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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

Definition at line 953 of file UpdateAssociationRequest.h.

WithSyncCompliance() [2/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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

Definition at line 968 of file UpdateAssociationRequest.h.

WithTargets() [1/2]

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

inline

The targets of the association.

Definition at line 442 of file UpdateAssociationRequest.h.

WithTargets() [2/2]

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

inline

The targets of the association.

Definition at line 447 of file UpdateAssociationRequest.h.

---

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

• aws-cpp-sdk-ssm/include/aws/ssm/model/UpdateAssociationRequest.h