« blib/lib/Paws/ImageBuilder/S3Logs.pm
↑ Summary
blib/lib/Paws/ImageBuilder/StartImagePipelineExecution.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ImageBuilder::Schedule; | ||
| 3 | use Moose; | ||
| 4 | has PipelineExecutionStartCondition => (is => 'ro', isa => 'Str', request_name => 'pipelineExecutionStartCondition', traits => ['NameInRequest']); | ||
| 5 | has ScheduleExpression => (is => 'ro', isa => 'Str', request_name => 'scheduleExpression', traits => ['NameInRequest']); | ||
| 6 | has Timezone => (is => 'ro', isa => 'Str', request_name => 'timezone', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ImageBuilder::Schedule | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::ImageBuilder::Schedule object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { PipelineExecutionStartCondition => $value, ..., Timezone => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::ImageBuilder::Schedule object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->PipelineExecutionStartCondition | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | A schedule configures how often and when a pipeline will automatically | ||
| 39 | create a new image. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 PipelineExecutionStartCondition => Str | ||
| 45 | |||
| 46 | The condition configures when the pipeline should trigger a new image | ||
| 47 | build. When the C<pipelineExecutionStartCondition> is set to | ||
| 48 | C<EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE>, and you use | ||
| 49 | semantic version filters on the source image or components in your | ||
| 50 | image recipe, EC2 Image Builder will build a new image only when there | ||
| 51 | are new versions of the image or components in your recipe that match | ||
| 52 | the semantic version filter. When it is set to | ||
| 53 | C<EXPRESSION_MATCH_ONLY>, it will build a new image every time the CRON | ||
| 54 | expression matches the current time. For semantic version syntax, see | ||
| 55 | CreateComponent | ||
| 56 | (https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) | ||
| 57 | in the I< EC2 Image Builder API Reference>. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ScheduleExpression => Str | ||
| 61 | |||
| 62 | The cron expression determines how often EC2 Image Builder evaluates | ||
| 63 | your C<pipelineExecutionStartCondition>. | ||
| 64 | |||
| 65 | For information on how to format a cron expression in Image Builder, | ||
| 66 | see Use cron expressions in EC2 Image Builder | ||
| 67 | (https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html). | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Timezone => Str | ||
| 71 | |||
| 72 | The timezone that applies to the scheduling expression. For example, | ||
| 73 | "Etc/UTC", "America/Los_Angeles" in the IANA timezone format | ||
| 74 | (https://www.joda.org/joda-time/timezones.html). If not specified this | ||
| 75 | defaults to UTC. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, describing an object used in L<Paws::ImageBuilder> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |