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

#include <UpdateMaintenanceWindowTaskRequest.h>

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

Public Member Functions

 UpdateMaintenanceWindowTaskRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetWindowId () const
 
bool WindowIdHasBeenSet () const
 
void SetWindowId (const Aws::String &value)
 
void SetWindowId (Aws::String &&value)
 
void SetWindowId (const char *value)
 
UpdateMaintenanceWindowTaskRequestWithWindowId (const Aws::String &value)
 
UpdateMaintenanceWindowTaskRequestWithWindowId (Aws::String &&value)
 
UpdateMaintenanceWindowTaskRequestWithWindowId (const char *value)
 
const Aws::StringGetWindowTaskId () const
 
bool WindowTaskIdHasBeenSet () const
 
void SetWindowTaskId (const Aws::String &value)
 
void SetWindowTaskId (Aws::String &&value)
 
void SetWindowTaskId (const char *value)
 
UpdateMaintenanceWindowTaskRequestWithWindowTaskId (const Aws::String &value)
 
UpdateMaintenanceWindowTaskRequestWithWindowTaskId (Aws::String &&value)
 
UpdateMaintenanceWindowTaskRequestWithWindowTaskId (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)
 
UpdateMaintenanceWindowTaskRequestWithTargets (const Aws::Vector< Target > &value)
 
UpdateMaintenanceWindowTaskRequestWithTargets (Aws::Vector< Target > &&value)
 
UpdateMaintenanceWindowTaskRequestAddTargets (const Target &value)
 
UpdateMaintenanceWindowTaskRequestAddTargets (Target &&value)
 
const Aws::StringGetTaskArn () const
 
bool TaskArnHasBeenSet () const
 
void SetTaskArn (const Aws::String &value)
 
void SetTaskArn (Aws::String &&value)
 
void SetTaskArn (const char *value)
 
UpdateMaintenanceWindowTaskRequestWithTaskArn (const Aws::String &value)
 
UpdateMaintenanceWindowTaskRequestWithTaskArn (Aws::String &&value)
 
UpdateMaintenanceWindowTaskRequestWithTaskArn (const char *value)
 
const Aws::StringGetServiceRoleArn () const
 
bool ServiceRoleArnHasBeenSet () const
 
void SetServiceRoleArn (const Aws::String &value)
 
void SetServiceRoleArn (Aws::String &&value)
 
void SetServiceRoleArn (const char *value)
 
UpdateMaintenanceWindowTaskRequestWithServiceRoleArn (const Aws::String &value)
 
UpdateMaintenanceWindowTaskRequestWithServiceRoleArn (Aws::String &&value)
 
UpdateMaintenanceWindowTaskRequestWithServiceRoleArn (const char *value)
 
const Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > & GetTaskParameters () const
 
bool TaskParametersHasBeenSet () const
 
void SetTaskParameters (const Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &value)
 
void SetTaskParameters (Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &&value)
 
UpdateMaintenanceWindowTaskRequestWithTaskParameters (const Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &value)
 
UpdateMaintenanceWindowTaskRequestWithTaskParameters (Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &&value)
 
UpdateMaintenanceWindowTaskRequestAddTaskParameters (const Aws::String &key, const MaintenanceWindowTaskParameterValueExpression &value)
 
UpdateMaintenanceWindowTaskRequestAddTaskParameters (Aws::String &&key, const MaintenanceWindowTaskParameterValueExpression &value)
 
UpdateMaintenanceWindowTaskRequestAddTaskParameters (const Aws::String &key, MaintenanceWindowTaskParameterValueExpression &&value)
 
UpdateMaintenanceWindowTaskRequestAddTaskParameters (Aws::String &&key, MaintenanceWindowTaskParameterValueExpression &&value)
 
UpdateMaintenanceWindowTaskRequestAddTaskParameters (const char *key, MaintenanceWindowTaskParameterValueExpression &&value)
 
UpdateMaintenanceWindowTaskRequestAddTaskParameters (const char *key, const MaintenanceWindowTaskParameterValueExpression &value)
 
