/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SSM { namespace Model { /** *

An array of search criteria that targets managed nodes 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 Amazon Web Services Region where the * association was created.

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

See Also:

AWS API * Reference

*/ class Target { public: AWS_SSM_API Target(); AWS_SSM_API Target(Aws::Utils::Json::JsonView jsonValue); AWS_SSM_API Target& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_SSM_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

User-defined criteria for sending commands that target managed nodes that * meet the criteria.

*/ inline const Aws::String& GetKey() const{ return m_key; } /** *

User-defined criteria for sending commands that target managed nodes that * meet the criteria.

*/ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** *

User-defined criteria for sending commands that target managed nodes that * meet the criteria.

*/ inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } /** *

User-defined criteria for sending commands that target managed nodes that * meet the criteria.

*/ inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } /** *

User-defined criteria for sending commands that target managed nodes that * meet the criteria.

*/ inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } /** *

User-defined criteria for sending commands that target managed nodes that * meet the criteria.

*/ inline Target& WithKey(const Aws::String& value) { SetKey(value); return *this;} /** *

User-defined criteria for sending commands that target managed nodes that * meet the criteria.

*/ inline Target& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} /** *

User-defined criteria for sending commands that target managed nodes that * meet the criteria.

*/ inline Target& WithKey(const char* value) { SetKey(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetValues() const{ return m_values; } /** *

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.

*/ inline bool ValuesHasBeenSet() const { return m_valuesHasBeenSet; } /** *

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.

*/ inline void SetValues(const Aws::Vector& value) { m_valuesHasBeenSet = true; m_values = value; } /** *

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.

*/ inline void SetValues(Aws::Vector&& value) { m_valuesHasBeenSet = true; m_values = std::move(value); } /** *

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.

*/ inline Target& WithValues(const Aws::Vector& value) { SetValues(value); return *this;} /** *

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.

*/ inline Target& WithValues(Aws::Vector&& value) { SetValues(std::move(value)); return *this;} /** *

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.

*/ inline Target& AddValues(const Aws::String& value) { m_valuesHasBeenSet = true; m_values.push_back(value); return *this; } /** *

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.

*/ inline Target& AddValues(Aws::String&& value) { m_valuesHasBeenSet = true; m_values.push_back(std::move(value)); return *this; } /** *

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.

*/ inline Target& AddValues(const char* value) { m_valuesHasBeenSet = true; m_values.push_back(value); return *this; } private: Aws::String m_key; bool m_keyHasBeenSet = false; Aws::Vector m_values; bool m_valuesHasBeenSet = false; }; } // namespace Model } // namespace SSM } // namespace Aws