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

#include <CreateMaintenanceWindowRequest.h>

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

Public Member Functions

 CreateMaintenanceWindowRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateMaintenanceWindowRequestWithName (const Aws::String &value)
 
CreateMaintenanceWindowRequestWithName (Aws::String &&value)
 
CreateMaintenanceWindowRequestWithName (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)
 
CreateMaintenanceWindowRequestWithDescription (const Aws::String &value)
 
CreateMaintenanceWindowRequestWithDescription (Aws::String &&value)
 
CreateMaintenanceWindowRequestWithDescription (const char *value)
 
const Aws::StringGetStartDate () const
 
bool StartDateHasBeenSet () const
 
void SetStartDate (const Aws::String &value)
 
void SetStartDate (Aws::String &&value)
 
void SetStartDate (const char *value)
 
CreateMaintenanceWindowRequestWithStartDate (const Aws::String &value)
 
CreateMaintenanceWindowRequestWithStartDate (Aws::String &&value)
 
CreateMaintenanceWindowRequestWithStartDate (const char *value)
 
const Aws::StringGetEndDate () const
 
bool EndDateHasBeenSet () const
 
void SetEndDate (const Aws::String &value)
 
void SetEndDate (Aws::String &&value)
 
void SetEndDate (const char *value)
 
CreateMaintenanceWindowRequestWithEndDate (const Aws::String &value)
 
CreateMaintenanceWindowRequestWithEndDate (Aws::String &&value)
 
CreateMaintenanceWindowRequestWithEndDate (const char *value)
 
const Aws::StringGetSchedule () const
 
bool ScheduleHasBeenSet () const
 
void SetSchedule (const Aws::String &value)
 
void SetSchedule (Aws::String &&value)
 
void SetSchedule (const char *value)
 
CreateMaintenanceWindowRequestWithSchedule (const Aws::String &value)
 
CreateMaintenanceWindowRequestWithSchedule (Aws::String &&value)
 
CreateMaintenanceWindowRequestWithSchedule (const char *value)
 
const Aws::StringGetScheduleTimezone () const
 
bool ScheduleTimezoneHasBeenSet () const
 
void SetScheduleTimezone (const Aws::String &value)
 
void SetScheduleTimezone (Aws::String &&value)
 
void SetScheduleTimezone (const char *value)
 
CreateMaintenanceWindowRequestWithScheduleTimezone (const Aws::String &value)
 
CreateMaintenanceWindowRequestWithScheduleTimezone (Aws::String &&value)
 
CreateMaintenanceWindowRequestWithScheduleTimezone (const char *value)
 
int GetScheduleOffset () const
 
bool ScheduleOffsetHasBeenSet () const
 
void SetScheduleOffset (int value)
 
CreateMaintenanceWindowRequestWithScheduleOffset (int value)
 
int GetDuration () const
 
bool DurationHasBeenSet () const
 
void SetDuration (int value)
 
CreateMaintenanceWindowRequestWithDuration (int value)
 
int GetCutoff () const
 
bool CutoffHasBeenSet () const
 
void SetCutoff (int value)
 
CreateMaintenanceWindowRequestWithCutoff (int value)
 
bool GetAllowUnassociatedTargets () const
 
bool AllowUnassociatedTargetsHasBeenSet () const
 
void SetAllowUnassociatedTargets (bool value)
 
