« blib/lib/Paws/DS/CreateConditionalForwarderResult.pm
↑ Summary
blib/lib/Paws/DS/CreateDirectoryResult.pm »
| 1 | |||
| 2 | package Paws::DS::CreateDirectory; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Password => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ShortName => (is => 'ro', isa => 'Str'); | ||
| 8 | has Size => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DS::Tag]'); | ||
| 10 | has VpcSettings => (is => 'ro', isa => 'Paws::DS::DirectoryVpcSettings'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDirectory'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DS::CreateDirectoryResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::DS::CreateDirectory - Arguments for method CreateDirectory on L<Paws::DS> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateDirectory on the | ||
| 28 | L<AWS Directory Service|Paws::DS> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateDirectory. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDirectory. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ds = Paws->service('DS'); | ||
| 36 | my $CreateDirectoryResult = $ds->CreateDirectory( | ||
| 37 | Name => 'MyDirectoryName', | ||
| 38 | Password => 'MyPassword', | ||
| 39 | Size => 'Small', | ||
| 40 | Description => 'MyDescription', # OPTIONAL | ||
| 41 | ShortName => 'MyDirectoryShortName', # OPTIONAL | ||
| 42 | Tags => [ | ||
| 43 | { | ||
| 44 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 45 | Value => 'MyTagValue', # max: 256 | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | VpcSettings => { | ||
| 51 | SubnetIds => [ 'MySubnetId', ... ], | ||
| 52 | VpcId => 'MyVpcId', | ||
| 53 | |||
| 54 | }, # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $DirectoryId = $CreateDirectoryResult->DirectoryId; | ||
| 59 | |||
| 60 | # Returns a L<Paws::DS::CreateDirectoryResult> object. | ||
| 61 | |||
| 62 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ds/CreateDirectory> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Description => Str | ||
| 69 | |||
| 70 | A description for the directory. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> Name => Str | ||
| 75 | |||
| 76 | The fully qualified name for the directory, such as | ||
| 77 | C<corp.example.com>. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> Password => Str | ||
| 82 | |||
| 83 | The password for the directory administrator. The directory creation | ||
| 84 | process creates a directory administrator account with the user name | ||
| 85 | C<Administrator> and this password. | ||
| 86 | |||
| 87 | If you need to change the password for the administrator account, you | ||
| 88 | can use the ResetUserPassword API call. | ||
| 89 | |||
| 90 | The regex pattern for this string is made up of the following | ||
| 91 | conditions: | ||
| 92 | |||
| 93 | =over | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Length (?=^.{8,64}$) E<ndash> Must be between 8 and 64 characters | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | AND any 3 of the following password complexity rules required by Active | ||
| 102 | Directory: | ||
| 103 | |||
| 104 | =over | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z]) | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | Numbers and special characters and lower case | ||
| 113 | (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z]) | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | Special characters and upper case and lower case | ||
| 118 | (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z]) | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | Numbers and upper case and special characters | ||
| 123 | (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s]) | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | For additional information about how Active Directory passwords are | ||
| 128 | enforced, see Password must meet complexity requirements | ||
| 129 | (https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements) | ||
| 130 | on the Microsoft website. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 ShortName => Str | ||
| 135 | |||
| 136 | The NetBIOS name of the directory, such as C<CORP>. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 B<REQUIRED> Size => Str | ||
| 141 | |||
| 142 | The size of the directory. | ||
| 143 | |||
| 144 | Valid values are: C<"Small">, C<"Large"> | ||
| 145 | |||
| 146 | =head2 Tags => ArrayRef[L<Paws::DS::Tag>] | ||
| 147 | |||
| 148 | The tags to be assigned to the Simple AD directory. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 VpcSettings => L<Paws::DS::DirectoryVpcSettings> | ||
| 153 | |||
| 154 | A DirectoryVpcSettings object that contains additional information for | ||
| 155 | the operation. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head1 SEE ALSO | ||
| 161 | |||
| 162 | This class forms part of L<Paws>, documenting arguments for method CreateDirectory in L<Paws::DS> | ||
| 163 | |||
| 164 | =head1 BUGS and CONTRIBUTIONS | ||
| 165 | |||
| 166 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 167 | |||
| 168 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 169 | |||
| 170 | =cut | ||
| 171 |