File Coverage

blib/lib/Paws/WorkSpaces/WorkspaceRequest.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::WorkspaceRequest;
2 1     1   297 use Moose;
  1         3  
  1         6  
3             has BundleId => (is => 'ro', isa => 'Str', required => 1);
4             has DirectoryId => (is => 'ro', isa => 'Str', required => 1);
5             has RootVolumeEncryptionEnabled => (is => 'ro', isa => 'Bool');
6             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::WorkSpaces::Tag]');
7             has UserName => (is => 'ro', isa => 'Str', required => 1);
8             has UserVolumeEncryptionEnabled => (is => 'ro', isa => 'Bool');
9             has VolumeEncryptionKey => (is => 'ro', isa => 'Str');
10             has WorkspaceProperties => (is => 'ro', isa => 'Paws::WorkSpaces::WorkspaceProperties');
11             1;
12              
13             ### main pod documentation begin ###
14              
15             =head1 NAME
16              
17             Paws::WorkSpaces::WorkspaceRequest
18              
19             =head1 USAGE
20              
21             This class represents one of two things:
22              
23             =head3 Arguments in a call to a service
24              
25             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26             Each attribute should be used as a named argument in the calls that expect this type of object.
27              
28             As an example, if Att1 is expected to be a Paws::WorkSpaces::WorkspaceRequest object:
29              
30             $service_obj->Method(Att1 => { BundleId => $value, ..., WorkspaceProperties => $value });
31              
32             =head3 Results returned from an API call
33              
34             Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::WorkspaceRequest object:
35              
36             $result = $service_obj->Method(...);
37             $result->Att1->BundleId
38              
39             =head1 DESCRIPTION
40              
41             Contains information about a WorkSpace creation request.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 B<REQUIRED> BundleId => Str
47              
48             The identifier of the bundle to create the WorkSpace from. You can use
49             the DescribeWorkspaceBundles operation to obtain a list of the bundles
50             that are available.
51              
52              
53             =head2 B<REQUIRED> DirectoryId => Str
54              
55             The identifier of the AWS Directory Service directory to create the
56             WorkSpace in. You can use the DescribeWorkspaceDirectories operation to
57             obtain a list of the directories that are available.
58              
59              
60             =head2 RootVolumeEncryptionEnabled => Bool
61              
62             Specifies whether the data stored on the root volume, or C: drive, is
63             encrypted.
64              
65              
66             =head2 Tags => ArrayRef[L<Paws::WorkSpaces::Tag>]
67              
68             The tags of the WorkSpace request.
69              
70              
71             =head2 B<REQUIRED> UserName => Str
72              
73             The username that the WorkSpace is assigned to. This username must
74             exist in the AWS Directory Service directory specified by the
75             C<DirectoryId> member.
76              
77              
78             =head2 UserVolumeEncryptionEnabled => Bool
79              
80             Specifies whether the data stored on the user volume, or D: drive, is
81             encrypted.
82              
83              
84             =head2 VolumeEncryptionKey => Str
85              
86             The KMS key used to encrypt data stored on your WorkSpace.
87              
88              
89             =head2 WorkspaceProperties => L<Paws::WorkSpaces::WorkspaceProperties>
90              
91            
92              
93              
94              
95             =head1 SEE ALSO
96              
97             This class forms part of L<Paws>, describing an object used in L<Paws::WorkSpaces>
98              
99             =head1 BUGS and CONTRIBUTIONS
100              
101             The source code is located here: https://github.com/pplu/aws-sdk-perl
102              
103             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
104              
105             =cut
106