« blib/lib/Paws/SSM/CreateDocumentResult.pm
↑ Summary
blib/lib/Paws/SSM/CreateMaintenanceWindowResult.pm »
| 1 | |||
| 2 | package Paws::SSM::CreateMaintenanceWindow; | ||
| 3 | use Moose; | ||
| 4 | has AllowUnassociatedTargets => (is => 'ro', isa => 'Bool', required => 1); | ||
| 5 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has Cutoff => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | has Description => (is => 'ro', isa => 'Str'); | ||
| 8 | has Duration => (is => 'ro', isa => 'Int', required => 1); | ||
| 9 | has EndDate => (is => 'ro', isa => 'Str'); | ||
| 10 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has Schedule => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has ScheduleOffset => (is => 'ro', isa => 'Int'); | ||
| 13 | has ScheduleTimezone => (is => 'ro', isa => 'Str'); | ||
| 14 | has StartDate => (is => 'ro', isa => 'Str'); | ||
| 15 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Tag]'); | ||
| 16 | |||
| 17 | use MooseX::ClassAttribute; | ||
| 18 | |||
| 19 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateMaintenanceWindow'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::CreateMaintenanceWindowResult'); | ||
| 21 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::SSM::CreateMaintenanceWindow - Arguments for method CreateMaintenanceWindow on L<Paws::SSM> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method CreateMaintenanceWindow on the | ||
| 33 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 34 | as arguments to method CreateMaintenanceWindow. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMaintenanceWindow. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $ssm = Paws->service('SSM'); | ||
| 41 | my $CreateMaintenanceWindowResult = $ssm->CreateMaintenanceWindow( | ||
| 42 | AllowUnassociatedTargets => 1, | ||
| 43 | Cutoff => 1, | ||
| 44 | Duration => 1, | ||
| 45 | Name => 'MyMaintenanceWindowName', | ||
| 46 | Schedule => 'MyMaintenanceWindowSchedule', | ||
| 47 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 48 | Description => 'MyMaintenanceWindowDescription', # OPTIONAL | ||
| 49 | EndDate => 'MyMaintenanceWindowStringDateTime', # OPTIONAL | ||
| 50 | ScheduleOffset => 1, # OPTIONAL | ||
| 51 | ScheduleTimezone => 'MyMaintenanceWindowTimezone', # OPTIONAL | ||
| 52 | StartDate => 'MyMaintenanceWindowStringDateTime', # OPTIONAL | ||
| 53 | Tags => [ | ||
| 54 | { | ||
| 55 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 56 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 57 | |||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | ); | ||
| 62 | |||
| 63 | # Results: | ||
| 64 | my $WindowId = $CreateMaintenanceWindowResult->WindowId; | ||
| 65 | |||
| 66 | # Returns a L<Paws::SSM::CreateMaintenanceWindowResult> object. | ||
| 67 | |||
| 68 | 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. | ||
| 69 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/CreateMaintenanceWindow> | ||
| 70 | |||
| 71 | =head1 ATTRIBUTES | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> AllowUnassociatedTargets => Bool | ||
| 75 | |||
| 76 | Enables a maintenance window task to run on managed instances, even if | ||
| 77 | you have not registered those instances as targets. If enabled, then | ||
| 78 | you must specify the unregistered instances (by instance ID) when you | ||
| 79 | register a task with the maintenance window. | ||
| 80 | |||
| 81 | If you don't enable this option, then you must specify | ||
| 82 | previously-registered targets when you register a task with the | ||
| 83 | maintenance window. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 ClientToken => Str | ||
| 88 | |||
| 89 | User-provided idempotency token. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> Cutoff => Int | ||
| 94 | |||
| 95 | The number of hours before the end of the maintenance window that | ||
| 96 | Systems Manager stops scheduling new tasks for execution. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 Description => Str | ||
| 101 | |||
| 102 | An optional description for the maintenance window. We recommend | ||
| 103 | specifying a description to help you organize your maintenance windows. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> Duration => Int | ||
| 108 | |||
| 109 | The duration of the maintenance window in hours. | ||
| 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 B<REQUIRED> Name => Str | ||
| 122 | |||
| 123 | The name of the maintenance window. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> Schedule => Str | ||
| 128 | |||
| 129 | The schedule of the maintenance window in the form of a cron or rate | ||
| 130 | expression. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 ScheduleOffset => Int | ||
| 135 | |||
| 136 | The number of days to wait after the date and time specified by a CRON | ||
| 137 | expression before running the maintenance window. | ||
| 138 | |||
| 139 | For example, the following cron expression schedules a maintenance | ||
| 140 | window to run on the third Tuesday of every month at 11:30 PM. | ||
| 141 | |||
| 142 | C<cron(30 23 ? * TUE#3 *)> | ||
| 143 | |||
| 144 | If the schedule offset is C<2>, the maintenance window won't run until | ||
| 145 | two days later. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 ScheduleTimezone => Str | ||
| 150 | |||
| 151 | The time zone that the scheduled maintenance window executions are | ||
| 152 | based on, in Internet Assigned Numbers Authority (IANA) format. For | ||
| 153 | example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more | ||
| 154 | information, see the Time Zone Database | ||
| 155 | (https://www.iana.org/time-zones) on the IANA website. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 StartDate => Str | ||
| 160 | |||
| 161 | The date and time, in ISO-8601 Extended format, for when you want the | ||
| 162 | maintenance window to become active. StartDate allows you to delay | ||
| 163 | activation of the maintenance window until the specified future date. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head2 Tags => ArrayRef[L<Paws::SSM::Tag>] | ||
| 168 | |||
| 169 | Optional metadata that you assign to a resource. Tags enable you to | ||
| 170 | categorize a resource in different ways, such as by purpose, owner, or | ||
| 171 | environment. For example, you might want to tag a maintenance window to | ||
| 172 | identify the type of tasks it will run, the types of targets, and the | ||
| 173 | environment it will run in. In this case, you could specify the | ||
| 174 | following key name/value pairs: | ||
| 175 | |||
| 176 | =over | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | C<Key=TaskType,Value=AgentUpdate> | ||
| 181 | |||
| 182 | =item * | ||
| 183 | |||
| 184 | C<Key=OS,Value=Windows> | ||
| 185 | |||
| 186 | =item * | ||
| 187 | |||
| 188 | C<Key=Environment,Value=Production> | ||
| 189 | |||
| 190 | =back | ||
| 191 | |||
| 192 | To add tags to an existing maintenance window, use the | ||
| 193 | AddTagsToResource action. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head1 SEE ALSO | ||
| 199 | |||
| 200 | This class forms part of L<Paws>, documenting arguments for method CreateMaintenanceWindow in L<Paws::SSM> | ||
| 201 | |||
| 202 | =head1 BUGS and CONTRIBUTIONS | ||
| 203 | |||
| 204 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 205 | |||
| 206 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 207 | |||
| 208 | =cut | ||
| 209 |