Struct aws_sdk_ssm::types::Target

#[non_exhaustive]
pub struct Target {
    pub key: Option<String>,
    pub values: Option<Vec<String>>,
}

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.

For all Systems Manager capabilities:

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

For Automation and Change Manager:

• Key=tag:tag-key,Values=tag-value

• Key=ResourceGroup,Values=resource-group-name

• Key=ParameterValues,Values=value-1,value-2,value-3

• To target all instances in the Amazon Web Services Region:

  • Key=AWS::EC2::Instance,Values=*

  • Key=InstanceIds,Values=*

For Run Command and Maintenance Windows:

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

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

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

• Additionally, Maintenance Windows support targeting resource types:

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

For State Manager:

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

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

• To target all instances in the Amazon Web Services Region:

  • Key=InstanceIds,Values=*

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: Option<String>

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

values: Option<Vec<String>>

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.

Implementations

impl Target

pub fn key(&self) -> Option<&str>

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

pub fn values(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .values.is_none().

impl Target

pub fn builder() -> TargetBuilder

Creates a new builder-style object to manufacture Target.

Trait Implementations

impl Clone for Target

fn clone(&self) -> Target

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Target

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Target

fn eq(&self, other: &Target) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Target