const MaintenanceWindowTaskInvocationParametersGetTaskInvocationParameters () const
 
bool TaskInvocationParametersHasBeenSet () const
 
void SetTaskInvocationParameters (const MaintenanceWindowTaskInvocationParameters &value)
 
void SetTaskInvocationParameters (MaintenanceWindowTaskInvocationParameters &&value)
 
UpdateMaintenanceWindowTaskRequestWithTaskInvocationParameters (const MaintenanceWindowTaskInvocationParameters &value)
 
UpdateMaintenanceWindowTaskRequestWithTaskInvocationParameters (MaintenanceWindowTaskInvocationParameters &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
UpdateMaintenanceWindowTaskRequestWithPriority (int value)
 
const Aws::StringGetMaxConcurrency () const
 
bool MaxConcurrencyHasBeenSet () const
 
void SetMaxConcurrency (const Aws::String &value)
 
void SetMaxConcurrency (Aws::String &&value)
 
void SetMaxConcurrency (const char *value)
 
UpdateMaintenanceWindowTaskRequestWithMaxConcurrency (const Aws::String &value)
 
UpdateMaintenanceWindowTaskRequestWithMaxConcurrency (Aws::String &&value)
 
UpdateMaintenanceWindowTaskRequestWithMaxConcurrency (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)
 
UpdateMaintenanceWindowTaskRequestWithMaxErrors (const Aws::String &value)
 
UpdateMaintenanceWindowTaskRequestWithMaxErrors (Aws::String &&value)
 
UpdateMaintenanceWindowTaskRequestWithMaxErrors (const char *value)
 
const LoggingInfoGetLoggingInfo () const
 
bool LoggingInfoHasBeenSet () const
 
void SetLoggingInfo (const LoggingInfo &value)
 
void SetLoggingInfo (LoggingInfo &&value)
 
UpdateMaintenanceWindowTaskRequestWithLoggingInfo (const LoggingInfo &value)
 
UpdateMaintenanceWindowTaskRequestWithLoggingInfo (LoggingInfo &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateMaintenanceWindowTaskRequestWithName (const Aws::String &value)
 
UpdateMaintenanceWindowTaskRequestWithName (Aws::String &&value)
 
UpdateMaintenanceWindowTaskRequestWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateMaintenanceWindowTaskRequestWithDescription (const Aws::String &value)
 
UpdateMaintenanceWindowTaskRequestWithDescription (Aws::String &&value)
 
UpdateMaintenanceWindowTaskRequestWithDescription (const char *value)
 
bool GetReplace () const
 
bool ReplaceHasBeenSet () const
 
void SetReplace (bool value)
 
UpdateMaintenanceWindowTaskRequestWithReplace (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 UpdateMaintenanceWindowTaskRequest.h.

Constructor & Destructor Documentation

◆ UpdateMaintenanceWindowTaskRequest()

Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::UpdateMaintenanceWindowTaskRequest ( )

Member Function Documentation

◆ AddTargets() [1/2]

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

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Definition at line 172 of file UpdateMaintenanceWindowTaskRequest.h.

◆ AddTargets() [2/2]

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

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Definition at line 179 of file UpdateMaintenanceWindowTaskRequest.h.

◆ AddTaskParameters() [1/6]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::AddTaskParameters ( const Aws::String key,
const MaintenanceWindowTaskParameterValueExpression value 
)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 434 of file UpdateMaintenanceWindowTaskRequest.h.

◆ AddTaskParameters() [2/6]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::AddTaskParameters ( Aws::String &&  key,
const MaintenanceWindowTaskParameterValueExpression value 
)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 446 of file UpdateMaintenanceWindowTaskRequest.h.

◆ AddTaskParameters() [3/6]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::AddTaskParameters ( const Aws::String key,
MaintenanceWindowTaskParameterValueExpression &&  value 
)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 458 of file UpdateMaintenanceWindowTaskRequest.h.

◆ AddTaskParameters() [4/6]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::AddTaskParameters ( Aws::String &&  key,
MaintenanceWindowTaskParameterValueExpression &&  value 
)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 470 of file UpdateMaintenanceWindowTaskRequest.h.

◆ AddTaskParameters() [5/6]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::AddTaskParameters ( const char *  key,
MaintenanceWindowTaskParameterValueExpression &&  value 
)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 482 of file UpdateMaintenanceWindowTaskRequest.h.

◆ AddTaskParameters() [6/6]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::AddTaskParameters ( const char *  key,
const MaintenanceWindowTaskParameterValueExpression value 
)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 494 of file UpdateMaintenanceWindowTaskRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::DescriptionHasBeenSet ( ) const
inline

The new task description to specify.

Definition at line 849 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetDescription()

const Aws::String& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetDescription ( ) const
inline

The new task description to specify.

Definition at line 844 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetLoggingInfo()

const LoggingInfo& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetLoggingInfo ( ) const
inline

The new logging location in Amazon S3 to specify.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Definition at line 742 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetMaxConcurrency()

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

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

Definition at line 624 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetMaxErrors()

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

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Definition at line 681 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetName()

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

The new task name to specify.

Definition at line 803 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetPriority()

int Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetPriority ( ) const
inline

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Definition at line 598 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetReplace()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetReplace ( ) const
inline

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

Definition at line 887 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetServiceRoleArn()

const Aws::String& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetServiceRoleArn ( ) const
inline

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Definition at line 237 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetTargets()

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

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Definition at line 130 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetTaskArn()

const Aws::String& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetTaskArn ( ) const
inline

The task ARN to modify.

Definition at line 185 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetTaskInvocationParameters()

const MaintenanceWindowTaskInvocationParameters& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetTaskInvocationParameters ( ) const
inline

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Definition at line 511 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetTaskParameters()

const Aws::Map<Aws::String, MaintenanceWindowTaskParameterValueExpression>& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetTaskParameters ( ) const
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 362 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetWindowId()

const Aws::String& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetWindowId ( ) const
inline

The maintenance window ID that contains the task to modify.

Definition at line 46 of file UpdateMaintenanceWindowTaskRequest.h.

◆ GetWindowTaskId()

const Aws::String& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::GetWindowTaskId ( ) const
inline

The task ID to modify.

Definition at line 87 of file UpdateMaintenanceWindowTaskRequest.h.

◆ LoggingInfoHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::LoggingInfoHasBeenSet ( ) const
inline

The new logging location in Amazon S3 to specify.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Definition at line 753 of file UpdateMaintenanceWindowTaskRequest.h.

◆ MaxConcurrencyHasBeenSet()

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

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

Definition at line 631 of file UpdateMaintenanceWindowTaskRequest.h.

◆ MaxErrorsHasBeenSet()

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

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Definition at line 688 of file UpdateMaintenanceWindowTaskRequest.h.

◆ NameHasBeenSet()

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

The new task name to specify.

Definition at line 808 of file UpdateMaintenanceWindowTaskRequest.h.

◆ PriorityHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::PriorityHasBeenSet ( ) const
inline

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Definition at line 604 of file UpdateMaintenanceWindowTaskRequest.h.

◆ ReplaceHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::ReplaceHasBeenSet ( ) const
inline

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

Definition at line 894 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceRoleArnHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::ServiceRoleArnHasBeenSet ( ) const
inline

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Definition at line 253 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetDescription() [1/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetDescription ( const Aws::String value)
inline

The new task description to specify.

Definition at line 854 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetDescription() [2/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetDescription ( Aws::String &&  value)
inline

The new task description to specify.

Definition at line 859 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetDescription() [3/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetDescription ( const char *  value)
inline

The new task description to specify.

Definition at line 864 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetLoggingInfo() [1/2]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetLoggingInfo ( const LoggingInfo value)
inline

The new logging location in Amazon S3 to specify.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Definition at line 764 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetLoggingInfo() [2/2]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetLoggingInfo ( LoggingInfo &&  value)
inline

The new logging location in Amazon S3 to specify.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Definition at line 775 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetMaxConcurrency() [1/3]

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

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

Definition at line 638 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetMaxConcurrency() [2/3]

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

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

Definition at line 645 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetMaxConcurrency() [3/3]

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

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

Definition at line 652 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetMaxErrors() [1/3]

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

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Definition at line 695 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetMaxErrors() [2/3]

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

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Definition at line 702 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetMaxErrors() [3/3]

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

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Definition at line 709 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetName() [1/3]

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

The new task name to specify.

Definition at line 813 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetName() [2/3]

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

The new task name to specify.

Definition at line 818 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetName() [3/3]

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

The new task name to specify.

Definition at line 823 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetPriority()

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetPriority ( int  value)
inline

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Definition at line 610 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetReplace()

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetReplace ( bool  value)
inline

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

Definition at line 901 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetServiceRoleArn() [1/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetServiceRoleArn ( const Aws::String value)
inline

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Definition at line 269 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetServiceRoleArn() [2/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetServiceRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Definition at line 285 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetServiceRoleArn() [3/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetServiceRoleArn ( const char *  value)
inline

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Definition at line 301 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTargets() [1/2]

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

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Definition at line 144 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTargets() [2/2]

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

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Definition at line 151 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTaskArn() [1/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetTaskArn ( const Aws::String value)
inline

The task ARN to modify.

Definition at line 195 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTaskArn() [2/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetTaskArn ( Aws::String &&  value)
inline

The task ARN to modify.

Definition at line 200 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTaskArn() [3/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetTaskArn ( const char *  value)
inline

The task ARN to modify.

Definition at line 205 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTaskInvocationParameters() [1/2]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetTaskInvocationParameters ( const MaintenanceWindowTaskInvocationParameters value)
inline

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Definition at line 543 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTaskInvocationParameters() [2/2]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetTaskInvocationParameters ( MaintenanceWindowTaskInvocationParameters &&  value)
inline

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Definition at line 559 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTaskParameters() [1/2]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetTaskParameters ( const Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &  value)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 386 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetTaskParameters() [2/2]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetTaskParameters ( Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &&  value)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 398 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetWindowId() [1/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetWindowId ( const Aws::String value)
inline

The maintenance window ID that contains the task to modify.

Definition at line 56 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetWindowId() [2/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetWindowId ( Aws::String &&  value)
inline

The maintenance window ID that contains the task to modify.

Definition at line 61 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetWindowId() [3/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetWindowId ( const char *  value)
inline

The maintenance window ID that contains the task to modify.

Definition at line 66 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetWindowTaskId() [1/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetWindowTaskId ( const Aws::String value)
inline

The task ID to modify.

Definition at line 97 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetWindowTaskId() [2/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetWindowTaskId ( Aws::String &&  value)
inline

The task ID to modify.

Definition at line 102 of file UpdateMaintenanceWindowTaskRequest.h.

◆ SetWindowTaskId() [3/3]

void Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::SetWindowTaskId ( const char *  value)
inline

The task ID to modify.

Definition at line 107 of file UpdateMaintenanceWindowTaskRequest.h.

◆ TargetsHasBeenSet()

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

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Definition at line 137 of file UpdateMaintenanceWindowTaskRequest.h.

◆ TaskArnHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::TaskArnHasBeenSet ( ) const
inline

The task ARN to modify.

Definition at line 190 of file UpdateMaintenanceWindowTaskRequest.h.

◆ TaskInvocationParametersHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::TaskInvocationParametersHasBeenSet ( ) const
inline

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Definition at line 527 of file UpdateMaintenanceWindowTaskRequest.h.

◆ TaskParametersHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::TaskParametersHasBeenSet ( ) const
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 374 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WindowIdHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WindowIdHasBeenSet ( ) const
inline

The maintenance window ID that contains the task to modify.

Definition at line 51 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WindowTaskIdHasBeenSet()

bool Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WindowTaskIdHasBeenSet ( ) const
inline

The task ID to modify.

Definition at line 92 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithDescription() [1/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithDescription ( const Aws::String value)
inline

The new task description to specify.

Definition at line 869 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithDescription() [2/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithDescription ( Aws::String &&  value)
inline

The new task description to specify.

Definition at line 874 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithDescription() [3/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithDescription ( const char *  value)
inline

The new task description to specify.

Definition at line 879 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithLoggingInfo() [1/2]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithLoggingInfo ( const LoggingInfo value)
inline

The new logging location in Amazon S3 to specify.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Definition at line 786 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithLoggingInfo() [2/2]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithLoggingInfo ( LoggingInfo &&  value)
inline

The new logging location in Amazon S3 to specify.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Definition at line 797 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithMaxConcurrency() [1/3]

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

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

Definition at line 659 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithMaxConcurrency() [2/3]

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

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

Definition at line 666 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithMaxConcurrency() [3/3]

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

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

Definition at line 673 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithMaxErrors() [1/3]

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

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Definition at line 716 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithMaxErrors() [2/3]

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

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Definition at line 723 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithMaxErrors() [3/3]

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

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Definition at line 730 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithName() [1/3]

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

The new task name to specify.

Definition at line 828 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithName() [2/3]

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

The new task name to specify.

Definition at line 833 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithName() [3/3]

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

The new task name to specify.

Definition at line 838 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithPriority()

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithPriority ( int  value)
inline

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Definition at line 616 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithReplace()

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithReplace ( bool  value)
inline

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

Definition at line 908 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithServiceRoleArn() [1/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithServiceRoleArn ( const Aws::String value)
inline

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Definition at line 317 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithServiceRoleArn() [2/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithServiceRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Definition at line 333 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithServiceRoleArn() [3/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithServiceRoleArn ( const char *  value)
inline

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Definition at line 349 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTargets() [1/2]

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

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Definition at line 158 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTargets() [2/2]

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

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Definition at line 165 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTaskArn() [1/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithTaskArn ( const Aws::String value)
inline

The task ARN to modify.

Definition at line 210 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTaskArn() [2/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithTaskArn ( Aws::String &&  value)
inline

The task ARN to modify.

Definition at line 215 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTaskArn() [3/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithTaskArn ( const char *  value)
inline

The task ARN to modify.

Definition at line 220 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTaskInvocationParameters() [1/2]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithTaskInvocationParameters ( const MaintenanceWindowTaskInvocationParameters value)
inline

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Definition at line 575 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTaskInvocationParameters() [2/2]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithTaskInvocationParameters ( MaintenanceWindowTaskInvocationParameters &&  value)
inline

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Definition at line 591 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTaskParameters() [1/2]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithTaskParameters ( const Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &  value)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 410 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithTaskParameters() [2/2]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithTaskParameters ( Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &&  value)
inline

The parameters to modify.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Definition at line 422 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithWindowId() [1/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithWindowId ( const Aws::String value)
inline

The maintenance window ID that contains the task to modify.

Definition at line 71 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithWindowId() [2/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithWindowId ( Aws::String &&  value)
inline

The maintenance window ID that contains the task to modify.

Definition at line 76 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithWindowId() [3/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithWindowId ( const char *  value)
inline

The maintenance window ID that contains the task to modify.

Definition at line 81 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithWindowTaskId() [1/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithWindowTaskId ( const Aws::String value)
inline

The task ID to modify.

Definition at line 112 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithWindowTaskId() [2/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithWindowTaskId ( Aws::String &&  value)
inline

The task ID to modify.

Definition at line 117 of file UpdateMaintenanceWindowTaskRequest.h.

◆ WithWindowTaskId() [3/3]

UpdateMaintenanceWindowTaskRequest& Aws::SSM::Model::UpdateMaintenanceWindowTaskRequest::WithWindowTaskId ( const char *  value)
inline

The task ID to modify.

Definition at line 122 of file UpdateMaintenanceWindowTaskRequest.h.


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