File Coverage

blib/lib/Paws/EMR/Cluster.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::EMR::Cluster;
2 1     1   379 use Moose;
  1         3  
  1         6  
3             has Applications => (is => 'ro', isa => 'ArrayRef[Paws::EMR::Application]');
4             has AutoScalingRole => (is => 'ro', isa => 'Str');
5             has AutoTerminate => (is => 'ro', isa => 'Bool');
6             has Configurations => (is => 'ro', isa => 'ArrayRef[Paws::EMR::Configuration]');
7             has CustomAmiId => (is => 'ro', isa => 'Str');
8             has EbsRootVolumeSize => (is => 'ro', isa => 'Int');
9             has Ec2InstanceAttributes => (is => 'ro', isa => 'Paws::EMR::Ec2InstanceAttributes');
10             has Id => (is => 'ro', isa => 'Str');
11             has InstanceCollectionType => (is => 'ro', isa => 'Str');
12             has LogUri => (is => 'ro', isa => 'Str');
13             has MasterPublicDnsName => (is => 'ro', isa => 'Str');
14             has Name => (is => 'ro', isa => 'Str');
15             has NormalizedInstanceHours => (is => 'ro', isa => 'Int');
16             has ReleaseLabel => (is => 'ro', isa => 'Str');
17             has RepoUpgradeOnBoot => (is => 'ro', isa => 'Str');
18             has RequestedAmiVersion => (is => 'ro', isa => 'Str');
19             has RunningAmiVersion => (is => 'ro', isa => 'Str');
20             has ScaleDownBehavior => (is => 'ro', isa => 'Str');
21             has SecurityConfiguration => (is => 'ro', isa => 'Str');
22             has ServiceRole => (is => 'ro', isa => 'Str');
23             has Status => (is => 'ro', isa => 'Paws::EMR::ClusterStatus');
24             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::EMR::Tag]');
25             has TerminationProtected => (is => 'ro', isa => 'Bool');
26             has VisibleToAllUsers => (is => 'ro', isa => 'Bool');
27             1;
28              
29             ### main pod documentation begin ###
30              
31             =head1 NAME
32              
33             Paws::EMR::Cluster
34              
35             =head1 USAGE
36              
37             This class represents one of two things:
38              
39             =head3 Arguments in a call to a service
40              
41             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
42             Each attribute should be used as a named argument in the calls that expect this type of object.
43              
44             As an example, if Att1 is expected to be a Paws::EMR::Cluster object:
45              
46             $service_obj->Method(Att1 => { Applications => $value, ..., VisibleToAllUsers => $value });
47              
48             =head3 Results returned from an API call
49              
50             Use accessors for each attribute. If Att1 is expected to be an Paws::EMR::Cluster object:
51              
52             $result = $service_obj->Method(...);
53             $result->Att1->Applications
54              
55             =head1 DESCRIPTION
56              
57             The detailed description of the cluster.
58              
59             =head1 ATTRIBUTES
60              
61              
62             =head2 Applications => ArrayRef[L<Paws::EMR::Application>]
63              
64             The applications installed on this cluster.
65              
66              
67             =head2 AutoScalingRole => Str
68              
69             An IAM role for automatic scaling policies. The default role is
70             C<EMR_AutoScaling_DefaultRole>. The IAM role provides permissions that
71             the automatic scaling feature requires to launch and terminate EC2
72             instances in an instance group.
73              
74              
75             =head2 AutoTerminate => Bool
76              
77             Specifies whether the cluster should terminate after completing all
78             steps.
79              
80              
81             =head2 Configurations => ArrayRef[L<Paws::EMR::Configuration>]
82              
83             Applies only to Amazon EMR releases 4.x and later. The list of
84             Configurations supplied to the EMR cluster.
85              
86              
87             =head2 CustomAmiId => Str
88              
89             Available only in Amazon EMR version 5.7.0 and later. The ID of a
90             custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
91              
92              
93             =head2 EbsRootVolumeSize => Int
94              
95             The size, in GiB, of the EBS root device volume of the Linux AMI that
96             is used for each EC2 instance. Available in Amazon EMR version 4.x and
97             later.
98              
99              
100             =head2 Ec2InstanceAttributes => L<Paws::EMR::Ec2InstanceAttributes>
101              
102             Provides information about the EC2 instances in a cluster grouped by
103             category. For example, key name, subnet ID, IAM instance profile, and
104             so on.
105              
106              
107             =head2 Id => Str
108              
109             The unique identifier for the cluster.
110              
111              
112             =head2 InstanceCollectionType => Str
113              
114             The instance fleet configuration is available only in Amazon EMR
115             versions 4.8.0 and later, excluding 5.0.x versions.
116              
117             The instance group configuration of the cluster. A value of
118             C<INSTANCE_GROUP> indicates a uniform instance group configuration. A
119             value of C<INSTANCE_FLEET> indicates an instance fleets configuration.
120              
121              
122             =head2 LogUri => Str
123              
124             The path to the Amazon S3 location where logs for this cluster are
125             stored.
126              
127              
128             =head2 MasterPublicDnsName => Str
129              
130             The public DNS name of the master EC2 instance.
131              
132              
133             =head2 Name => Str
134              
135             The name of the cluster.
136              
137              
138             =head2 NormalizedInstanceHours => Int
139              
140             An approximation of the cost of the cluster, represented in
141             m1.small/hours. This value is incremented one time for every hour an
142             m1.small instance runs. Larger instances are weighted more, so an EC2
143             instance that is roughly four times more expensive would result in the
144             normalized instance hours being incremented by four. This result is
145             only an approximation and does not reflect the actual billing rate.
146              
147              
148             =head2 ReleaseLabel => Str
149              
150             The release label for the Amazon EMR release.
151              
152              
153             =head2 RepoUpgradeOnBoot => Str
154              
155             Applies only when C<CustomAmiID> is used. Specifies the type of updates
156             that are applied from the Amazon Linux AMI package repositories when an
157             instance boots using the AMI.
158              
159              
160             =head2 RequestedAmiVersion => Str
161              
162             The AMI version requested for this cluster.
163              
164              
165             =head2 RunningAmiVersion => Str
166              
167             The AMI version running on this cluster.
168              
169              
170             =head2 ScaleDownBehavior => Str
171              
172             The way that individual Amazon EC2 instances terminate when an
173             automatic scale-in activity occurs or an instance group is resized.
174             C<TERMINATE_AT_INSTANCE_HOUR> indicates that Amazon EMR terminates
175             nodes at the instance-hour boundary, regardless of when the request to
176             terminate the instance was submitted. This option is only available
177             with Amazon EMR 5.1.0 and later and is the default for clusters created
178             using that version. C<TERMINATE_AT_TASK_COMPLETION> indicates that
179             Amazon EMR blacklists and drains tasks from nodes before terminating
180             the Amazon EC2 instances, regardless of the instance-hour boundary.
181             With either behavior, Amazon EMR removes the least active nodes first
182             and blocks instance termination if it could lead to HDFS corruption.
183             C<TERMINATE_AT_TASK_COMPLETION> is available only in Amazon EMR version
184             4.1.0 and later, and is the default for versions of Amazon EMR earlier
185             than 5.1.0.
186              
187              
188             =head2 SecurityConfiguration => Str
189              
190             The name of the security configuration applied to the cluster.
191              
192              
193             =head2 ServiceRole => Str
194              
195             The IAM role that will be assumed by the Amazon EMR service to access
196             AWS resources on your behalf.
197              
198              
199             =head2 Status => L<Paws::EMR::ClusterStatus>
200              
201             The current status details about the cluster.
202              
203              
204             =head2 Tags => ArrayRef[L<Paws::EMR::Tag>]
205              
206             A list of tags associated with a cluster.
207              
208              
209             =head2 TerminationProtected => Bool
210              
211             Indicates whether Amazon EMR will lock the cluster to prevent the EC2
212             instances from being terminated by an API call or user intervention, or
213             in the event of a cluster error.
214              
215              
216             =head2 VisibleToAllUsers => Bool
217              
218             Indicates whether the cluster is visible to all IAM users of the AWS
219             account associated with the cluster. If this value is set to C<true>,
220             all IAM users of that AWS account can view and manage the cluster if
221             they have the proper policy permissions set. If this value is C<false>,
222             only the IAM user that created the cluster can view and manage it. This
223             value can be changed using the SetVisibleToAllUsers action.
224              
225              
226              
227             =head1 SEE ALSO
228              
229             This class forms part of L<Paws>, describing an object used in L<Paws::EMR>
230              
231             =head1 BUGS and CONTRIBUTIONS
232              
233             The source code is located here: https://github.com/pplu/aws-sdk-perl
234              
235             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
236              
237             =cut
238