File Coverage

blib/lib/Paws/StorageGateway/CreateStorediSCSIVolume.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::CreateStorediSCSIVolume;
3 1     1   303 use Moose;
  1         2  
  1         6  
4             has DiskId => (is => 'ro', isa => 'Str', required => 1);
5             has GatewayARN => (is => 'ro', isa => 'Str', required => 1);
6             has NetworkInterfaceId => (is => 'ro', isa => 'Str', required => 1);
7             has PreserveExistingData => (is => 'ro', isa => 'Bool', required => 1);
8             has SnapshotId => (is => 'ro', isa => 'Str');
9             has TargetName => (is => 'ro', isa => 'Str', required => 1);
10              
11 1     1   5515 use MooseX::ClassAttribute;
  1         3  
  1         8  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateStorediSCSIVolume');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StorageGateway::CreateStorediSCSIVolumeOutput');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::StorageGateway::CreateStorediSCSIVolume - Arguments for method CreateStorediSCSIVolume on Paws::StorageGateway
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method CreateStorediSCSIVolume on the
27             AWS Storage Gateway service. Use the attributes of this class
28             as arguments to method CreateStorediSCSIVolume.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateStorediSCSIVolume.
31              
32             As an example:
33              
34             $service_obj->CreateStorediSCSIVolume(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> DiskId => Str
42              
43             The unique identifier for the gateway local disk that is configured as
44             a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
45              
46              
47              
48             =head2 B<REQUIRED> GatewayARN => Str
49              
50              
51              
52              
53              
54             =head2 B<REQUIRED> NetworkInterfaceId => Str
55              
56             The network interface of the gateway on which to expose the iSCSI
57             target. Only IPv4 addresses are accepted. Use
58             DescribeGatewayInformation to get a list of the network interfaces
59             available on a gateway.
60              
61             Valid Values: A valid IP address.
62              
63              
64              
65             =head2 B<REQUIRED> PreserveExistingData => Bool
66              
67             Specify this field as true if you want to preserve the data on the
68             local disk. Otherwise, specifying this field as false creates an empty
69             volume.
70              
71             Valid Values: true, false
72              
73              
74              
75             =head2 SnapshotId => Str
76              
77             The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
78             the new stored volume. Specify this field if you want to create the
79             iSCSI storage volume from a snapshot otherwise do not include this
80             field. To list snapshots for your account use DescribeSnapshots in the
81             I<Amazon Elastic Compute Cloud API Reference>.
82              
83              
84              
85             =head2 B<REQUIRED> TargetName => Str
86              
87             The name of the iSCSI target used by initiators to connect to the
88             target and as a suffix for the target ARN. For example, specifying
89             C<TargetName> as I<myvolume> results in the target ARN of
90             arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
91             The target name must be unique across all volumes of a gateway.
92              
93              
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, documenting arguments for method CreateStorediSCSIVolume in L<Paws::StorageGateway>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107