« blib/lib/Paws/FSX/SelfManagedActiveDirectoryAttributes.pm
↑ Summary
blib/lib/Paws/FSX/SelfManagedActiveDirectoryConfigurationUpdates.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::SelfManagedActiveDirectoryConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has DnsIps => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 5 | has DomainName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has FileSystemAdministratorsGroup => (is => 'ro', isa => 'Str'); | ||
| 7 | has OrganizationalUnitDistinguishedName => (is => 'ro', isa => 'Str'); | ||
| 8 | has Password => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has UserName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::FSX::SelfManagedActiveDirectoryConfiguration | ||
| 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::FSX::SelfManagedActiveDirectoryConfiguration object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { DnsIps => $value, ..., UserName => $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::FSX::SelfManagedActiveDirectoryConfiguration object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->DnsIps | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | The configuration that Amazon FSx uses to join the Windows File Server | ||
| 42 | instance to your self-managed (including on-premises) Microsoft Active | ||
| 43 | Directory (AD) directory. For more information, see Using Amazon FSx | ||
| 44 | with your self-managed Microsoft Active Directory | ||
| 45 | (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html). | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> DnsIps => ArrayRef[Str|Undef] | ||
| 51 | |||
| 52 | A list of up to two IP addresses of DNS servers or domain controllers | ||
| 53 | in the self-managed AD directory. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> DomainName => Str | ||
| 57 | |||
| 58 | The fully qualified domain name of the self-managed AD directory, such | ||
| 59 | as C<corp.example.com>. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 FileSystemAdministratorsGroup => Str | ||
| 63 | |||
| 64 | (Optional) The name of the domain group whose members are granted | ||
| 65 | administrative privileges for the file system. Administrative | ||
| 66 | privileges include taking ownership of files and folders, setting audit | ||
| 67 | controls (audit ACLs) on files and folders, and administering the file | ||
| 68 | system remotely by using the FSx Remote PowerShell. The group that you | ||
| 69 | specify must already exist in your domain. If you don't provide one, | ||
| 70 | your AD domain's Domain Admins group is used. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 OrganizationalUnitDistinguishedName => Str | ||
| 74 | |||
| 75 | (Optional) The fully qualified distinguished name of the organizational | ||
| 76 | unit within your self-managed AD directory that the Windows File Server | ||
| 77 | instance will join. Amazon FSx only accepts OU as the direct parent of | ||
| 78 | the file system. An example is C<OU=FSx,DC=yourdomain,DC=corp,DC=com>. | ||
| 79 | To learn more, see RFC 2253 (https://tools.ietf.org/html/rfc2253). If | ||
| 80 | none is provided, the FSx file system is created in the default | ||
| 81 | location of your self-managed AD directory. | ||
| 82 | |||
| 83 | Only Organizational Unit (OU) objects can be the direct parent of the | ||
| 84 | file system that you're creating. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> Password => Str | ||
| 88 | |||
| 89 | The password for the service account on your self-managed AD domain | ||
| 90 | that Amazon FSx will use to join to your AD domain. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> UserName => Str | ||
| 94 | |||
| 95 | The user name for the service account on your self-managed AD domain | ||
| 96 | that Amazon FSx will use to join to your AD domain. This account must | ||
| 97 | have the permission to join computers to the domain in the | ||
| 98 | organizational unit provided in C<OrganizationalUnitDistinguishedName>, | ||
| 99 | or in the default location of your AD domain. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |