File Coverage

blib/lib/Paws/WorkSpaces/Workspace.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::WorkSpaces::Workspace;
2 1     1   785 use Moose;
  1         2  
  1         13  
3             has BundleId => (is => 'ro', isa => 'Str');
4             has ComputerName => (is => 'ro', isa => 'Str');
5             has DirectoryId => (is => 'ro', isa => 'Str');
6             has ErrorCode => (is => 'ro', isa => 'Str');
7             has ErrorMessage => (is => 'ro', isa => 'Str');
8             has IpAddress => (is => 'ro', isa => 'Str');
9             has RootVolumeEncryptionEnabled => (is => 'ro', isa => 'Bool');
10             has State => (is => 'ro', isa => 'Str');
11             has SubnetId => (is => 'ro', isa => 'Str');
12             has UserName => (is => 'ro', isa => 'Str');
13             has UserVolumeEncryptionEnabled => (is => 'ro', isa => 'Bool');
14             has VolumeEncryptionKey => (is => 'ro', isa => 'Str');
15             has WorkspaceId => (is => 'ro', isa => 'Str');
16             has WorkspaceProperties => (is => 'ro', isa => 'Paws::WorkSpaces::WorkspaceProperties');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::WorkSpaces::Workspace
24              
25             =head1 USAGE
26              
27             This class represents one of two things:
28              
29             =head3 Arguments in a call to a service
30              
31             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
32             Each attribute should be used as a named argument in the calls that expect this type of object.
33              
34             As an example, if Att1 is expected to be a Paws::WorkSpaces::Workspace object:
35              
36             $service_obj->Method(Att1 => { BundleId => $value, ..., WorkspaceProperties => $value });
37              
38             =head3 Results returned from an API call
39              
40             Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::Workspace object:
41              
42             $result = $service_obj->Method(...);
43             $result->Att1->BundleId
44              
45             =head1 DESCRIPTION
46              
47             Contains information about a WorkSpace.
48              
49             =head1 ATTRIBUTES
50              
51              
52             =head2 BundleId => Str
53              
54             The identifier of the bundle that the WorkSpace was created from.
55              
56              
57             =head2 ComputerName => Str
58              
59             The name of the WorkSpace as seen by the operating system.
60              
61              
62             =head2 DirectoryId => Str
63              
64             The identifier of the AWS Directory Service directory that the
65             WorkSpace belongs to.
66              
67              
68             =head2 ErrorCode => Str
69              
70             If the WorkSpace could not be created, this contains the error code.
71              
72              
73             =head2 ErrorMessage => Str
74              
75             If the WorkSpace could not be created, this contains a textual error
76             message that describes the failure.
77              
78              
79             =head2 IpAddress => Str
80              
81             The IP address of the WorkSpace.
82              
83              
84             =head2 RootVolumeEncryptionEnabled => Bool
85              
86             Specifies whether the data stored on the root volume, or C: drive, is
87             encrypted.
88              
89              
90             =head2 State => Str
91              
92             The operational state of the WorkSpace.
93              
94              
95             =head2 SubnetId => Str
96              
97             The identifier of the subnet that the WorkSpace is in.
98              
99              
100             =head2 UserName => Str
101              
102             The user that the WorkSpace is assigned to.
103              
104              
105             =head2 UserVolumeEncryptionEnabled => Bool
106              
107             Specifies whether the data stored on the user volume, or D: drive, is
108             encrypted.
109              
110              
111             =head2 VolumeEncryptionKey => Str
112              
113             The KMS key used to encrypt data stored on your WorkSpace.
114              
115              
116             =head2 WorkspaceId => Str
117              
118             The identifier of the WorkSpace.
119              
120              
121             =head2 WorkspaceProperties => L<Paws::WorkSpaces::WorkspaceProperties>
122              
123            
124              
125              
126              
127             =head1 SEE ALSO
128              
129             This class forms part of L<Paws>, describing an object used in L<Paws::WorkSpaces>
130              
131             =head1 BUGS and CONTRIBUTIONS
132              
133             The source code is located here: https://github.com/pplu/aws-sdk-perl
134              
135             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
136              
137             =cut
138