Register Target With Maintenance Window

ssm_register_target_with_maintenance_window

R Documentation

Registers a target with a maintenance window

Description

Registers a target with a maintenance window.

Usage

ssm_register_target_with_maintenance_window(WindowId, ResourceType,
  Targets, OwnerInformation, Name, Description, ClientToken)

Arguments

WindowId

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

ResourceType

[required] The type of target being registered with the maintenance window.

Targets

[required] The targets to register with the maintenance window. In other words, the managed nodes 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 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>⁠

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

OwnerInformation

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

Name

An optional name for the target.

Description

An optional description for the target.

ClientToken

User-provided idempotency token.

Value

A list with the following syntax:

list(
  WindowTargetId = "string"
)

Request syntax

svc$register_target_with_maintenance_window(
  WindowId = "string",
  ResourceType = "INSTANCE"|"RESOURCE_GROUP",
  Targets = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  OwnerInformation = "string",
  Name = "string",
  Description = "string",
  ClientToken = "string"
)