Aws::SSM::Model::Target Class Reference

#include <Target.h>

Public Member Functions
	Target ()
	Target (Aws::Utils::Json::JsonView jsonValue)
Target &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
const Aws::String &	GetKey () const
bool	KeyHasBeenSet () const
void	SetKey (const Aws::String &value)
void	SetKey (Aws::String &&value)
void	SetKey (const char *value)
Target &	WithKey (const Aws::String &value)
Target &	WithKey (Aws::String &&value)
Target &	WithKey (const char *value)
const Aws::Vector< Aws::String > &	GetValues () const
bool	ValuesHasBeenSet () const
void	SetValues (const Aws::Vector< Aws::String > &value)
void	SetValues (Aws::Vector< Aws::String > &&value)
Target &	WithValues (const Aws::Vector< Aws::String > &value)
Target &	WithValues (Aws::Vector< Aws::String > &&value)
Target &	AddValues (const Aws::String &value)
Target &	AddValues (Aws::String &&value)
Target &	AddValues (const char *value)

Detailed Description

An array of search criteria that targets instances using a key-value pair that you specify.

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.

Supported formats include the following.

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

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

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

• Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=resource-group-name

• Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

• Automation targets only: Key=ResourceGroup;Values=resource-group-name

For example:

• Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

• Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3

• Key=tag-key,Values=Name,Instance-Type,CostCenter

• Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup

  This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

• Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

  This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.

• Automation targets only: Key=ResourceGroup,Values=MyResourceGroup

• State Manager association targets only: Key=InstanceIds,Values=*

  This example demonstrates how to target all managed instances in the Region where the association was created.

For more information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.

See Also:

AWS API Reference

Definition at line 75 of file Target.h.

Constructor & Destructor Documentation

Target() [1/2]

Aws::SSM::Model::Target::Target

(

)

Target() [2/2]

Aws::SSM::Model::Target::Target

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

AddValues() [1/3]

Target& Aws::SSM::Model::Target::AddValues ( Aws::String &&  value )

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 211 of file Target.h.

AddValues() [2/3]

Target& Aws::SSM::Model::Target::AddValues ( const Aws::String &  value )

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 201 of file Target.h.

AddValues() [3/3]

Target& Aws::SSM::Model::Target::AddValues ( const char *  value )

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 221 of file Target.h.

GetKey()

const Aws::String& Aws::SSM::Model::Target::GetKey ( ) const

inline

User-defined criteria for sending commands that target instances that meet the criteria.

Definition at line 88 of file Target.h.

GetValues()

const Aws::Vector<Aws::String>& Aws::SSM::Model::Target::GetValues ( ) const

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 141 of file Target.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::SSM::Model::Target::Jsonize

(

)

const

KeyHasBeenSet()

bool Aws::SSM::Model::Target::KeyHasBeenSet ( ) const

inline

User-defined criteria for sending commands that target instances that meet the criteria.

Definition at line 94 of file Target.h.

operator=()

Target& Aws::SSM::Model::Target::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

SetKey() [1/3]

void Aws::SSM::Model::Target::SetKey ( Aws::String &&  value )

inline

User-defined criteria for sending commands that target instances that meet the criteria.

Definition at line 106 of file Target.h.

SetKey() [2/3]

void Aws::SSM::Model::Target::SetKey ( const Aws::String &  value )

inline

User-defined criteria for sending commands that target instances that meet the criteria.

Definition at line 100 of file Target.h.

SetKey() [3/3]

void Aws::SSM::Model::Target::SetKey ( const char *  value )

inline

User-defined criteria for sending commands that target instances that meet the criteria.

Definition at line 112 of file Target.h.

SetValues() [1/2]

void Aws::SSM::Model::Target::SetValues ( Aws::Vector< Aws::String > &&  value )

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 171 of file Target.h.

SetValues() [2/2]

void Aws::SSM::Model::Target::SetValues ( const Aws::Vector< Aws::String > &  value )

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 161 of file Target.h.

ValuesHasBeenSet()

bool Aws::SSM::Model::Target::ValuesHasBeenSet ( ) const

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 151 of file Target.h.

WithKey() [1/3]

Target& Aws::SSM::Model::Target::WithKey ( Aws::String &&  value )

inline

User-defined criteria for sending commands that target instances that meet the criteria.

Definition at line 124 of file Target.h.

WithKey() [2/3]

Target& Aws::SSM::Model::Target::WithKey ( const Aws::String &  value )

inline

User-defined criteria for sending commands that target instances that meet the criteria.

Definition at line 118 of file Target.h.

WithKey() [3/3]

Target& Aws::SSM::Model::Target::WithKey ( const char *  value )

inline

User-defined criteria for sending commands that target instances that meet the criteria.

Definition at line 130 of file Target.h.

WithValues() [1/2]

Target& Aws::SSM::Model::Target::WithValues ( Aws::Vector< Aws::String > &&  value )

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 191 of file Target.h.

WithValues() [2/2]

Target& Aws::SSM::Model::Target::WithValues ( const Aws::Vector< Aws::String > &  value )

inline

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Definition at line 181 of file Target.h.

---

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

• aws-cpp-sdk-ssm/include/aws/ssm/model/Target.h