« blib/lib/Paws/WorkSpaces/UserStorage.pm
↑ Summary
blib/lib/Paws/WorkSpaces/WorkspaceAccessProperties.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WorkSpaces::Workspace; | ||
| 3 | use Moose; | ||
| 4 | has BundleId => (is => 'ro', isa => 'Str'); | ||
| 5 | has ComputerName => (is => 'ro', isa => 'Str'); | ||
| 6 | has DirectoryId => (is => 'ro', isa => 'Str'); | ||
| 7 | has ErrorCode => (is => 'ro', isa => 'Str'); | ||
| 8 | has ErrorMessage => (is => 'ro', isa => 'Str'); | ||
| 9 | has IpAddress => (is => 'ro', isa => 'Str'); | ||
| 10 | has ModificationStates => (is => 'ro', isa => 'ArrayRef[Paws::WorkSpaces::ModificationState]'); | ||
| 11 | has RootVolumeEncryptionEnabled => (is => 'ro', isa => 'Bool'); | ||
| 12 | has State => (is => 'ro', isa => 'Str'); | ||
| 13 | has SubnetId => (is => 'ro', isa => 'Str'); | ||
| 14 | has UserName => (is => 'ro', isa => 'Str'); | ||
| 15 | has UserVolumeEncryptionEnabled => (is => 'ro', isa => 'Bool'); | ||
| 16 | has VolumeEncryptionKey => (is => 'ro', isa => 'Str'); | ||
| 17 | has WorkspaceId => (is => 'ro', isa => 'Str'); | ||
| 18 | has WorkspaceProperties => (is => 'ro', isa => 'Paws::WorkSpaces::WorkspaceProperties'); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::WorkSpaces::Workspace | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::WorkSpaces::Workspace object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { BundleId => $value, ..., WorkspaceProperties => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::Workspace object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->BundleId | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | Describes a WorkSpace. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 BundleId => Str | ||
| 56 | |||
| 57 | The identifier of the bundle used to create the WorkSpace. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ComputerName => Str | ||
| 61 | |||
| 62 | The name of the WorkSpace, as seen by the operating system. The format | ||
| 63 | of this name varies. For more information, see Launch a WorkSpace | ||
| 64 | (https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html). | ||
| 65 | |||
| 66 | |||
| 67 | =head2 DirectoryId => Str | ||
| 68 | |||
| 69 | The identifier of the AWS Directory Service directory for the | ||
| 70 | WorkSpace. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 ErrorCode => Str | ||
| 74 | |||
| 75 | The error code that is returned if the WorkSpace cannot be created. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ErrorMessage => Str | ||
| 79 | |||
| 80 | The text of the error message that is returned if the WorkSpace cannot | ||
| 81 | be created. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 IpAddress => Str | ||
| 85 | |||
| 86 | The IP address of the WorkSpace. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 ModificationStates => ArrayRef[L<Paws::WorkSpaces::ModificationState>] | ||
| 90 | |||
| 91 | The modification states of the WorkSpace. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 RootVolumeEncryptionEnabled => Bool | ||
| 95 | |||
| 96 | Indicates whether the data stored on the root volume is encrypted. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 State => Str | ||
| 100 | |||
| 101 | The operational state of the WorkSpace. | ||
| 102 | |||
| 103 | After a WorkSpace is terminated, the C<TERMINATED> state is returned | ||
| 104 | only briefly before the WorkSpace directory metadata is cleaned up, so | ||
| 105 | this state is rarely returned. To confirm that a WorkSpace is | ||
| 106 | terminated, check for the WorkSpace ID by using DescribeWorkSpaces | ||
| 107 | (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html). | ||
| 108 | If the WorkSpace ID isn't returned, then the WorkSpace has been | ||
| 109 | successfully terminated. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 SubnetId => Str | ||
| 113 | |||
| 114 | The identifier of the subnet for the WorkSpace. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 UserName => Str | ||
| 118 | |||
| 119 | The user for the WorkSpace. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 UserVolumeEncryptionEnabled => Bool | ||
| 123 | |||
| 124 | Indicates whether the data stored on the user volume is encrypted. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 VolumeEncryptionKey => Str | ||
| 128 | |||
| 129 | The symmetric AWS KMS customer master key (CMK) used to encrypt data | ||
| 130 | stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric | ||
| 131 | CMKs. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 WorkspaceId => Str | ||
| 135 | |||
| 136 | The identifier of the WorkSpace. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 WorkspaceProperties => L<Paws::WorkSpaces::WorkspaceProperties> | ||
| 140 | |||
| 141 | The properties of the WorkSpace. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head1 SEE ALSO | ||
| 146 | |||
| 147 | This class forms part of L<Paws>, describing an object used in L<Paws::WorkSpaces> | ||
| 148 | |||
| 149 | =head1 BUGS and CONTRIBUTIONS | ||
| 150 | |||
| 151 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 152 | |||
| 153 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 154 | |||
| 155 | =cut | ||
| 156 |