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

#include <RegisterTaskWithMaintenanceWindowRequest.h>

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

Public Member Functions

 RegisterTaskWithMaintenanceWindowRequest ()
 
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)
 
RegisterTaskWithMaintenanceWindowRequestWithWindowId (const Aws::String &value)
 
RegisterTaskWithMaintenanceWindowRequestWithWindowId (Aws::String &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithWindowId (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)
 
RegisterTaskWithMaintenanceWindowRequestWithTargets (const Aws::Vector< Target > &value)
 
RegisterTaskWithMaintenanceWindowRequestWithTargets (Aws::Vector< Target > &&value)
 
RegisterTaskWithMaintenanceWindowRequestAddTargets (const Target &value)
 
RegisterTaskWithMaintenanceWindowRequestAddTargets (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)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskArn (const Aws::String &value)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskArn (Aws::String &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskArn (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)
 
RegisterTaskWithMaintenanceWindowRequestWithServiceRoleArn (const Aws::String &value)
 
RegisterTaskWithMaintenanceWindowRequestWithServiceRoleArn (Aws::String &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithServiceRoleArn (const char *value)
 
const MaintenanceWindowTaskTypeGetTaskType () const
 
bool TaskTypeHasBeenSet () const
 
void SetTaskType (const MaintenanceWindowTaskType &value)
 
void SetTaskType (MaintenanceWindowTaskType &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskType (const MaintenanceWindowTaskType &value)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskType (MaintenanceWindowTaskType &&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)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskParameters (const Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &value)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskParameters (Aws::Map< Aws::String, MaintenanceWindowTaskParameterValueExpression > &&value)
 
RegisterTaskWithMaintenanceWindowRequestAddTaskParameters (const Aws::String &key, const MaintenanceWindowTaskParameterValueExpression &value)
 
RegisterTaskWithMaintenanceWindowRequestAddTaskParameters (Aws::String &&key, const MaintenanceWindowTaskParameterValueExpression &value)
 
RegisterTaskWithMaintenanceWindowRequestAddTaskParameters (const Aws::String &key, MaintenanceWindowTaskParameterValueExpression &&value)
 
RegisterTaskWithMaintenanceWindowRequestAddTaskParameters (Aws::String &&key, MaintenanceWindowTaskParameterValueExpression &&value)
 
RegisterTaskWithMaintenanceWindowRequestAddTaskParameters (const char *key, MaintenanceWindowTaskParameterValueExpression &&value)
 
RegisterTaskWithMaintenanceWindowRequestAddTaskParameters (const char *key, const MaintenanceWindowTaskParameterValueExpression &value)
 
const MaintenanceWindowTaskInvocationParametersGetTaskInvocationParameters () const
 
bool TaskInvocationParametersHasBeenSet () const
 
void SetTaskInvocationParameters (const MaintenanceWindowTaskInvocationParameters &value)
 
void SetTaskInvocationParameters (MaintenanceWindowTaskInvocationParameters &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskInvocationParameters (const MaintenanceWindowTaskInvocationParameters &value)
 
RegisterTaskWithMaintenanceWindowRequestWithTaskInvocationParameters (MaintenanceWindowTaskInvocationParameters &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
RegisterTaskWithMaintenanceWindowRequestWithPriority (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)
 
RegisterTaskWithMaintenanceWindowRequestWithMaxConcurrency (const Aws::String &value)
 
RegisterTaskWithMaintenanceWindowRequestWithMaxConcurrency (Aws::String &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithMaxConcurrency (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)
 
RegisterTaskWithMaintenanceWindowRequestWithMaxErrors (const Aws::String &value)
 
RegisterTaskWithMaintenanceWindowRequestWithMaxErrors (Aws::String &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithMaxErrors (const char *value)
 
const LoggingInfoGetLoggingInfo () const
 
bool LoggingInfoHasBeenSet () const
 
void SetLoggingInfo (const LoggingInfo &value)
 
void SetLoggingInfo (LoggingInfo &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithLoggingInfo (const LoggingInfo &value)
 
RegisterTaskWithMaintenanceWindowRequestWithLoggingInfo (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)
 
RegisterTaskWithMaintenanceWindowRequestWithName (const Aws::String &value)
 
RegisterTaskWithMaintenanceWindowRequestWithName (Aws::String &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithName (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)
 
RegisterTaskWithMaintenanceWindowRequestWithDescription (const Aws::String &value)
 
RegisterTaskWithMaintenanceWindowRequestWithDescription (Aws::String &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithDescription (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
RegisterTaskWithMaintenanceWindowRequestWithClientToken (const Aws::String &value)
 
RegisterTaskWithMaintenanceWindowRequestWithClientToken (Aws::String &&value)
 
RegisterTaskWithMaintenanceWindowRequestWithClientToken (const char *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 29 of file RegisterTaskWithMaintenanceWindowRequest.h.

Constructor & Destructor Documentation

◆ RegisterTaskWithMaintenanceWindowRequest()

Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::RegisterTaskWithMaintenanceWindowRequest ( )

Member Function Documentation

◆ AddTargets() [1/2]

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

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Definition at line 203 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ AddTargets() [2/2]

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

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Definition at line 220 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ AddTaskParameters() [1/6]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 510 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ AddTaskParameters() [2/6]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 530 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ AddTaskParameters() [3/6]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 500 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ AddTaskParameters() [4/6]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 520 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ AddTaskParameters() [5/6]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 550 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ AddTaskParameters() [6/6]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 540 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::ClientTokenHasBeenSet ( ) const
inline

User-provided idempotency token.

Definition at line 934 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ DescriptionHasBeenSet()

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

An optional description for the task.

Definition at line 893 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetClientToken()

const Aws::String& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::GetClientToken ( ) const
inline

User-provided idempotency token.

Definition at line 929 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetDescription()

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

An optional description for the task.

Definition at line 888 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetLoggingInfo()

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

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.

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

Definition at line 776 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetMaxConcurrency()

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

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 626 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetMaxErrors()

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

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 699 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetName()

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

An optional name for the task.

Definition at line 847 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetPriority()

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

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Definition at line 595 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

◆ GetServiceRoleArn()

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

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services Systems Manager User Guide:

Definition at line 279 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetTargets()

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

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Definition at line 101 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetTaskArn()

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

The ARN of the task to run.

Definition at line 226 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetTaskInvocationParameters()

const MaintenanceWindowTaskInvocationParameters& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::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.

Definition at line 557 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetTaskParameters()

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 440 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetTaskType()

const MaintenanceWindowTaskType& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::GetTaskType ( ) const
inline

The type of task being registered.

Definition at line 404 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ GetWindowId()

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

The ID of the maintenance window the task should be added to.

Definition at line 48 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ LoggingInfoHasBeenSet()

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

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.

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

Definition at line 789 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ MaxConcurrencyHasBeenSet()

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

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 635 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ MaxErrorsHasBeenSet()

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

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 708 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ NameHasBeenSet()

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

An optional name for the task.

Definition at line 852 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ PriorityHasBeenSet()

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

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Definition at line 602 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceRoleArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services Systems Manager User Guide:

Definition at line 296 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetClientToken() [1/3]

void Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::SetClientToken ( Aws::String &&  value)
inline

User-provided idempotency token.

Definition at line 944 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetClientToken() [2/3]

void Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::SetClientToken ( const Aws::String value)
inline

User-provided idempotency token.

Definition at line 939 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetClientToken() [3/3]

void Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::SetClientToken ( const char *  value)
inline

User-provided idempotency token.

Definition at line 949 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetDescription() [1/3]

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

An optional description for the task.

Definition at line 903 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetDescription() [2/3]

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

An optional description for the task.

Definition at line 898 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetDescription() [3/3]

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

An optional description for the task.

Definition at line 908 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetLoggingInfo() [1/2]

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

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.

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

Definition at line 802 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetLoggingInfo() [2/2]

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

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.

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

Definition at line 815 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetMaxConcurrency() [1/3]

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

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 653 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetMaxConcurrency() [2/3]

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

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 644 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetMaxConcurrency() [3/3]

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

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 662 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetMaxErrors() [1/3]

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

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 726 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetMaxErrors() [2/3]

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

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 717 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetMaxErrors() [3/3]

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

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 735 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetName() [1/3]

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

An optional name for the task.

Definition at line 862 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetName() [2/3]

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

An optional name for the task.

Definition at line 857 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetName() [3/3]

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

An optional name for the task.

Definition at line 867 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetPriority()

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

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Definition at line 609 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetServiceRoleArn() [1/3]

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

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services Systems Manager User Guide:

Definition at line 330 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetServiceRoleArn() [2/3]

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

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services Systems Manager User Guide:

Definition at line 313 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetServiceRoleArn() [3/3]

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

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services Systems Manager User Guide:

Definition at line 347 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTargets() [1/2]

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

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Definition at line 152 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTargets() [2/2]

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

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Definition at line 135 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskArn() [1/3]

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

The ARN of the task to run.

Definition at line 241 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskArn() [2/3]

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

The ARN of the task to run.

Definition at line 236 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskArn() [3/3]

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

The ARN of the task to run.

Definition at line 246 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskInvocationParameters() [1/2]

void Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::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.

Definition at line 569 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskInvocationParameters() [2/2]

void Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::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.

Definition at line 575 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskParameters() [1/2]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 470 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskParameters() [2/2]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 460 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskType() [1/2]

void Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::SetTaskType ( const MaintenanceWindowTaskType value)
inline

The type of task being registered.

Definition at line 414 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetTaskType() [2/2]

void Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::SetTaskType ( MaintenanceWindowTaskType &&  value)
inline

The type of task being registered.

Definition at line 419 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetWindowId() [1/3]

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

The ID of the maintenance window the task should be added to.

Definition at line 63 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetWindowId() [2/3]

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

The ID of the maintenance window the task should be added to.

Definition at line 58 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ SetWindowId() [3/3]

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

The ID of the maintenance window the task should be added to.

Definition at line 68 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ TargetsHasBeenSet()

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

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Definition at line 118 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ TaskArnHasBeenSet()

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

The ARN of the task to run.

Definition at line 231 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ TaskInvocationParametersHasBeenSet()

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

Definition at line 563 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ TaskParametersHasBeenSet()

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 450 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ TaskTypeHasBeenSet()

bool Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::TaskTypeHasBeenSet ( ) const
inline

The type of task being registered.

Definition at line 409 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WindowIdHasBeenSet()

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

The ID of the maintenance window the task should be added to.

Definition at line 53 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithClientToken() [1/3]

RegisterTaskWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::WithClientToken ( Aws::String &&  value)
inline

User-provided idempotency token.

Definition at line 959 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithClientToken() [2/3]

RegisterTaskWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::WithClientToken ( const Aws::String value)
inline

User-provided idempotency token.

Definition at line 954 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithClientToken() [3/3]

RegisterTaskWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::WithClientToken ( const char *  value)
inline

User-provided idempotency token.

Definition at line 964 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithDescription() [1/3]

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

An optional description for the task.

Definition at line 918 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithDescription() [2/3]

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

An optional description for the task.

Definition at line 913 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithDescription() [3/3]

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

An optional description for the task.

Definition at line 923 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithLoggingInfo() [1/2]

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

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.

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

Definition at line 828 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithLoggingInfo() [2/2]

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

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.

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

Definition at line 841 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithMaxConcurrency() [1/3]

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

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 680 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithMaxConcurrency() [2/3]

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

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 671 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithMaxConcurrency() [3/3]

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

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 689 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithMaxErrors() [1/3]

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

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 753 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithMaxErrors() [2/3]

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

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 744 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithMaxErrors() [3/3]

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

The maximum number of errors allowed before this task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Definition at line 762 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithName() [1/3]

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

An optional name for the task.

Definition at line 877 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithName() [2/3]

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

An optional name for the task.

Definition at line 872 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithName() [3/3]

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

An optional name for the task.

Definition at line 882 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithPriority()

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

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Definition at line 616 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithServiceRoleArn() [1/3]

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

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services Systems Manager User Guide:

Definition at line 381 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithServiceRoleArn() [2/3]

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

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services Systems Manager User Guide:

Definition at line 364 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithServiceRoleArn() [3/3]

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

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services Systems Manager User Guide:

Definition at line 398 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTargets() [1/2]

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

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Definition at line 186 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTargets() [2/2]

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

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Definition at line 169 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskArn() [1/3]

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

The ARN of the task to run.

Definition at line 256 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskArn() [2/3]

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

The ARN of the task to run.

Definition at line 251 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskArn() [3/3]

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

The ARN of the task to run.

Definition at line 261 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskInvocationParameters() [1/2]

RegisterTaskWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::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.

Definition at line 581 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskInvocationParameters() [2/2]

RegisterTaskWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::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.

Definition at line 587 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskParameters() [1/2]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 490 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskParameters() [2/2]

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

The parameters that should be passed to the task when it is run.

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.

Definition at line 480 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskType() [1/2]

RegisterTaskWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::WithTaskType ( const MaintenanceWindowTaskType value)
inline

The type of task being registered.

Definition at line 424 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithTaskType() [2/2]

RegisterTaskWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTaskWithMaintenanceWindowRequest::WithTaskType ( MaintenanceWindowTaskType &&  value)
inline

The type of task being registered.

Definition at line 429 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithWindowId() [1/3]

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

The ID of the maintenance window the task should be added to.

Definition at line 78 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithWindowId() [2/3]

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

The ID of the maintenance window the task should be added to.

Definition at line 73 of file RegisterTaskWithMaintenanceWindowRequest.h.

◆ WithWindowId() [3/3]

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

The ID of the maintenance window the task should be added to.

Definition at line 83 of file RegisterTaskWithMaintenanceWindowRequest.h.


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