view release on metacpan or  search on metacpan

lib/Paws/WorkSpaces/WorkspaceCreationProperties.pm  view on Meta::CPAN

  has UserEnabledAsLocalAdministrator => (is => 'ro', isa => 'Bool');

1;

### main pod documentation begin ###

=head1 NAME

Paws::WorkSpaces::WorkspaceCreationProperties

=head1 USAGE

This class represents one of two things:

=head3 Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. 
Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::WorkSpaces::WorkspaceCreationProperties object:

  $service_obj->Method(Att1 => { CustomSecurityGroupId => $value, ..., UserEnabledAsLocalAdministrator => $value  });

=head3 Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::WorkspaceCreationProperties object:

  $result = $service_obj->Method(...);
  $result->Att1->CustomSecurityGroupId

=head1 DESCRIPTION

Describes the default properties that are used for creating WorkSpaces.
For more information, see Update Directory Details for Your WorkSpaces
(https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html).

=head1 ATTRIBUTES


=head2 CustomSecurityGroupId => Str

The identifier of your custom security group.


=head2 DefaultOu => Str

The default organizational unit (OU) for your WorkSpaces directories.
This string must be the full Lightweight Directory Access Protocol
(LDAP) distinguished name for the target domain and OU. It must be in
the form C<"OU=I<value>,DC=I<value>,DC=I<value>">, where I<value> is
any string of characters, and the number of domain components (DCs) is
two or more. For example,
C<OU=WorkSpaces_machines,DC=machines,DC=example,DC=com>.

=over

=item *

To avoid errors, certain characters in the distinguished name must be
escaped. For more information, see Distinguished Names
(https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names)
in the Microsoft documentation.

=item *

The API doesn't validate whether the OU exists.

=back



=head2 EnableInternetAccess => Bool

Indicates whether internet access is enabled for your WorkSpaces.


=head2 EnableMaintenanceMode => Bool

Indicates whether maintenance mode is enabled for your WorkSpaces. For
more information, see WorkSpace Maintenance
(https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html).


=head2 EnableWorkDocs => Bool

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you
disable it, new WorkSpaces launched in the directory will not have
WorkDocs enabled. However, WorkDocs remains enabled for any existing
WorkSpaces, unless you either disable users' access to WorkDocs or you
delete the WorkDocs site. To disable users' access to WorkDocs, see
Disabling Users
(https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html)
in the I<Amazon WorkDocs Administration Guide>. To delete a WorkDocs
site, see Deleting a Site
(https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html)
in the I<Amazon WorkDocs Administration Guide>.

If you enable WorkDocs on a directory that already has existing
WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are
launched in the directory will have WorkDocs enabled.


=head2 UserEnabledAsLocalAdministrator => Bool

Indicates whether users are local administrators of their WorkSpaces.



=head1 SEE ALSO

This class forms part of L<Paws>, describing an object used in L<Paws::WorkSpaces>

=head1 BUGS and CONTRIBUTIONS

The source code is located here: L<https://github.com/pplu/aws-sdk-perl>

Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>

=cut