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

#include <CreateAssociationRequest.h>

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

Public Member Functions

 CreateAssociationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateAssociationRequestWithName (const Aws::String &value)
 
CreateAssociationRequestWithName (Aws::String &&value)
 
CreateAssociationRequestWithName (const char *value)
 
const Aws::StringGetDocumentVersion () const
 
bool DocumentVersionHasBeenSet () const
 
void SetDocumentVersion (const Aws::String &value)
 
void SetDocumentVersion (Aws::String &&value)
 
void SetDocumentVersion (const char *value)
 
CreateAssociationRequestWithDocumentVersion (const Aws::String &value)
 
CreateAssociationRequestWithDocumentVersion (Aws::String &&value)
 
CreateAssociationRequestWithDocumentVersion (const char *value)
 
const Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
CreateAssociationRequestWithInstanceId (const Aws::String &value)
 
CreateAssociationRequestWithInstanceId (Aws::String &&value)
 
CreateAssociationRequestWithInstanceId (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)
 
CreateAssociationRequestWithParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
CreateAssociationRequestWithParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
CreateAssociationRequestAddParameters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
CreateAssociationRequestAddParameters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
CreateAssociationRequestAddParameters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
CreateAssociationRequestAddParameters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
CreateAssociationRequestAddParameters (const char *key, Aws::Vector< Aws::String > &&value)
 
CreateAssociationRequestAddParameters (const char *key, const Aws::Vector< Aws::String > &value)
 
const Aws::Vector< Target > & GetTargets () const
 
bool TargetsHasBeenSet () const
 
void SetTargets (const Aws::Vector< Target > &value)
 
void SetTargets (Aws::Vector< Target > &&value)
 
CreateAssociationRequestWithTargets (const Aws::Vector< Target > &value)
 
CreateAssociationRequestWithTargets (Aws::Vector< Target > &&value)
 
CreateAssociationRequestAddTargets (const Target &value)
 
CreateAssociationRequestAddTargets (Target &&value)
 
const Aws::StringGetScheduleExpression () const
 
bool ScheduleExpressionHasBeenSet () const
 
void SetScheduleExpression (const Aws::String &value)
 
void SetScheduleExpression (Aws::String &&value)
 
void SetScheduleExpression (const char *value)
 
CreateAssociationRequestWithScheduleExpression (const Aws::String &value)
 
CreateAssociationRequestWithScheduleExpression (Aws::String &&value)
 
CreateAssociationRequestWithScheduleExpression (const char *value)
 
const InstanceAssociationOutputLocationGetOutputLocation () const
 
bool OutputLocationHasBeenSet () const
 
void SetOutputLocation (const InstanceAssociationOutputLocation &value)
 
void SetOutputLocation (InstanceAssociationOutputLocation &&value)
 
CreateAssociationRequestWithOutputLocation (const InstanceAssociationOutputLocation &value)
 
CreateAssociationRequestWithOutputLocation (InstanceAssociationOutputLocation &&value)
 
const Aws::StringGetAssociationName () const
 
bool AssociationNameHasBeenSet () const
 
void SetAssociationName (const Aws::String &value)
 
void SetAssociationName (Aws::String &&value)
 
void SetAssociationName (const char *value)
 
CreateAssociationRequestWithAssociationName (const Aws::String &value)
 
CreateAssociationRequestWithAssociationName (Aws::String &&value)
 
CreateAssociationRequestWithAssociationName (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)
 
CreateAssociationRequestWithAutomationTargetParameterName (const Aws::String &value)
 
CreateAssociationRequestWithAutomationTargetParameterName (Aws::String &&value)
 
CreateAssociationRequestWithAutomationTargetParameterName (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)
 
CreateAssociationRequestWithMaxErrors (const Aws::String &value)
 
CreateAssociationRequestWithMaxErrors (Aws::String &&value)
 
CreateAssociationRequestWithMaxErrors (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)
 
CreateAssociationRequestWithMaxConcurrency (const Aws::String &value)
 
CreateAssociationRequestWithMaxConcurrency (Aws::String &&value)
 
CreateAssociationRequestWithMaxConcurrency (const char *value)
 
const AssociationComplianceSeverityGetComplianceSeverity () const
 
