« blib/lib/Paws/DS/CreateLogSubscriptionResult.pm
↑ Summary
blib/lib/Paws/DS/CreateMicrosoftADResult.pm »
| 1 | |||
| 2 | package Paws::DS::CreateMicrosoftAD; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has Edition => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Password => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ShortName => (is => 'ro', isa => 'Str'); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DS::Tag]'); | ||
| 10 | has VpcSettings => (is => 'ro', isa => 'Paws::DS::DirectoryVpcSettings', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateMicrosoftAD'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DS::CreateMicrosoftADResult'); | ||
| 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::CreateMicrosoftAD - Arguments for method CreateMicrosoftAD on L<Paws::DS> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateMicrosoftAD on the | ||
| 28 | L<AWS Directory Service|Paws::DS> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateMicrosoftAD. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMicrosoftAD. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ds = Paws->service('DS'); | ||
| 36 | my $CreateMicrosoftADResult = $ds->CreateMicrosoftAD( | ||
| 37 | Name => 'MyDirectoryName', | ||
| 38 | Password => 'MyPassword', | ||
| 39 | VpcSettings => { | ||
| 40 | SubnetIds => [ 'MySubnetId', ... ], | ||
| 41 | VpcId => 'MyVpcId', | ||
| 42 | |||
| 43 | }, | ||
| 44 | Description => 'MyDescription', # OPTIONAL | ||
| 45 | Edition => 'Enterprise', # OPTIONAL | ||
| 46 | ShortName => 'MyDirectoryShortName', # OPTIONAL | ||
| 47 | Tags => [ | ||
| 48 | { | ||
| 49 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 50 | Value => 'MyTagValue', # max: 256 | ||
| 51 | |||
| 52 | }, | ||
| 53 | ... | ||
| 54 | ], # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $DirectoryId = $CreateMicrosoftADResult->DirectoryId; | ||
| 59 | |||
| 60 | # Returns a L<Paws::DS::CreateMicrosoftADResult> 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/CreateMicrosoftAD> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Description => Str | ||
| 69 | |||
| 70 | A description for the directory. This label will appear on the AWS | ||
| 71 | console C<Directory Details> page after the directory is created. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Edition => Str | ||
| 76 | |||
| 77 | AWS Managed Microsoft AD is available in two editions: C<Standard> and | ||
| 78 | C<Enterprise>. C<Enterprise> is the default. | ||
| 79 | |||
| 80 | Valid values are: C<"Enterprise">, C<"Standard"> | ||
| 81 | |||
| 82 | =head2 B<REQUIRED> Name => Str | ||
| 83 | |||
| 84 | The fully qualified domain name for the AWS Managed Microsoft AD | ||
| 85 | directory, such as C<corp.example.com>. This name will resolve inside | ||
| 86 | your VPC only. It does not need to be publicly resolvable. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> Password => Str | ||
| 91 | |||
| 92 | The password for the default administrative user named C<Admin>. | ||
| 93 | |||
| 94 | If you need to change the password for the administrator account, you | ||
| 95 | can use the ResetUserPassword API call. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 ShortName => Str | ||
| 100 | |||
| 101 | The NetBIOS name for your domain, such as C<CORP>. If you don't specify | ||
| 102 | a NetBIOS name, it will default to the first part of your directory | ||
| 103 | DNS. For example, C<CORP> for the directory DNS C<corp.example.com>. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 Tags => ArrayRef[L<Paws::DS::Tag>] | ||
| 108 | |||
| 109 | The tags to be assigned to the AWS Managed Microsoft AD directory. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> VpcSettings => L<Paws::DS::DirectoryVpcSettings> | ||
| 114 | |||
| 115 | Contains VPC information for the CreateDirectory or CreateMicrosoftAD | ||
| 116 | operation. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method CreateMicrosoftAD in L<Paws::DS> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |