File Coverage

blib/lib/Paws/Snowball/CreateCluster.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::Snowball::CreateCluster;
3 1     1   450 use Moose;
  1         3  
  1         8  
4             has AddressId => (is => 'ro', isa => 'Str', required => 1);
5             has Description => (is => 'ro', isa => 'Str');
6             has ForwardingAddressId => (is => 'ro', isa => 'Str');
7             has JobType => (is => 'ro', isa => 'Str', required => 1);
8             has KmsKeyARN => (is => 'ro', isa => 'Str');
9             has Notification => (is => 'ro', isa => 'Paws::Snowball::Notification');
10             has Resources => (is => 'ro', isa => 'Paws::Snowball::JobResource', required => 1);
11             has RoleARN => (is => 'ro', isa => 'Str', required => 1);
12             has ShippingOption => (is => 'ro', isa => 'Str', required => 1);
13             has SnowballType => (is => 'ro', isa => 'Str');
14              
15 1     1   7297 use MooseX::ClassAttribute;
  1         4  
  1         11  
16              
17             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCluster');
18             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Snowball::CreateClusterResult');
19             class_has _result_key => (isa => 'Str', is => 'ro');
20             1;
21              
22             ### main pod documentation begin ###
23              
24             =head1 NAME
25              
26             Paws::Snowball::CreateCluster - Arguments for method CreateCluster on Paws::Snowball
27              
28             =head1 DESCRIPTION
29              
30             This class represents the parameters used for calling the method CreateCluster on the
31             Amazon Import/Export Snowball service. Use the attributes of this class
32             as arguments to method CreateCluster.
33              
34             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCluster.
35              
36             As an example:
37              
38             $service_obj->CreateCluster(Att1 => $value1, Att2 => $value2, ...);
39              
40             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.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 B<REQUIRED> AddressId => Str
46              
47             The ID for the address that you want the cluster shipped to.E<gt>
48              
49              
50              
51             =head2 Description => Str
52              
53             An optional description of this specific cluster, for example
54             C<Environmental Data Cluster-01>.
55              
56              
57              
58             =head2 ForwardingAddressId => Str
59              
60             The forwarding address ID for a cluster. This field is not supported in
61             most regions.
62              
63              
64              
65             =head2 B<REQUIRED> JobType => Str
66              
67             The type of job for this cluster. Currently, the only job type
68             supported for clusters is C<LOCAL_USE>.
69              
70             Valid values are: C<"IMPORT">, C<"EXPORT">, C<"LOCAL_USE">
71              
72             =head2 KmsKeyARN => Str
73              
74             The C<KmsKeyARN> value that you want to associate with this cluster.
75             C<KmsKeyARN> values are created by using the CreateKey API action in
76             AWS Key Management Service (AWS KMS).
77              
78              
79              
80             =head2 Notification => L<Paws::Snowball::Notification>
81              
82             The Amazon Simple Notification Service (Amazon SNS) notification
83             settings for this cluster.
84              
85              
86              
87             =head2 B<REQUIRED> Resources => L<Paws::Snowball::JobResource>
88              
89             The resources associated with the cluster job. These resources include
90             Amazon S3 buckets and optional AWS Lambda functions written in the
91             Python language.
92              
93              
94              
95             =head2 B<REQUIRED> RoleARN => Str
96              
97             The C<RoleARN> that you want to associate with this cluster. C<RoleArn>
98             values are created by using the CreateRole API action in AWS Identity
99             and Access Management (IAM).
100              
101              
102              
103             =head2 B<REQUIRED> ShippingOption => Str
104              
105             The shipping speed for each node in this cluster. This speed doesn't
106             dictate how soon you'll get each Snowball Edge appliance, rather it
107             represents how quickly each appliance moves to its destination while in
108             transit. Regional shipping speeds are as follows:
109              
110             =over
111              
112             =item *
113              
114             In Australia, you have access to express shipping. Typically,
115             appliances shipped express are delivered in about a day.
116              
117             =item *
118              
119             In the European Union (EU), you have access to express shipping.
120             Typically, Snowball Edges shipped express are delivered in about a day.
121             In addition, most countries in the EU have access to standard shipping,
122             which typically takes less than a week, one way.
123              
124             =item *
125              
126             In India, Snowball Edges are delivered in one to seven days.
127              
128             =item *
129              
130             In the US, you have access to one-day shipping and two-day shipping.
131              
132             =back
133              
134              
135             Valid values are: C<"SECOND_DAY">, C<"NEXT_DAY">, C<"EXPRESS">, C<"STANDARD">
136              
137             =head2 SnowballType => Str
138              
139             The type of AWS Snowball appliance to use for this cluster. Currently,
140             the only supported appliance type for cluster jobs is C<EDGE>.
141              
142             Valid values are: C<"STANDARD">, C<"EDGE">
143              
144              
145             =head1 SEE ALSO
146              
147             This class forms part of L<Paws>, documenting arguments for method CreateCluster in L<Paws::Snowball>
148              
149             =head1 BUGS and CONTRIBUTIONS
150              
151             The source code is located here: https://github.com/pplu/aws-sdk-perl
152              
153             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
154              
155             =cut
156