File Coverage

blib/lib/Paws/StorageGateway/ActivateGateway.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::StorageGateway::ActivateGateway;
3 1     1   416 use Moose;
  1         3  
  1         7  
4             has ActivationKey => (is => 'ro', isa => 'Str', required => 1);
5             has GatewayName => (is => 'ro', isa => 'Str', required => 1);
6             has GatewayRegion => (is => 'ro', isa => 'Str', required => 1);
7             has GatewayTimezone => (is => 'ro', isa => 'Str', required => 1);
8             has GatewayType => (is => 'ro', isa => 'Str');
9             has MediumChangerType => (is => 'ro', isa => 'Str');
10             has TapeDriveType => (is => 'ro', isa => 'Str');
11              
12 1     1   6185 use MooseX::ClassAttribute;
  1         2  
  1         13  
13              
14             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ActivateGateway');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StorageGateway::ActivateGatewayOutput');
16             class_has _result_key => (isa => 'Str', is => 'ro');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::StorageGateway::ActivateGateway - Arguments for method ActivateGateway on Paws::StorageGateway
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method ActivateGateway on the
28             AWS Storage Gateway service. Use the attributes of this class
29             as arguments to method ActivateGateway.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ActivateGateway.
32              
33             As an example:
34              
35             $service_obj->ActivateGateway(Att1 => $value1, Att2 => $value2, ...);
36              
37             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.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> ActivationKey => Str
43              
44             Your gateway activation key. You can obtain the activation key by
45             sending an HTTP GET request with redirects enabled to the gateway IP
46             address (port 80). The redirect URL returned in the response provides
47             you the activation key for your gateway in the query string parameter
48             C<activationKey>. It may also include other activation-related
49             parameters, however, these are merely defaults -- the arguments you
50             pass to the C<ActivateGateway> API call determine the actual
51             configuration of your gateway.
52              
53              
54              
55             =head2 B<REQUIRED> GatewayName => Str
56              
57             The name you configured for your gateway.
58              
59              
60              
61             =head2 B<REQUIRED> GatewayRegion => Str
62              
63             A value that indicates the region where you want to store your data.
64             The gateway region specified must be the same region as the region in
65             your C<Host> header in the request. For more information about
66             available regions and endpoints for AWS Storage Gateway, see Regions
67             and Endpoints in the I<Amazon Web Services Glossary>.
68              
69             Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2",
70             "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2",
71             "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2",
72             "ap-south-1", "sa-east-1"
73              
74              
75              
76             =head2 B<REQUIRED> GatewayTimezone => Str
77              
78             A value that indicates the time zone you want to set for the gateway.
79             The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example,
80             GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates
81             the time is 2 hours ahead of GMT. The time zone is used, for example,
82             for scheduling snapshots and your gateway's maintenance schedule.
83              
84              
85              
86             =head2 GatewayType => Str
87              
88             A value that defines the type of gateway to activate. The type
89             specified is critical to all later functions of the gateway and cannot
90             be changed after activation. The default value is C<STORED>.
91              
92             Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
93              
94              
95              
96             =head2 MediumChangerType => Str
97              
98             The value that indicates the type of medium changer to use for tape
99             gateway. This field is optional.
100              
101             Valid Values: "STK-L700", "AWS-Gateway-VTL"
102              
103              
104              
105             =head2 TapeDriveType => Str
106              
107             The value that indicates the type of tape drive to use for tape
108             gateway. This field is optional.
109              
110             Valid Values: "IBM-ULT3580-TD5"
111              
112              
113              
114              
115             =head1 SEE ALSO
116              
117             This class forms part of L<Paws>, documenting arguments for method ActivateGateway in L<Paws::StorageGateway>
118              
119             =head1 BUGS and CONTRIBUTIONS
120              
121             The source code is located here: https://github.com/pplu/aws-sdk-perl
122              
123             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
124              
125             =cut
126