File Coverage

blib/lib/Paws/EMR/RunJobFlow.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::EMR::RunJobFlow;
3 1     1   454 use Moose;
  1         3  
  1         8  
4             has AdditionalInfo => (is => 'ro', isa => 'Str');
5             has AmiVersion => (is => 'ro', isa => 'Str');
6             has Applications => (is => 'ro', isa => 'ArrayRef[Paws::EMR::Application]');
7             has AutoScalingRole => (is => 'ro', isa => 'Str');
8             has BootstrapActions => (is => 'ro', isa => 'ArrayRef[Paws::EMR::BootstrapActionConfig]');
9             has Configurations => (is => 'ro', isa => 'ArrayRef[Paws::EMR::Configuration]');
10             has CustomAmiId => (is => 'ro', isa => 'Str');
11             has EbsRootVolumeSize => (is => 'ro', isa => 'Int');
12             has Instances => (is => 'ro', isa => 'Paws::EMR::JobFlowInstancesConfig', required => 1);
13             has JobFlowRole => (is => 'ro', isa => 'Str');
14             has LogUri => (is => 'ro', isa => 'Str');
15             has Name => (is => 'ro', isa => 'Str', required => 1);
16             has NewSupportedProducts => (is => 'ro', isa => 'ArrayRef[Paws::EMR::SupportedProductConfig]');
17             has ReleaseLabel => (is => 'ro', isa => 'Str');
18             has RepoUpgradeOnBoot => (is => 'ro', isa => 'Str');
19             has ScaleDownBehavior => (is => 'ro', isa => 'Str');
20             has SecurityConfiguration => (is => 'ro', isa => 'Str');
21             has ServiceRole => (is => 'ro', isa => 'Str');
22             has Steps => (is => 'ro', isa => 'ArrayRef[Paws::EMR::StepConfig]');
23             has SupportedProducts => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
24             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::EMR::Tag]');
25             has VisibleToAllUsers => (is => 'ro', isa => 'Bool');
26              
27 1     1   5880 use MooseX::ClassAttribute;
  1         3  
  1         8  
28              
29             class_has _api_call => (isa => 'Str', is => 'ro', default => 'RunJobFlow');
30             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EMR::RunJobFlowOutput');
31             class_has _result_key => (isa => 'Str', is => 'ro');
32             1;
33              
34             ### main pod documentation begin ###
35              
36             =head1 NAME
37              
38             Paws::EMR::RunJobFlow - Arguments for method RunJobFlow on Paws::EMR
39              
40             =head1 DESCRIPTION
41              
42             This class represents the parameters used for calling the method RunJobFlow on the
43             Amazon Elastic MapReduce service. Use the attributes of this class
44             as arguments to method RunJobFlow.
45              
46             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RunJobFlow.
47              
48             As an example:
49              
50             $service_obj->RunJobFlow(Att1 => $value1, Att2 => $value2, ...);
51              
52             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.
53              
54             =head1 ATTRIBUTES
55              
56              
57             =head2 AdditionalInfo => Str
58              
59             A JSON string for selecting additional features.
60              
61              
62              
63             =head2 AmiVersion => Str
64              
65             For Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0
66             and later, the Linux AMI is determined by the C<ReleaseLabel> specified
67             or by C<CustomAmiID>. The version of the Amazon Machine Image (AMI) to
68             use when launching Amazon EC2 instances in the job flow. For details
69             about the AMI versions currently supported in EMR version 3.x and 2.x,
70             see AMI Versions Supported in EMR in the I<Amazon EMR Developer Guide>.
71              
72             If the AMI supports multiple versions of Hadoop (for example, AMI 1.0
73             supports both Hadoop 0.18 and 0.20), you can use the
74             JobFlowInstancesConfig C<HadoopVersion> parameter to modify the version
75             of Hadoop from the defaults shown above.
76              
77             Previously, the EMR AMI version API parameter options allowed you to
78             use latest for the latest AMI version rather than specify a numerical
79             value. Some regions no longer support this deprecated option as they
80             only have a newer release label version of EMR, which requires you to
81             specify an EMR release label release (EMR 4.x or later).
82              
83              
84              
85             =head2 Applications => ArrayRef[L<Paws::EMR::Application>]
86              
87             For Amazon EMR releases 4.0 and later. A list of applications for the
88             cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and
89             "Spark." They are case insensitive.
90              
91              
92              
93             =head2 AutoScalingRole => Str
94              
95             An IAM role for automatic scaling policies. The default role is
96             C<EMR_AutoScaling_DefaultRole>. The IAM role provides permissions that
97             the automatic scaling feature requires to launch and terminate EC2
98             instances in an instance group.
99              
100              
101              
102             =head2 BootstrapActions => ArrayRef[L<Paws::EMR::BootstrapActionConfig>]
103              
104             A list of bootstrap actions to run before Hadoop starts on the cluster
105             nodes.
106              
107              
108              
109             =head2 Configurations => ArrayRef[L<Paws::EMR::Configuration>]
110              
111             For Amazon EMR releases 4.0 and later. The list of configurations
112             supplied for the EMR cluster you are creating.
113              
114              
115              
116             =head2 CustomAmiId => Str
117              
118             Available only in Amazon EMR version 5.7.0 and later. The ID of a
119             custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this
120             AMI when it launches cluster EC2 instances. For more information about
121             custom AMIs in Amazon EMR, see Using a Custom AMI in the I<Amazon EMR
122             Management Guide>. If omitted, the cluster uses the base Linux AMI for
123             the C<ReleaseLabel> specified. For Amazon EMR versions 2.x and 3.x, use
124             C<AmiVersion> instead.
125              
126             For information about creating a custom AMI, see Creating an Amazon
127             EBS-Backed Linux AMI in the I<Amazon Elastic Compute Cloud User Guide
128             for Linux Instances>. For information about finding an AMI ID, see
129             Finding a Linux AMI.
130              
131              
132              
133             =head2 EbsRootVolumeSize => Int
134              
135             The size, in GiB, of the EBS root device volume of the Linux AMI that
136             is used for each EC2 instance. Available in Amazon EMR version 4.x and
137             later.
138              
139              
140              
141             =head2 B<REQUIRED> Instances => L<Paws::EMR::JobFlowInstancesConfig>
142              
143             A specification of the number and type of Amazon EC2 instances.
144              
145              
146              
147             =head2 JobFlowRole => Str
148              
149             Also called instance profile and EC2 role. An IAM role for an EMR
150             cluster. The EC2 instances of the cluster assume this role. The default
151             role is C<EMR_EC2_DefaultRole>. In order to use the default role, you
152             must have already created it using the CLI or console.
153              
154              
155              
156             =head2 LogUri => Str
157              
158             The location in Amazon S3 to write the log files of the job flow. If a
159             value is not provided, logs are not created.
160              
161              
162              
163             =head2 B<REQUIRED> Name => Str
164              
165             The name of the job flow.
166              
167              
168              
169             =head2 NewSupportedProducts => ArrayRef[L<Paws::EMR::SupportedProductConfig>]
170              
171             For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and
172             later, use Applications.
173              
174             A list of strings that indicates third-party software to use with the
175             job flow that accepts a user argument list. EMR accepts and forwards
176             the argument list to the corresponding installation script as bootstrap
177             action arguments. For more information, see "Launch a Job Flow on the
178             MapR Distribution for Hadoop" in the Amazon EMR Developer Guide.
179             Supported values are:
180              
181             =over
182              
183             =item *
184              
185             "mapr-m3" - launch the cluster using MapR M3 Edition.
186              
187             =item *
188              
189             "mapr-m5" - launch the cluster using MapR M5 Edition.
190              
191             =item *
192              
193             "mapr" with the user arguments specifying "--edition,m3" or
194             "--edition,m5" - launch the job flow using MapR M3 or M5 Edition
195             respectively.
196              
197             =item *
198              
199             "mapr-m7" - launch the cluster using MapR M7 Edition.
200              
201             =item *
202              
203             "hunk" - launch the cluster with the Hunk Big Data Analtics Platform.
204              
205             =item *
206              
207             "hue"- launch the cluster with Hue installed.
208              
209             =item *
210              
211             "spark" - launch the cluster with Apache Spark installed.
212              
213             =item *
214              
215             "ganglia" - launch the cluster with the Ganglia Monitoring System
216             installed.
217              
218             =back
219              
220              
221              
222              
223             =head2 ReleaseLabel => Str
224              
225             The release label for the Amazon EMR release. For Amazon EMR 3.x and
226             2.x AMIs, use C<AmiVersion> instead.
227              
228              
229              
230             =head2 RepoUpgradeOnBoot => Str
231              
232             Applies only when C<CustomAmiID> is used. Specifies which updates from
233             the Amazon Linux AMI package repositories to apply automatically when
234             the instance boots using the AMI. If omitted, the default is
235             C<SECURITY>, which indicates that only security updates are applied. If
236             C<NONE> is specified, no updates are applied, and all updates must be
237             applied manually.
238              
239             Valid values are: C<"SECURITY">, C<"NONE">
240              
241             =head2 ScaleDownBehavior => Str
242              
243             Specifies the way that individual Amazon EC2 instances terminate when
244             an automatic scale-in activity occurs or an instance group is resized.
245             C<TERMINATE_AT_INSTANCE_HOUR> indicates that Amazon EMR terminates
246             nodes at the instance-hour boundary, regardless of when the request to
247             terminate the instance was submitted. This option is only available
248             with Amazon EMR 5.1.0 and later and is the default for clusters created
249             using that version. C<TERMINATE_AT_TASK_COMPLETION> indicates that
250             Amazon EMR blacklists and drains tasks from nodes before terminating
251             the Amazon EC2 instances, regardless of the instance-hour boundary.
252             With either behavior, Amazon EMR removes the least active nodes first
253             and blocks instance termination if it could lead to HDFS corruption.
254             C<TERMINATE_AT_TASK_COMPLETION> available only in Amazon EMR version
255             4.1.0 and later, and is the default for versions of Amazon EMR earlier
256             than 5.1.0.
257              
258             Valid values are: C<"TERMINATE_AT_INSTANCE_HOUR">, C<"TERMINATE_AT_TASK_COMPLETION">
259              
260             =head2 SecurityConfiguration => Str
261              
262             The name of a security configuration to apply to the cluster.
263              
264              
265              
266             =head2 ServiceRole => Str
267              
268             The IAM role that will be assumed by the Amazon EMR service to access
269             AWS resources on your behalf.
270              
271              
272              
273             =head2 Steps => ArrayRef[L<Paws::EMR::StepConfig>]
274              
275             A list of steps to run.
276              
277              
278              
279             =head2 SupportedProducts => ArrayRef[Str|Undef]
280              
281             For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and
282             later, use Applications.
283              
284             A list of strings that indicates third-party software to use. For more
285             information, see Use Third Party Applications with Amazon EMR.
286             Currently supported values are:
287              
288             =over
289              
290             =item *
291              
292             "mapr-m3" - launch the job flow using MapR M3 Edition.
293              
294             =item *
295              
296             "mapr-m5" - launch the job flow using MapR M5 Edition.
297              
298             =back
299              
300              
301              
302              
303             =head2 Tags => ArrayRef[L<Paws::EMR::Tag>]
304              
305             A list of tags to associate with a cluster and propagate to Amazon EC2
306             instances.
307              
308              
309              
310             =head2 VisibleToAllUsers => Bool
311              
312             Whether the cluster is visible to all IAM users of the AWS account
313             associated with the cluster. If this value is set to C<true>, all IAM
314             users of that AWS account can view and (if they have the proper policy
315             permissions set) manage the cluster. If it is set to C<false>, only the
316             IAM user that created the cluster can view and manage it.
317              
318              
319              
320              
321             =head1 SEE ALSO
322              
323             This class forms part of L<Paws>, documenting arguments for method RunJobFlow in L<Paws::EMR>
324              
325             =head1 BUGS and CONTRIBUTIONS
326              
327             The source code is located here: https://github.com/pplu/aws-sdk-perl
328              
329             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
330              
331             =cut
332