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

#include <RegisterTargetWithMaintenanceWindowRequest.h>

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

Public Member Functions

 RegisterTargetWithMaintenanceWindowRequest ()
 
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)
 
RegisterTargetWithMaintenanceWindowRequestWithWindowId (const Aws::String &value)
 
RegisterTargetWithMaintenanceWindowRequestWithWindowId (Aws::String &&value)
 
RegisterTargetWithMaintenanceWindowRequestWithWindowId (const char *value)
 
const MaintenanceWindowResourceTypeGetResourceType () const
 
bool ResourceTypeHasBeenSet () const
 
void SetResourceType (const MaintenanceWindowResourceType &value)
 
void SetResourceType (MaintenanceWindowResourceType &&value)
 
RegisterTargetWithMaintenanceWindowRequestWithResourceType (const MaintenanceWindowResourceType &value)
 
RegisterTargetWithMaintenanceWindowRequestWithResourceType (MaintenanceWindowResourceType &&value)
 
const Aws::Vector< Target > & GetTargets () const
 
bool TargetsHasBeenSet () const
 
void SetTargets (const Aws::Vector< Target > &value)
 
void SetTargets (Aws::Vector< Target > &&value)
 
RegisterTargetWithMaintenanceWindowRequestWithTargets (const Aws::Vector< Target > &value)
 
RegisterTargetWithMaintenanceWindowRequestWithTargets (Aws::Vector< Target > &&value)
 
RegisterTargetWithMaintenanceWindowRequestAddTargets (const Target &value)
 
RegisterTargetWithMaintenanceWindowRequestAddTargets (Target &&value)
 
const Aws::StringGetOwnerInformation () const
 
bool OwnerInformationHasBeenSet () const
 
void SetOwnerInformation (const Aws::String &value)
 
void SetOwnerInformation (Aws::String &&value)
 
void SetOwnerInformation (const char *value)
 
RegisterTargetWithMaintenanceWindowRequestWithOwnerInformation (const Aws::String &value)
 
RegisterTargetWithMaintenanceWindowRequestWithOwnerInformation (Aws::String &&value)
 
