@aws-sdk/client-ssm

RegisterTargetWithMaintenanceWindowCommandInput Interface

The input for RegisterTargetWithMaintenanceWindowCommand.

Members

Name
Type
Details
ResourceType RequiredMaintenanceWindowResourceType | undefined

The type of target being registered with the maintenance window.

Targets RequiredTarget[] | undefined

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=,,

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

Key=tag:,Values=,

Example 3: Use tag-keys applied to managed nodes

Key=tag-key,Values=,

Example 4: Use resource group names

Key=resource-groups:Name,Values=

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=,

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.

WindowId Requiredstring | undefined

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

ClientToken string | undefined

User-provided idempotency token.

Description string | undefined

An optional description for the target.

Name string | undefined

An optional name for the target.

OwnerInformation string | undefined

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

Full Signature

export interface RegisterTargetWithMaintenanceWindowCommandInput extends RegisterTargetWithMaintenanceWindowRequest