NAME

Paws::SSM::RegisterTargetWithMaintenanceWindow - Arguments for method RegisterTargetWithMaintenanceWindow on Paws::SSM

DESCRIPTION

This class represents the parameters used for calling the method RegisterTargetWithMaintenanceWindow on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method RegisterTargetWithMaintenanceWindow.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterTargetWithMaintenanceWindow.

SYNOPSIS

    my $ssm = Paws->service('SSM');
    my $RegisterTargetWithMaintenanceWindowResult =
      $ssm->RegisterTargetWithMaintenanceWindow(
      ResourceType => 'INSTANCE',
      Targets      => [
        {
          Key    => 'MyTargetKey',               # min: 1, max: 163; OPTIONAL
          Values => [ 'MyTargetValue', ... ],    # max: 50; OPTIONAL
        },
        ...
      ],
      WindowId         => 'MyMaintenanceWindowId',
      ClientToken      => 'MyClientToken',                     # OPTIONAL
      Description      => 'MyMaintenanceWindowDescription',    # OPTIONAL
      Name             => 'MyMaintenanceWindowName',           # OPTIONAL
      OwnerInformation => 'MyOwnerInformation',                # OPTIONAL
      );
    # Results:
    my $WindowTargetId =
      $RegisterTargetWithMaintenanceWindowResult->WindowTargetId;
    # Returns a L<Paws::SSM::RegisterTargetWithMaintenanceWindowResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ssm/RegisterTargetWithMaintenanceWindow>

ATTRIBUTES

ClientToken => Str

User-provided idempotency token.

Description => Str

An optional description for the target.

Name => Str

An optional name for the target.

OwnerInformation => Str

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

REQUIRED ResourceType => Str

The type of target being registered with the maintenance window.

Valid values are: "INSTANCE", "RESOURCE_GROUP"

REQUIRED Targets => ArrayRef[Paws::SSM::Target]

The targets to register with the maintenance window. In other words, the instances 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 instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

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

Example 2: Use tag key-pairs applied to instances

"Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2"

Example 3: Use tag-keys applied to instances

"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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html) in the AWS Systems Manager User Guide.

REQUIRED WindowId => Str

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>