File Coverage

blib/lib/Paws/Snowball/ClusterMetadata.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::Snowball::ClusterMetadata;
2 1     1   305 use Moose;
  1         3  
  1         6  
3             has AddressId => (is => 'ro', isa => 'Str');
4             has ClusterId => (is => 'ro', isa => 'Str');
5             has ClusterState => (is => 'ro', isa => 'Str');
6             has CreationDate => (is => 'ro', isa => 'Str');
7             has Description => (is => 'ro', isa => 'Str');
8             has ForwardingAddressId => (is => 'ro', isa => 'Str');
9             has JobType => (is => 'ro', isa => 'Str');
10             has KmsKeyARN => (is => 'ro', isa => 'Str');
11             has Notification => (is => 'ro', isa => 'Paws::Snowball::Notification');
12             has Resources => (is => 'ro', isa => 'Paws::Snowball::JobResource');
13             has RoleARN => (is => 'ro', isa => 'Str');
14             has ShippingOption => (is => 'ro', isa => 'Str');
15             has SnowballType => (is => 'ro', isa => 'Str');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::Snowball::ClusterMetadata
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::Snowball::ClusterMetadata object:
34              
35             $service_obj->Method(Att1 => { AddressId => $value, ..., SnowballType => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::Snowball::ClusterMetadata object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->AddressId
43              
44             =head1 DESCRIPTION
45              
46             Contains metadata about a specific cluster.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 AddressId => Str
52              
53             The automatically generated ID for a specific address.
54              
55              
56             =head2 ClusterId => Str
57              
58             The automatically generated ID for a cluster.
59              
60              
61             =head2 ClusterState => Str
62              
63             The current status of the cluster.
64              
65              
66             =head2 CreationDate => Str
67              
68             The creation date for this cluster.
69              
70              
71             =head2 Description => Str
72              
73             The optional description of the cluster.
74              
75              
76             =head2 ForwardingAddressId => Str
77              
78             The ID of the address that you want a cluster shipped to, after it will
79             be shipped to its primary address. This field is not supported in most
80             regions.
81              
82              
83             =head2 JobType => Str
84              
85             The type of job for this cluster. Currently, the only job type
86             supported for clusters is C<LOCAL_USE>.
87              
88              
89             =head2 KmsKeyARN => Str
90              
91             The C<KmsKeyARN> Amazon Resource Name (ARN) associated with this
92             cluster. This ARN was created using the CreateKey API action in AWS Key
93             Management Service (AWS KMS).
94              
95              
96             =head2 Notification => L<Paws::Snowball::Notification>
97              
98             The Amazon Simple Notification Service (Amazon SNS) notification
99             settings for this cluster.
100              
101              
102             =head2 Resources => L<Paws::Snowball::JobResource>
103              
104             The arrays of JobResource objects that can include updated S3Resource
105             objects or LambdaResource objects.
106              
107              
108             =head2 RoleARN => Str
109              
110             The role ARN associated with this cluster. This ARN was created using
111             the CreateRole API action in AWS Identity and Access Management (IAM).
112              
113              
114             =head2 ShippingOption => Str
115              
116             The shipping speed for each node in this cluster. This speed doesn't
117             dictate how soon you'll get each Snowball Edge appliance, rather it
118             represents how quickly each appliance moves to its destination while in
119             transit. Regional shipping speeds are as follows:
120              
121             =over
122              
123             =item *
124              
125             In Australia, you have access to express shipping. Typically,
126             appliances shipped express are delivered in about a day.
127              
128             =item *
129              
130             In the European Union (EU), you have access to express shipping.
131             Typically, Snowball Edges shipped express are delivered in about a day.
132             In addition, most countries in the EU have access to standard shipping,
133             which typically takes less than a week, one way.
134              
135             =item *
136              
137             In India, Snowball Edges are delivered in one to seven days.
138              
139             =item *
140              
141             In the US, you have access to one-day shipping and two-day shipping.
142              
143             =back
144              
145              
146              
147             =head2 SnowballType => Str
148              
149             The type of AWS Snowball appliance to use for this cluster. Currently,
150             the only supported appliance type for cluster jobs is C<EDGE>.
151              
152              
153              
154             =head1 SEE ALSO
155              
156             This class forms part of L<Paws>, describing an object used in L<Paws::Snowball>
157              
158             =head1 BUGS and CONTRIBUTIONS
159              
160             The source code is located here: https://github.com/pplu/aws-sdk-perl
161              
162             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
163              
164             =cut
165