« blib/lib/Paws/SSM/UpdateDocumentResult.pm
↑ Summary
blib/lib/Paws/SSM/UpdateMaintenanceWindowResult.pm »
| 1 | |||
| 2 | package Paws::SSM::UpdateMaintenanceWindow; | ||
| 3 | use Moose; | ||
| 4 | has AllowUnassociatedTargets => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Cutoff => (is => 'ro', isa => 'Int'); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has Duration => (is => 'ro', isa => 'Int'); | ||
| 8 | has Enabled => (is => 'ro', isa => 'Bool'); | ||
| 9 | has EndDate => (is => 'ro', isa => 'Str'); | ||
| 10 | has Name => (is => 'ro', isa => 'Str'); | ||
| 11 | has Replace => (is => 'ro', isa => 'Bool'); | ||
| 12 | has Schedule => (is => 'ro', isa => 'Str'); | ||
| 13 | has ScheduleOffset => (is => 'ro', isa => 'Int'); | ||
| 14 | has ScheduleTimezone => (is => 'ro', isa => 'Str'); | ||
| 15 | has StartDate => (is => 'ro', isa => 'Str'); | ||
| 16 | has WindowId => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateMaintenanceWindow'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::UpdateMaintenanceWindowResult'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::SSM::UpdateMaintenanceWindow - Arguments for method UpdateMaintenanceWindow on L<Paws::SSM> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method UpdateMaintenanceWindow on the | ||
| 34 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 35 | as arguments to method UpdateMaintenanceWindow. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateMaintenanceWindow. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $ssm = Paws->service('SSM'); | ||
| 42 | my $UpdateMaintenanceWindowResult = $ssm->UpdateMaintenanceWindow( | ||
| 43 | WindowId => 'MyMaintenanceWindowId', | ||
| 44 | AllowUnassociatedTargets => 1, # OPTIONAL | ||
| 45 | Cutoff => 1, # OPTIONAL | ||
| 46 | Description => 'MyMaintenanceWindowDescription', # OPTIONAL | ||
| 47 | Duration => 1, # OPTIONAL | ||
| 48 | Enabled => 1, # OPTIONAL | ||
| 49 | EndDate => 'MyMaintenanceWindowStringDateTime', # OPTIONAL | ||
| 50 | Name => 'MyMaintenanceWindowName', # OPTIONAL | ||
| 51 | Replace => 1, # OPTIONAL | ||
| 52 | Schedule => 'MyMaintenanceWindowSchedule', # OPTIONAL | ||
| 53 | ScheduleOffset => 1, # OPTIONAL | ||
| 54 | ScheduleTimezone => 'MyMaintenanceWindowTimezone', # OPTIONAL | ||
| 55 | StartDate => 'MyMaintenanceWindowStringDateTime', # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $AllowUnassociatedTargets = | ||
| 60 | $UpdateMaintenanceWindowResult->AllowUnassociatedTargets; | ||
| 61 | my $Cutoff = $UpdateMaintenanceWindowResult->Cutoff; | ||
| 62 | my $Description = $UpdateMaintenanceWindowResult->Description; | ||
| 63 | my $Duration = $UpdateMaintenanceWindowResult->Duration; | ||
| 64 | my $Enabled = $UpdateMaintenanceWindowResult->Enabled; | ||
| 65 | my $EndDate = $UpdateMaintenanceWindowResult->EndDate; | ||
| 66 | my $Name = $UpdateMaintenanceWindowResult->Name; | ||
| 67 | my $Schedule = $UpdateMaintenanceWindowResult->Schedule; | ||
| 68 | my $ScheduleOffset = $UpdateMaintenanceWindowResult->ScheduleOffset; | ||
| 69 | my $ScheduleTimezone = $UpdateMaintenanceWindowResult->ScheduleTimezone; | ||
| 70 | my $StartDate = $UpdateMaintenanceWindowResult->StartDate; | ||
| 71 | my $WindowId = $UpdateMaintenanceWindowResult->WindowId; | ||
| 72 | |||
| 73 | # Returns a L<Paws::SSM::UpdateMaintenanceWindowResult> object. | ||
| 74 | |||
| 75 | 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. | ||
| 76 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/UpdateMaintenanceWindow> | ||
| 77 | |||
| 78 | =head1 ATTRIBUTES | ||
| 79 | |||
| 80 | |||
| 81 | =head2 AllowUnassociatedTargets => Bool | ||
| 82 | |||
| 83 | Whether targets must be registered with the maintenance window before | ||
| 84 | tasks can be defined for those targets. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Cutoff => Int | ||
| 89 | |||
| 90 | The number of hours before the end of the maintenance window that | ||
| 91 | Systems Manager stops scheduling new tasks for execution. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 Description => Str | ||
| 96 | |||
| 97 | An optional description for the update request. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 Duration => Int | ||
| 102 | |||
| 103 | The duration of the maintenance window in hours. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 Enabled => Bool | ||
| 108 | |||
| 109 | Whether the maintenance window is enabled. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 EndDate => Str | ||
| 114 | |||
| 115 | The date and time, in ISO-8601 Extended format, for when you want the | ||
| 116 | maintenance window to become inactive. EndDate allows you to set a date | ||
| 117 | and time in the future when the maintenance window will no longer run. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 Name => Str | ||
| 122 | |||
| 123 | The name of the maintenance window. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 Replace => Bool | ||
| 128 | |||
| 129 | If True, then all fields that are required by the | ||
| 130 | CreateMaintenanceWindow action are also required for this API request. | ||
| 131 | Optional fields that are not specified are set to null. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 Schedule => Str | ||
| 136 | |||
| 137 | The schedule of the maintenance window in the form of a cron or rate | ||
| 138 | expression. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 ScheduleOffset => Int | ||
| 143 | |||
| 144 | The number of days to wait after the date and time specified by a CRON | ||
| 145 | expression before running the maintenance window. | ||
| 146 | |||
| 147 | For example, the following cron expression schedules a maintenance | ||
| 148 | window to run the third Tuesday of every month at 11:30 PM. | ||
| 149 | |||
| 150 | C<cron(30 23 ? * TUE#3 *)> | ||
| 151 | |||
| 152 | If the schedule offset is C<2>, the maintenance window won't run until | ||
| 153 | two days later. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 ScheduleTimezone => Str | ||
| 158 | |||
| 159 | The time zone that the scheduled maintenance window executions are | ||
| 160 | based on, in Internet Assigned Numbers Authority (IANA) format. For | ||
| 161 | example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more | ||
| 162 | information, see the Time Zone Database | ||
| 163 | (https://www.iana.org/time-zones) on the IANA website. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head2 StartDate => Str | ||
| 168 | |||
| 169 | The time zone that the scheduled maintenance window executions are | ||
| 170 | based on, in Internet Assigned Numbers Authority (IANA) format. For | ||
| 171 | example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more | ||
| 172 | information, see the Time Zone Database | ||
| 173 | (https://www.iana.org/time-zones) on the IANA website. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 B<REQUIRED> WindowId => Str | ||
| 178 | |||
| 179 | The ID of the maintenance window to update. | ||
| 180 | |||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | =head1 SEE ALSO | ||
| 185 | |||
| 186 | This class forms part of L<Paws>, documenting arguments for method UpdateMaintenanceWindow in L<Paws::SSM> | ||
| 187 | |||
| 188 | =head1 BUGS and CONTRIBUTIONS | ||
| 189 | |||
| 190 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 191 | |||
| 192 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 193 | |||
| 194 | =cut | ||
| 195 |