CreateMaintenanceWindowRequestWithAllowUnassociatedTargets (bool value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateMaintenanceWindowRequestWithClientToken (const Aws::String &value)
 
CreateMaintenanceWindowRequestWithClientToken (Aws::String &&value)
 
CreateMaintenanceWindowRequestWithClientToken (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateMaintenanceWindowRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateMaintenanceWindowRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateMaintenanceWindowRequestAddTags (const Tag &value)
 
CreateMaintenanceWindowRequestAddTags (Tag &&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 24 of file CreateMaintenanceWindowRequest.h.

Constructor & Destructor Documentation

◆ CreateMaintenanceWindowRequest()

Aws::SSM::Model::CreateMaintenanceWindowRequest::CreateMaintenanceWindowRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::AddTags ( const Tag value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Definition at line 631 of file CreateMaintenanceWindowRequest.h.

◆ AddTags() [2/2]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::AddTags ( Tag &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Definition at line 645 of file CreateMaintenanceWindowRequest.h.

◆ AllowUnassociatedTargetsHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::AllowUnassociatedTargetsHasBeenSet ( ) const
inline

Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

Definition at line 471 of file CreateMaintenanceWindowRequest.h.

◆ ClientTokenHasBeenSet()

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

User-provided idempotency token.

Definition at line 502 of file CreateMaintenanceWindowRequest.h.

◆ CutoffHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::CutoffHasBeenSet ( ) const
inline

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Definition at line 438 of file CreateMaintenanceWindowRequest.h.

◆ DescriptionHasBeenSet()

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

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Definition at line 91 of file CreateMaintenanceWindowRequest.h.

◆ DurationHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::DurationHasBeenSet ( ) const
inline

The duration of the maintenance window in hours.

Definition at line 415 of file CreateMaintenanceWindowRequest.h.

◆ EndDateHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::EndDateHasBeenSet ( ) const
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Definition at line 199 of file CreateMaintenanceWindowRequest.h.

◆ GetAllowUnassociatedTargets()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::GetAllowUnassociatedTargets ( ) const
inline

Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

Definition at line 461 of file CreateMaintenanceWindowRequest.h.

◆ GetClientToken()

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

User-provided idempotency token.

Definition at line 497 of file CreateMaintenanceWindowRequest.h.

◆ GetCutoff()

int Aws::SSM::Model::CreateMaintenanceWindowRequest::GetCutoff ( ) const
inline

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Definition at line 432 of file CreateMaintenanceWindowRequest.h.

◆ GetDescription()

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

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Definition at line 85 of file CreateMaintenanceWindowRequest.h.

◆ GetDuration()

int Aws::SSM::Model::CreateMaintenanceWindowRequest::GetDuration ( ) const
inline

The duration of the maintenance window in hours.

Definition at line 410 of file CreateMaintenanceWindowRequest.h.

◆ GetEndDate()

const Aws::String& Aws::SSM::Model::CreateMaintenanceWindowRequest::GetEndDate ( ) const
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Definition at line 192 of file CreateMaintenanceWindowRequest.h.

◆ GetName()

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

The name of the maintenance window.

Definition at line 43 of file CreateMaintenanceWindowRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetSchedule()

const Aws::String& Aws::SSM::Model::CreateMaintenanceWindowRequest::GetSchedule ( ) const
inline

The schedule of the maintenance window in the form of a cron or rate expression.

Definition at line 248 of file CreateMaintenanceWindowRequest.h.

◆ GetScheduleOffset()

int Aws::SSM::Model::CreateMaintenanceWindowRequest::GetScheduleOffset ( ) const
inline

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(0 30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

Definition at line 374 of file CreateMaintenanceWindowRequest.h.

◆ GetScheduleTimezone()

const Aws::String& Aws::SSM::Model::CreateMaintenanceWindowRequest::GetScheduleTimezone ( ) const
inline

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Definition at line 300 of file CreateMaintenanceWindowRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateMaintenanceWindowRequest.h.

◆ GetStartDate()

const Aws::String& Aws::SSM::Model::CreateMaintenanceWindowRequest::GetStartDate ( ) const
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Definition at line 135 of file CreateMaintenanceWindowRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::SSM::Model::CreateMaintenanceWindowRequest::GetTags ( ) const
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Definition at line 547 of file CreateMaintenanceWindowRequest.h.

◆ NameHasBeenSet()

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

The name of the maintenance window.

Definition at line 48 of file CreateMaintenanceWindowRequest.h.

◆ ScheduleHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::ScheduleHasBeenSet ( ) const
inline

The schedule of the maintenance window in the form of a cron or rate expression.

Definition at line 254 of file CreateMaintenanceWindowRequest.h.

◆ ScheduleOffsetHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::ScheduleOffsetHasBeenSet ( ) const
inline

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(0 30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

Definition at line 384 of file CreateMaintenanceWindowRequest.h.

◆ ScheduleTimezoneHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::ScheduleTimezoneHasBeenSet ( ) const
inline

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Definition at line 309 of file CreateMaintenanceWindowRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAllowUnassociatedTargets()

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetAllowUnassociatedTargets ( bool  value)
inline

Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

Definition at line 481 of file CreateMaintenanceWindowRequest.h.

◆ SetClientToken() [1/3]

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

User-provided idempotency token.

Definition at line 507 of file CreateMaintenanceWindowRequest.h.

◆ SetClientToken() [2/3]

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

User-provided idempotency token.

Definition at line 512 of file CreateMaintenanceWindowRequest.h.

◆ SetClientToken() [3/3]

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

User-provided idempotency token.

Definition at line 517 of file CreateMaintenanceWindowRequest.h.

◆ SetCutoff()

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetCutoff ( int  value)
inline

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Definition at line 444 of file CreateMaintenanceWindowRequest.h.

◆ SetDescription() [1/3]

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

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Definition at line 97 of file CreateMaintenanceWindowRequest.h.

◆ SetDescription() [2/3]

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

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Definition at line 103 of file CreateMaintenanceWindowRequest.h.

◆ SetDescription() [3/3]

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

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Definition at line 109 of file CreateMaintenanceWindowRequest.h.

◆ SetDuration()

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetDuration ( int  value)
inline

The duration of the maintenance window in hours.

Definition at line 420 of file CreateMaintenanceWindowRequest.h.

◆ SetEndDate() [1/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetEndDate ( const Aws::String value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Definition at line 206 of file CreateMaintenanceWindowRequest.h.

◆ SetEndDate() [2/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetEndDate ( Aws::String &&  value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Definition at line 213 of file CreateMaintenanceWindowRequest.h.

◆ SetEndDate() [3/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetEndDate ( const char *  value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Definition at line 220 of file CreateMaintenanceWindowRequest.h.

◆ SetName() [1/3]

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

The name of the maintenance window.

Definition at line 53 of file CreateMaintenanceWindowRequest.h.

◆ SetName() [2/3]

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

The name of the maintenance window.

Definition at line 58 of file CreateMaintenanceWindowRequest.h.

◆ SetName() [3/3]

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

The name of the maintenance window.

Definition at line 63 of file CreateMaintenanceWindowRequest.h.

◆ SetSchedule() [1/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetSchedule ( const Aws::String value)
inline

The schedule of the maintenance window in the form of a cron or rate expression.

Definition at line 260 of file CreateMaintenanceWindowRequest.h.

◆ SetSchedule() [2/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetSchedule ( Aws::String &&  value)
inline

The schedule of the maintenance window in the form of a cron or rate expression.

Definition at line 266 of file CreateMaintenanceWindowRequest.h.

◆ SetSchedule() [3/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetSchedule ( const char *  value)
inline

The schedule of the maintenance window in the form of a cron or rate expression.

Definition at line 272 of file CreateMaintenanceWindowRequest.h.

◆ SetScheduleOffset()

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetScheduleOffset ( int  value)
inline

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(0 30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

Definition at line 394 of file CreateMaintenanceWindowRequest.h.

◆ SetScheduleTimezone() [1/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetScheduleTimezone ( const Aws::String value)
inline

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Definition at line 318 of file CreateMaintenanceWindowRequest.h.

◆ SetScheduleTimezone() [2/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetScheduleTimezone ( Aws::String &&  value)
inline

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Definition at line 327 of file CreateMaintenanceWindowRequest.h.

◆ SetScheduleTimezone() [3/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetScheduleTimezone ( const char *  value)
inline

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Definition at line 336 of file CreateMaintenanceWindowRequest.h.

◆ SetStartDate() [1/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetStartDate ( const Aws::String value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Definition at line 149 of file CreateMaintenanceWindowRequest.h.

◆ SetStartDate() [2/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetStartDate ( Aws::String &&  value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Definition at line 156 of file CreateMaintenanceWindowRequest.h.

◆ SetStartDate() [3/3]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetStartDate ( const char *  value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Definition at line 163 of file CreateMaintenanceWindowRequest.h.

◆ SetTags() [1/2]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Definition at line 575 of file CreateMaintenanceWindowRequest.h.

◆ SetTags() [2/2]

void Aws::SSM::Model::CreateMaintenanceWindowRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Definition at line 589 of file CreateMaintenanceWindowRequest.h.

◆ StartDateHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::StartDateHasBeenSet ( ) const
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Definition at line 142 of file CreateMaintenanceWindowRequest.h.

◆ TagsHasBeenSet()

bool Aws::SSM::Model::CreateMaintenanceWindowRequest::TagsHasBeenSet ( ) const
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Definition at line 561 of file CreateMaintenanceWindowRequest.h.

◆ WithAllowUnassociatedTargets()

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithAllowUnassociatedTargets ( bool  value)
inline

Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

Definition at line 491 of file CreateMaintenanceWindowRequest.h.

◆ WithClientToken() [1/3]

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

User-provided idempotency token.

Definition at line 522 of file CreateMaintenanceWindowRequest.h.

◆ WithClientToken() [2/3]

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

User-provided idempotency token.

Definition at line 527 of file CreateMaintenanceWindowRequest.h.

◆ WithClientToken() [3/3]

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

User-provided idempotency token.

Definition at line 532 of file CreateMaintenanceWindowRequest.h.

◆ WithCutoff()

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithCutoff ( int  value)
inline

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Definition at line 450 of file CreateMaintenanceWindowRequest.h.

◆ WithDescription() [1/3]

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

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Definition at line 115 of file CreateMaintenanceWindowRequest.h.

◆ WithDescription() [2/3]

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

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Definition at line 121 of file CreateMaintenanceWindowRequest.h.

◆ WithDescription() [3/3]

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

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Definition at line 127 of file CreateMaintenanceWindowRequest.h.

◆ WithDuration()

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithDuration ( int  value)
inline

The duration of the maintenance window in hours.

Definition at line 425 of file CreateMaintenanceWindowRequest.h.

◆ WithEndDate() [1/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithEndDate ( const Aws::String value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Definition at line 227 of file CreateMaintenanceWindowRequest.h.

◆ WithEndDate() [2/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithEndDate ( Aws::String &&  value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Definition at line 234 of file CreateMaintenanceWindowRequest.h.

◆ WithEndDate() [3/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithEndDate ( const char *  value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Definition at line 241 of file CreateMaintenanceWindowRequest.h.

◆ WithName() [1/3]

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

The name of the maintenance window.

Definition at line 68 of file CreateMaintenanceWindowRequest.h.

◆ WithName() [2/3]

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

The name of the maintenance window.

Definition at line 73 of file CreateMaintenanceWindowRequest.h.

◆ WithName() [3/3]

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

The name of the maintenance window.

Definition at line 78 of file CreateMaintenanceWindowRequest.h.

◆ WithSchedule() [1/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithSchedule ( const Aws::String value)
inline

The schedule of the maintenance window in the form of a cron or rate expression.

Definition at line 278 of file CreateMaintenanceWindowRequest.h.

◆ WithSchedule() [2/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithSchedule ( Aws::String &&  value)
inline

The schedule of the maintenance window in the form of a cron or rate expression.

Definition at line 284 of file CreateMaintenanceWindowRequest.h.

◆ WithSchedule() [3/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithSchedule ( const char *  value)
inline

The schedule of the maintenance window in the form of a cron or rate expression.

Definition at line 290 of file CreateMaintenanceWindowRequest.h.

◆ WithScheduleOffset()

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithScheduleOffset ( int  value)
inline

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(0 30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

Definition at line 404 of file CreateMaintenanceWindowRequest.h.

◆ WithScheduleTimezone() [1/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithScheduleTimezone ( const Aws::String value)
inline

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Definition at line 345 of file CreateMaintenanceWindowRequest.h.

◆ WithScheduleTimezone() [2/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithScheduleTimezone ( Aws::String &&  value)
inline

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Definition at line 354 of file CreateMaintenanceWindowRequest.h.

◆ WithScheduleTimezone() [3/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithScheduleTimezone ( const char *  value)
inline

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Definition at line 363 of file CreateMaintenanceWindowRequest.h.

◆ WithStartDate() [1/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithStartDate ( const Aws::String value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Definition at line 170 of file CreateMaintenanceWindowRequest.h.

◆ WithStartDate() [2/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithStartDate ( Aws::String &&  value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Definition at line 177 of file CreateMaintenanceWindowRequest.h.

◆ WithStartDate() [3/3]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithStartDate ( const char *  value)
inline

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Definition at line 184 of file CreateMaintenanceWindowRequest.h.

◆ WithTags() [1/2]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Definition at line 603 of file CreateMaintenanceWindowRequest.h.

◆ WithTags() [2/2]

CreateMaintenanceWindowRequest& Aws::SSM::Model::CreateMaintenanceWindowRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Definition at line 617 of file CreateMaintenanceWindowRequest.h.


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