RegisterTargetWithMaintenanceWindowRequestWithOwnerInformation (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
RegisterTargetWithMaintenanceWindowRequestWithName (const Aws::String &value)
 
RegisterTargetWithMaintenanceWindowRequestWithName (Aws::String &&value)
 
RegisterTargetWithMaintenanceWindowRequestWithName (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)
 
RegisterTargetWithMaintenanceWindowRequestWithDescription (const Aws::String &value)
 
RegisterTargetWithMaintenanceWindowRequestWithDescription (Aws::String &&value)
 
RegisterTargetWithMaintenanceWindowRequestWithDescription (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)
 
RegisterTargetWithMaintenanceWindowRequestWithClientToken (const Aws::String &value)
 
RegisterTargetWithMaintenanceWindowRequestWithClientToken (Aws::String &&value)
 
RegisterTargetWithMaintenanceWindowRequestWithClientToken (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 25 of file RegisterTargetWithMaintenanceWindowRequest.h.

Constructor & Destructor Documentation

◆ RegisterTargetWithMaintenanceWindowRequest()

Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::RegisterTargetWithMaintenanceWindowRequest ( )

Member Function Documentation

◆ AddTargets() [1/2]

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

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Definition at line 321 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ AddTargets() [2/2]

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

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Definition at line 351 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ ClientTokenHasBeenSet()

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

User-provided idempotency token.

Definition at line 493 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ DescriptionHasBeenSet()

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

An optional description for the target.

Definition at line 452 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ GetClientToken()

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

User-provided idempotency token.

Definition at line 488 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ GetDescription()

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

An optional description for the target.

Definition at line 447 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ GetName()

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

An optional name for the target.

Definition at line 406 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ GetOwnerInformation()

const Aws::String& Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::GetOwnerInformation ( ) const
inline

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Definition at line 358 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetResourceType()

const MaintenanceWindowResourceType& Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::GetResourceType ( ) const
inline

The type of target being registered with the maintenance window.

Definition at line 85 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ GetServiceRequestName()

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

◆ GetTargets()

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

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Definition at line 141 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ GetWindowId()

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

The ID of the maintenance window the target should be registered with.

Definition at line 44 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ NameHasBeenSet()

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

An optional name for the target.

Definition at line 411 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ OwnerInformationHasBeenSet()

bool Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::OwnerInformationHasBeenSet ( ) const
inline

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Definition at line 364 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ ResourceTypeHasBeenSet()

bool Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::ResourceTypeHasBeenSet ( ) const
inline

The type of target being registered with the maintenance window.

Definition at line 90 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

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

User-provided idempotency token.

Definition at line 503 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetClientToken() [2/3]

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

User-provided idempotency token.

Definition at line 498 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetClientToken() [3/3]

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

User-provided idempotency token.

Definition at line 508 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetDescription() [1/3]

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

An optional description for the target.

Definition at line 462 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetDescription() [2/3]

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

An optional description for the target.

Definition at line 457 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetDescription() [3/3]

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

An optional description for the target.

Definition at line 467 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetName() [1/3]

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

An optional name for the target.

Definition at line 421 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetName() [2/3]

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

An optional name for the target.

Definition at line 416 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetName() [3/3]

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

An optional name for the target.

Definition at line 426 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetOwnerInformation() [1/3]

void Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::SetOwnerInformation ( Aws::String &&  value)
inline

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Definition at line 376 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetOwnerInformation() [2/3]

void Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::SetOwnerInformation ( const Aws::String value)
inline

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Definition at line 370 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetOwnerInformation() [3/3]

void Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::SetOwnerInformation ( const char *  value)
inline

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Definition at line 382 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetResourceType() [1/2]

void Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::SetResourceType ( const MaintenanceWindowResourceType value)
inline

The type of target being registered with the maintenance window.

Definition at line 95 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetResourceType() [2/2]

void Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::SetResourceType ( MaintenanceWindowResourceType &&  value)
inline

The type of target being registered with the maintenance window.

Definition at line 100 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetTargets() [1/2]

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

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Definition at line 231 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetTargets() [2/2]

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

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Definition at line 201 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetWindowId() [1/3]

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

The ID of the maintenance window the target should be registered with.

Definition at line 59 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetWindowId() [2/3]

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

The ID of the maintenance window the target should be registered with.

Definition at line 54 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ SetWindowId() [3/3]

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

The ID of the maintenance window the target should be registered with.

Definition at line 64 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ TargetsHasBeenSet()

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

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Definition at line 171 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WindowIdHasBeenSet()

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

The ID of the maintenance window the target should be registered with.

Definition at line 49 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithClientToken() [1/3]

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

User-provided idempotency token.

Definition at line 518 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithClientToken() [2/3]

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

User-provided idempotency token.

Definition at line 513 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithClientToken() [3/3]

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

User-provided idempotency token.

Definition at line 523 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithDescription() [1/3]

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

An optional description for the target.

Definition at line 477 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithDescription() [2/3]

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

An optional description for the target.

Definition at line 472 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithDescription() [3/3]

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

An optional description for the target.

Definition at line 482 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithName() [1/3]

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

An optional name for the target.

Definition at line 436 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithName() [2/3]

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

An optional name for the target.

Definition at line 431 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithName() [3/3]

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

An optional name for the target.

Definition at line 441 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithOwnerInformation() [1/3]

RegisterTargetWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::WithOwnerInformation ( Aws::String &&  value)
inline

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Definition at line 394 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithOwnerInformation() [2/3]

RegisterTargetWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::WithOwnerInformation ( const Aws::String value)
inline

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Definition at line 388 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithOwnerInformation() [3/3]

RegisterTargetWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::WithOwnerInformation ( const char *  value)
inline

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Definition at line 400 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithResourceType() [1/2]

RegisterTargetWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::WithResourceType ( const MaintenanceWindowResourceType value)
inline

The type of target being registered with the maintenance window.

Definition at line 105 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithResourceType() [2/2]

RegisterTargetWithMaintenanceWindowRequest& Aws::SSM::Model::RegisterTargetWithMaintenanceWindowRequest::WithResourceType ( MaintenanceWindowResourceType &&  value)
inline

The type of target being registered with the maintenance window.

Definition at line 110 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithTargets() [1/2]

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

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Definition at line 291 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithTargets() [2/2]

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

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Definition at line 261 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithWindowId() [1/3]

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

The ID of the maintenance window the target should be registered with.

Definition at line 74 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithWindowId() [2/3]

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

The ID of the maintenance window the target should be registered with.

Definition at line 69 of file RegisterTargetWithMaintenanceWindowRequest.h.

◆ WithWindowId() [3/3]

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

The ID of the maintenance window the target should be registered with.

Definition at line 79 of file RegisterTargetWithMaintenanceWindowRequest.h.


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