Class: Aws::SSM::Types::RegisterTargetWithMaintenanceWindowRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::RegisterTargetWithMaintenanceWindowRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:owner_information, :description]

Instance Attribute Summary

• #client_token ⇒ String

  User-provided idempotency token.

• #description ⇒ String

  An optional description for the target.

• #name ⇒ String

  An optional name for the target.

• #owner_information ⇒ String

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

• #resource_type ⇒ String

  The type of target being registered with the maintenance window.

• #targets ⇒ Array<Types::Target>

  The targets to register with the maintenance window.

• #window_id ⇒ String

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

Instance Attribute Details

#client_token ⇒ String

User-provided idempotency token.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 16246

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:owner_information, :description]
  include Aws::Structure
end

#description ⇒ String

An optional description for the target.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 16246

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:owner_information, :description]
  include Aws::Structure
end

#name ⇒ String

An optional name for the target.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 16246

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:owner_information, :description]
  include Aws::Structure
end

#owner_information ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 16246

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:owner_information, :description]
  include Aws::Structure
end

#resource_type ⇒ String

The type of target being registered with the maintenance window.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 16246

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:owner_information, :description]
  include Aws::Structure
end

#targets ⇒ Array<Types::Target>

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

<note markdown=“1”> 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.

</note>

You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

**Example 1**: Specify managed node IDs

‘Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`

**Example 2**: Use tag key-pairs applied to managed nodes

‘Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>`

**Example 3**: Use tag-keys applied to managed nodes

‘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>`

<note markdown=“1”> For ‘Key=resource-groups:ResourceTypeFilters`, specify resource types in the following format

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

</note>

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 *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html

Returns:

• (Array<Types::Target>)

# File 'lib/aws-sdk-ssm/types.rb', line 16246

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:owner_information, :description]
  include Aws::Structure
end

#window_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 16246

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:owner_information, :description]
  include Aws::Structure
end