« blib/lib/Paws/DS/DirectoryConnectSettingsDescription.pm
↑ Summary
blib/lib/Paws/DS/DirectoryLimits.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DS::DirectoryDescription; | ||
| 3 | use Moose; | ||
| 4 | has AccessUrl => (is => 'ro', isa => 'Str'); | ||
| 5 | has Alias => (is => 'ro', isa => 'Str'); | ||
| 6 | has ConnectSettings => (is => 'ro', isa => 'Paws::DS::DirectoryConnectSettingsDescription'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str'); | ||
| 8 | has DesiredNumberOfDomainControllers => (is => 'ro', isa => 'Int'); | ||
| 9 | has DirectoryId => (is => 'ro', isa => 'Str'); | ||
| 10 | has DnsIpAddrs => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | has Edition => (is => 'ro', isa => 'Str'); | ||
| 12 | has LaunchTime => (is => 'ro', isa => 'Str'); | ||
| 13 | has Name => (is => 'ro', isa => 'Str'); | ||
| 14 | has OwnerDirectoryDescription => (is => 'ro', isa => 'Paws::DS::OwnerDirectoryDescription'); | ||
| 15 | has RadiusSettings => (is => 'ro', isa => 'Paws::DS::RadiusSettings'); | ||
| 16 | has RadiusStatus => (is => 'ro', isa => 'Str'); | ||
| 17 | has RegionsInfo => (is => 'ro', isa => 'Paws::DS::RegionsInfo'); | ||
| 18 | has ShareMethod => (is => 'ro', isa => 'Str'); | ||
| 19 | has ShareNotes => (is => 'ro', isa => 'Str'); | ||
| 20 | has ShareStatus => (is => 'ro', isa => 'Str'); | ||
| 21 | has ShortName => (is => 'ro', isa => 'Str'); | ||
| 22 | has Size => (is => 'ro', isa => 'Str'); | ||
| 23 | has SsoEnabled => (is => 'ro', isa => 'Bool'); | ||
| 24 | has Stage => (is => 'ro', isa => 'Str'); | ||
| 25 | has StageLastUpdatedDateTime => (is => 'ro', isa => 'Str'); | ||
| 26 | has StageReason => (is => 'ro', isa => 'Str'); | ||
| 27 | has Type => (is => 'ro', isa => 'Str'); | ||
| 28 | has VpcSettings => (is => 'ro', isa => 'Paws::DS::DirectoryVpcSettingsDescription'); | ||
| 29 | |||
| 30 | 1; | ||
| 31 | |||
| 32 | ### main pod documentation begin ### | ||
| 33 | |||
| 34 | =head1 NAME | ||
| 35 | |||
| 36 | Paws::DS::DirectoryDescription | ||
| 37 | |||
| 38 | =head1 USAGE | ||
| 39 | |||
| 40 | This class represents one of two things: | ||
| 41 | |||
| 42 | =head3 Arguments in a call to a service | ||
| 43 | |||
| 44 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 45 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 46 | |||
| 47 | As an example, if Att1 is expected to be a Paws::DS::DirectoryDescription object: | ||
| 48 | |||
| 49 | $service_obj->Method(Att1 => { AccessUrl => $value, ..., VpcSettings => $value }); | ||
| 50 | |||
| 51 | =head3 Results returned from an API call | ||
| 52 | |||
| 53 | Use accessors for each attribute. If Att1 is expected to be an Paws::DS::DirectoryDescription object: | ||
| 54 | |||
| 55 | $result = $service_obj->Method(...); | ||
| 56 | $result->Att1->AccessUrl | ||
| 57 | |||
| 58 | =head1 DESCRIPTION | ||
| 59 | |||
| 60 | Contains information about an AWS Directory Service directory. | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AccessUrl => Str | ||
| 66 | |||
| 67 | The access URL for the directory, such as | ||
| 68 | C<http://E<lt>aliasE<gt>.awsapps.com>. If no alias has been created for | ||
| 69 | the directory, C<E<lt>aliasE<gt>> is the directory identifier, such as | ||
| 70 | C<d-XXXXXXXXXX>. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Alias => Str | ||
| 74 | |||
| 75 | The alias for the directory. If no alias has been created for the | ||
| 76 | directory, the alias is the directory identifier, such as | ||
| 77 | C<d-XXXXXXXXXX>. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 ConnectSettings => L<Paws::DS::DirectoryConnectSettingsDescription> | ||
| 81 | |||
| 82 | A DirectoryConnectSettingsDescription object that contains additional | ||
| 83 | information about an AD Connector directory. This member is only | ||
| 84 | present if the directory is an AD Connector directory. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Description => Str | ||
| 88 | |||
| 89 | The description for the directory. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 DesiredNumberOfDomainControllers => Int | ||
| 93 | |||
| 94 | The desired number of domain controllers in the directory if the | ||
| 95 | directory is Microsoft AD. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 DirectoryId => Str | ||
| 99 | |||
| 100 | The directory identifier. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 DnsIpAddrs => ArrayRef[Str|Undef] | ||
| 104 | |||
| 105 | The IP addresses of the DNS servers for the directory. For a Simple AD | ||
| 106 | or Microsoft AD directory, these are the IP addresses of the Simple AD | ||
| 107 | or Microsoft AD directory servers. For an AD Connector directory, these | ||
| 108 | are the IP addresses of the DNS servers or domain controllers in the | ||
| 109 | on-premises directory to which the AD Connector is connected. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 Edition => Str | ||
| 113 | |||
| 114 | The edition associated with this directory. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 LaunchTime => Str | ||
| 118 | |||
| 119 | Specifies when the directory was created. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 Name => Str | ||
| 123 | |||
| 124 | The fully qualified name of the directory. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 OwnerDirectoryDescription => L<Paws::DS::OwnerDirectoryDescription> | ||
| 128 | |||
| 129 | Describes the AWS Managed Microsoft AD directory in the directory owner | ||
| 130 | account. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 RadiusSettings => L<Paws::DS::RadiusSettings> | ||
| 134 | |||
| 135 | A RadiusSettings object that contains information about the RADIUS | ||
| 136 | server configured for this directory. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 RadiusStatus => Str | ||
| 140 | |||
| 141 | The status of the RADIUS MFA server connection. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 RegionsInfo => L<Paws::DS::RegionsInfo> | ||
| 145 | |||
| 146 | Lists the Regions where the directory has replicated. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 ShareMethod => Str | ||
| 150 | |||
| 151 | The method used when sharing a directory to determine whether the | ||
| 152 | directory should be shared within your AWS organization | ||
| 153 | (C<ORGANIZATIONS>) or with any AWS account by sending a shared | ||
| 154 | directory request (C<HANDSHAKE>). | ||
| 155 | |||
| 156 | |||
| 157 | =head2 ShareNotes => Str | ||
| 158 | |||
| 159 | A directory share request that is sent by the directory owner to the | ||
| 160 | directory consumer. The request includes a typed message to help the | ||
| 161 | directory consumer administrator determine whether to approve or reject | ||
| 162 | the share invitation. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 ShareStatus => Str | ||
| 166 | |||
| 167 | Current directory status of the shared AWS Managed Microsoft AD | ||
| 168 | directory. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 ShortName => Str | ||
| 172 | |||
| 173 | The short name of the directory. | ||
| 174 | |||
| 175 | |||
| 176 | =head2 Size => Str | ||
| 177 | |||
| 178 | The directory size. | ||
| 179 | |||
| 180 | |||
| 181 | =head2 SsoEnabled => Bool | ||
| 182 | |||
| 183 | Indicates if single sign-on is enabled for the directory. For more | ||
| 184 | information, see EnableSso and DisableSso. | ||
| 185 | |||
| 186 | |||
| 187 | =head2 Stage => Str | ||
| 188 | |||
| 189 | The current stage of the directory. | ||
| 190 | |||
| 191 | |||
| 192 | =head2 StageLastUpdatedDateTime => Str | ||
| 193 | |||
| 194 | The date and time that the stage was last updated. | ||
| 195 | |||
| 196 | |||
| 197 | =head2 StageReason => Str | ||
| 198 | |||
| 199 | Additional information about the directory stage. | ||
| 200 | |||
| 201 | |||
| 202 | =head2 Type => Str | ||
| 203 | |||
| 204 | The directory size. | ||
| 205 | |||
| 206 | |||
| 207 | =head2 VpcSettings => L<Paws::DS::DirectoryVpcSettingsDescription> | ||
| 208 | |||
| 209 | A DirectoryVpcSettingsDescription object that contains additional | ||
| 210 | information about a directory. This member is only present if the | ||
| 211 | directory is a Simple AD or Managed AD directory. | ||
| 212 | |||
| 213 | |||
| 214 | |||
| 215 | =head1 SEE ALSO | ||
| 216 | |||
| 217 | This class forms part of L<Paws>, describing an object used in L<Paws::DS> | ||
| 218 | |||
| 219 | =head1 BUGS and CONTRIBUTIONS | ||
| 220 | |||
| 221 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 222 | |||
| 223 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 224 | |||
| 225 | =cut | ||
| 226 |