bool ComplianceSeverityHasBeenSet () const
 
void SetComplianceSeverity (const AssociationComplianceSeverity &value)
 
void SetComplianceSeverity (AssociationComplianceSeverity &&value)
 
CreateAssociationRequestWithComplianceSeverity (const AssociationComplianceSeverity &value)
 
CreateAssociationRequestWithComplianceSeverity (AssociationComplianceSeverity &&value)
 
const AssociationSyncComplianceGetSyncCompliance () const
 
bool SyncComplianceHasBeenSet () const
 
void SetSyncCompliance (const AssociationSyncCompliance &value)
 
void SetSyncCompliance (AssociationSyncCompliance &&value)
 
CreateAssociationRequestWithSyncCompliance (const AssociationSyncCompliance &value)
 
CreateAssociationRequestWithSyncCompliance (AssociationSyncCompliance &&value)
 
bool GetApplyOnlyAtCronInterval () const
 
bool ApplyOnlyAtCronIntervalHasBeenSet () const
 
void SetApplyOnlyAtCronInterval (bool value)
 
CreateAssociationRequestWithApplyOnlyAtCronInterval (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::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 27 of file CreateAssociationRequest.h.

Constructor & Destructor Documentation

◆ CreateAssociationRequest()

Aws::SSM::Model::CreateAssociationRequest::CreateAssociationRequest ( )

Member Function Documentation

◆ AddParameters() [1/6]

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

The parameters for the runtime configuration of the document.

Definition at line 359 of file CreateAssociationRequest.h.

◆ AddParameters() [2/6]

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

The parameters for the runtime configuration of the document.

Definition at line 364 of file CreateAssociationRequest.h.

◆ AddParameters() [3/6]

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

The parameters for the runtime configuration of the document.

Definition at line 369 of file CreateAssociationRequest.h.

◆ AddParameters() [4/6]

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

The parameters for the runtime configuration of the document.

Definition at line 374 of file CreateAssociationRequest.h.

◆ AddParameters() [5/6]

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

The parameters for the runtime configuration of the document.

Definition at line 379 of file CreateAssociationRequest.h.

◆ AddParameters() [6/6]

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

The parameters for the runtime configuration of the document.

Definition at line 384 of file CreateAssociationRequest.h.

◆ AddTargets() [1/2]

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

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Definition at line 455 of file CreateAssociationRequest.h.

◆ AddTargets() [2/2]

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

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Definition at line 465 of file CreateAssociationRequest.h.

◆ ApplyOnlyAtCronIntervalHasBeenSet()

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

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it.

Definition at line 1000 of file CreateAssociationRequest.h.

◆ AssociationNameHasBeenSet()

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

Specify a descriptive name for the association.

Definition at line 548 of file CreateAssociationRequest.h.

◆ AutomationTargetParameterNameHasBeenSet()

bool Aws::SSM::Model::CreateAssociationRequest::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 593 of file CreateAssociationRequest.h.

◆ ComplianceSeverityHasBeenSet()

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

The severity level to assign to the association.

Definition at line 872 of file CreateAssociationRequest.h.

◆ DocumentVersionHasBeenSet()

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

The document version you want to associate with the target(s). Can be a specific version or the default version.

Definition at line 182 of file CreateAssociationRequest.h.

◆ GetApplyOnlyAtCronInterval()

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

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it.

Definition at line 992 of file CreateAssociationRequest.h.

◆ GetAssociationName()

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

Specify a descriptive name for the association.

Definition at line 543 of file CreateAssociationRequest.h.

◆ GetAutomationTargetParameterName()

const Aws::String& Aws::SSM::Model::CreateAssociationRequest::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 586 of file CreateAssociationRequest.h.

◆ GetComplianceSeverity()

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

The severity level to assign to the association.

Definition at line 867 of file CreateAssociationRequest.h.

◆ GetDocumentVersion()

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

The document version you want to associate with the target(s). Can be a specific version or the default version.

Definition at line 176 of file CreateAssociationRequest.h.

◆ GetInstanceId()

const Aws::String& Aws::SSM::Model::CreateAssociationRequest::GetInstanceId ( ) const
inline

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Definition at line 232 of file CreateAssociationRequest.h.

◆ GetMaxConcurrency()

const Aws::String& Aws::SSM::Model::CreateAssociationRequest::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 777 of file CreateAssociationRequest.h.

◆ GetMaxErrors()

const Aws::String& Aws::SSM::Model::CreateAssociationRequest::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 652 of file CreateAssociationRequest.h.

◆ GetName()

const Aws::String& Aws::SSM::Model::CreateAssociationRequest::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:partition: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 57 of file CreateAssociationRequest.h.

◆ GetOutputLocation()

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

An S3 bucket where you want to store the output details of the request.

Definition at line 512 of file CreateAssociationRequest.h.

◆ GetParameters()

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

The parameters for the runtime configuration of the document.

Definition at line 329 of file CreateAssociationRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetScheduleExpression()

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

A cron expression when the association will be applied to the target(s).

Definition at line 471 of file CreateAssociationRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateAssociationRequest.h.

◆ GetSyncCompliance()

const AssociationSyncCompliance& Aws::SSM::Model::CreateAssociationRequest::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 908 of file CreateAssociationRequest.h.

◆ GetTargets()

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

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Definition at line 395 of file CreateAssociationRequest.h.

◆ InstanceIdHasBeenSet()

bool Aws::SSM::Model::CreateAssociationRequest::InstanceIdHasBeenSet ( ) const
inline

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Definition at line 245 of file CreateAssociationRequest.h.

◆ MaxConcurrencyHasBeenSet()

bool Aws::SSM::Model::CreateAssociationRequest::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 789 of file CreateAssociationRequest.h.

◆ MaxErrorsHasBeenSet()

bool Aws::SSM::Model::CreateAssociationRequest::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 CreateAssociationRequest.h.

◆ NameHasBeenSet()

bool Aws::SSM::Model::CreateAssociationRequest::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:partition: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 73 of file CreateAssociationRequest.h.

◆ OutputLocationHasBeenSet()

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

An S3 bucket where you want to store the output details of the request.

Definition at line 517 of file CreateAssociationRequest.h.

◆ ParametersHasBeenSet()

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

The parameters for the runtime configuration of the document.

Definition at line 334 of file CreateAssociationRequest.h.

◆ ScheduleExpressionHasBeenSet()

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

A cron expression when the association will be applied to the target(s).

Definition at line 476 of file CreateAssociationRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplyOnlyAtCronInterval()

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

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it.

Definition at line 1008 of file CreateAssociationRequest.h.

◆ SetAssociationName() [1/3]

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

Specify a descriptive name for the association.

Definition at line 553 of file CreateAssociationRequest.h.

◆ SetAssociationName() [2/3]

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

Specify a descriptive name for the association.

Definition at line 558 of file CreateAssociationRequest.h.

◆ SetAssociationName() [3/3]

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

Specify a descriptive name for the association.

Definition at line 563 of file CreateAssociationRequest.h.

◆ SetAutomationTargetParameterName() [1/3]

void Aws::SSM::Model::CreateAssociationRequest::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 600 of file CreateAssociationRequest.h.

◆ SetAutomationTargetParameterName() [2/3]

void Aws::SSM::Model::CreateAssociationRequest::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 607 of file CreateAssociationRequest.h.

◆ SetAutomationTargetParameterName() [3/3]

void Aws::SSM::Model::CreateAssociationRequest::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 614 of file CreateAssociationRequest.h.

◆ SetComplianceSeverity() [1/2]

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

The severity level to assign to the association.

Definition at line 877 of file CreateAssociationRequest.h.

◆ SetComplianceSeverity() [2/2]

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

The severity level to assign to the association.

Definition at line 882 of file CreateAssociationRequest.h.

◆ SetDocumentVersion() [1/3]

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

The document version you want to associate with the target(s). Can be a specific version or the default version.

Definition at line 188 of file CreateAssociationRequest.h.

◆ SetDocumentVersion() [2/3]

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

The document version you want to associate with the target(s). Can be a specific version or the default version.

Definition at line 194 of file CreateAssociationRequest.h.

◆ SetDocumentVersion() [3/3]

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

The document version you want to associate with the target(s). Can be a specific version or the default version.

Definition at line 200 of file CreateAssociationRequest.h.

◆ SetInstanceId() [1/3]

void Aws::SSM::Model::CreateAssociationRequest::SetInstanceId ( const Aws::String value)
inline

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Definition at line 258 of file CreateAssociationRequest.h.

◆ SetInstanceId() [2/3]

void Aws::SSM::Model::CreateAssociationRequest::SetInstanceId ( Aws::String &&  value)
inline

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Definition at line 271 of file CreateAssociationRequest.h.

◆ SetInstanceId() [3/3]

void Aws::SSM::Model::CreateAssociationRequest::SetInstanceId ( const char *  value)
inline

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Definition at line 284 of file CreateAssociationRequest.h.

◆ SetMaxConcurrency() [1/3]

void Aws::SSM::Model::CreateAssociationRequest::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 801 of file CreateAssociationRequest.h.

◆ SetMaxConcurrency() [2/3]

void Aws::SSM::Model::CreateAssociationRequest::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 813 of file CreateAssociationRequest.h.

◆ SetMaxConcurrency() [3/3]

void Aws::SSM::Model::CreateAssociationRequest::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 825 of file CreateAssociationRequest.h.

◆ SetMaxErrors() [1/3]

void Aws::SSM::Model::CreateAssociationRequest::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 684 of file CreateAssociationRequest.h.

◆ SetMaxErrors() [2/3]

void Aws::SSM::Model::CreateAssociationRequest::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 700 of file CreateAssociationRequest.h.

◆ SetMaxErrors() [3/3]

void Aws::SSM::Model::CreateAssociationRequest::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 716 of file CreateAssociationRequest.h.

◆ SetName() [1/3]

void Aws::SSM::Model::CreateAssociationRequest::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:partition: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 89 of file CreateAssociationRequest.h.

◆ SetName() [2/3]

void Aws::SSM::Model::CreateAssociationRequest::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:partition: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 105 of file CreateAssociationRequest.h.

◆ SetName() [3/3]

void Aws::SSM::Model::CreateAssociationRequest::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:partition: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 121 of file CreateAssociationRequest.h.

◆ SetOutputLocation() [1/2]

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

An S3 bucket where you want to store the output details of the request.

Definition at line 522 of file CreateAssociationRequest.h.

◆ SetOutputLocation() [2/2]

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

An S3 bucket where you want to store the output details of the request.

Definition at line 527 of file CreateAssociationRequest.h.

◆ SetParameters() [1/2]

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

The parameters for the runtime configuration of the document.

Definition at line 339 of file CreateAssociationRequest.h.

◆ SetParameters() [2/2]

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

The parameters for the runtime configuration of the document.

Definition at line 344 of file CreateAssociationRequest.h.

◆ SetScheduleExpression() [1/3]

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

A cron expression when the association will be applied to the target(s).

Definition at line 481 of file CreateAssociationRequest.h.

◆ SetScheduleExpression() [2/3]

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

A cron expression when the association will be applied to the target(s).

Definition at line 486 of file CreateAssociationRequest.h.

◆ SetScheduleExpression() [3/3]

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

A cron expression when the association will be applied to the target(s).

Definition at line 491 of file CreateAssociationRequest.h.

◆ SetSyncCompliance() [1/2]

void Aws::SSM::Model::CreateAssociationRequest::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 938 of file CreateAssociationRequest.h.

◆ SetSyncCompliance() [2/2]

void Aws::SSM::Model::CreateAssociationRequest::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 953 of file CreateAssociationRequest.h.

◆ SetTargets() [1/2]

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

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Definition at line 415 of file CreateAssociationRequest.h.

◆ SetTargets() [2/2]

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

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Definition at line 425 of file CreateAssociationRequest.h.

◆ SyncComplianceHasBeenSet()

bool Aws::SSM::Model::CreateAssociationRequest::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 923 of file CreateAssociationRequest.h.

◆ TargetsHasBeenSet()

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

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Definition at line 405 of file CreateAssociationRequest.h.

◆ WithApplyOnlyAtCronInterval()

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

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it.

Definition at line 1016 of file CreateAssociationRequest.h.

◆ WithAssociationName() [1/3]

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

Specify a descriptive name for the association.

Definition at line 568 of file CreateAssociationRequest.h.

◆ WithAssociationName() [2/3]

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

Specify a descriptive name for the association.

Definition at line 573 of file CreateAssociationRequest.h.

◆ WithAssociationName() [3/3]

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

Specify a descriptive name for the association.

Definition at line 578 of file CreateAssociationRequest.h.

◆ WithAutomationTargetParameterName() [1/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 621 of file CreateAssociationRequest.h.

◆ WithAutomationTargetParameterName() [2/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 628 of file CreateAssociationRequest.h.

◆ WithAutomationTargetParameterName() [3/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 635 of file CreateAssociationRequest.h.

◆ WithComplianceSeverity() [1/2]

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

The severity level to assign to the association.

Definition at line 887 of file CreateAssociationRequest.h.

◆ WithComplianceSeverity() [2/2]

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

The severity level to assign to the association.

Definition at line 892 of file CreateAssociationRequest.h.

◆ WithDocumentVersion() [1/3]

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

The document version you want to associate with the target(s). Can be a specific version or the default version.

Definition at line 206 of file CreateAssociationRequest.h.

◆ WithDocumentVersion() [2/3]

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

The document version you want to associate with the target(s). Can be a specific version or the default version.

Definition at line 212 of file CreateAssociationRequest.h.

◆ WithDocumentVersion() [3/3]

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

The document version you want to associate with the target(s). Can be a specific version or the default version.

Definition at line 218 of file CreateAssociationRequest.h.

◆ WithInstanceId() [1/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::WithInstanceId ( const Aws::String value)
inline

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Definition at line 297 of file CreateAssociationRequest.h.

◆ WithInstanceId() [2/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::WithInstanceId ( Aws::String &&  value)
inline

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Definition at line 310 of file CreateAssociationRequest.h.

◆ WithInstanceId() [3/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::WithInstanceId ( const char *  value)
inline

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Definition at line 323 of file CreateAssociationRequest.h.

◆ WithMaxConcurrency() [1/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 837 of file CreateAssociationRequest.h.

◆ WithMaxConcurrency() [2/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 849 of file CreateAssociationRequest.h.

◆ WithMaxConcurrency() [3/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 861 of file CreateAssociationRequest.h.

◆ WithMaxErrors() [1/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 732 of file CreateAssociationRequest.h.

◆ WithMaxErrors() [2/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 748 of file CreateAssociationRequest.h.

◆ WithMaxErrors() [3/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 764 of file CreateAssociationRequest.h.

◆ WithName() [1/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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:partition: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 137 of file CreateAssociationRequest.h.

◆ WithName() [2/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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:partition: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 153 of file CreateAssociationRequest.h.

◆ WithName() [3/3]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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:partition: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 169 of file CreateAssociationRequest.h.

◆ WithOutputLocation() [1/2]

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

An S3 bucket where you want to store the output details of the request.

Definition at line 532 of file CreateAssociationRequest.h.

◆ WithOutputLocation() [2/2]

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

An S3 bucket where you want to store the output details of the request.

Definition at line 537 of file CreateAssociationRequest.h.

◆ WithParameters() [1/2]

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

The parameters for the runtime configuration of the document.

Definition at line 349 of file CreateAssociationRequest.h.

◆ WithParameters() [2/2]

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

The parameters for the runtime configuration of the document.

Definition at line 354 of file CreateAssociationRequest.h.

◆ WithScheduleExpression() [1/3]

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

A cron expression when the association will be applied to the target(s).

Definition at line 496 of file CreateAssociationRequest.h.

◆ WithScheduleExpression() [2/3]

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

A cron expression when the association will be applied to the target(s).

Definition at line 501 of file CreateAssociationRequest.h.

◆ WithScheduleExpression() [3/3]

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

A cron expression when the association will be applied to the target(s).

Definition at line 506 of file CreateAssociationRequest.h.

◆ WithSyncCompliance() [1/2]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 968 of file CreateAssociationRequest.h.

◆ WithSyncCompliance() [2/2]

CreateAssociationRequest& Aws::SSM::Model::CreateAssociationRequest::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 983 of file CreateAssociationRequest.h.

◆ WithTargets() [1/2]

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

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Definition at line 435 of file CreateAssociationRequest.h.

◆ WithTargets() [2/2]

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

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Definition at line 445 of file CreateAssociationRequest.h.


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