/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SSM::CreateMaintenanceWindow

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $ssm = Paws->service('SSM');
my $CreateMaintenanceWindowResult = $ssm->CreateMaintenanceWindow(
  AllowUnassociatedTargets => 1,
  Cutoff                   => 1,
  Duration                 => 1,
  Name                     => 'MyMaintenanceWindowName',
  Schedule                 => 'MyMaintenanceWindowSchedule',
  ClientToken              => 'MyClientToken',                    # OPTIONAL
  Description              => 'MyMaintenanceWindowDescription',   # OPTIONAL
  EndDate          => 'MyMaintenanceWindowStringDateTime',        # OPTIONAL
  ScheduleOffset   => 1,                                          # OPTIONAL
  ScheduleTimezone => 'MyMaintenanceWindowTimezone',              # OPTIONAL
  StartDate        => 'MyMaintenanceWindowStringDateTime',        # OPTIONAL
  Tags             => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # min: 1, max: 256

    },
    ...
  ],    # OPTIONAL
);

# Results:
my $WindowId = $CreateMaintenanceWindowResult->WindowId;

# Returns a L<Paws::SSM::CreateMaintenanceWindowResult> 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/CreateMaintenanceWindow

ATTRIBUTES

REQUIRED AllowUnassociatedTargets => Bool

Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

ClientToken => Str

User-provided idempotency token.

REQUIRED Cutoff => Int

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Description => Str

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

REQUIRED Duration => Int

The duration of the maintenance window in hours.

EndDate => Str

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

REQUIRED Name => Str

The name of the maintenance window.

REQUIRED Schedule => Str

The schedule of the maintenance window in the form of a cron or rate expression.

ScheduleOffset => Int

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

ScheduleTimezone => Str

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database (https://www.iana.org/time-zones) on the IANA website.

StartDate => Str

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Tags => ArrayRef[Paws::SSM::Tag]

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateMaintenanceWindow in Paws::SSM

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