File Coverage

blib/lib/Paws/DS/DirectoryDescription.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

line	stmt	sub	time	code
1				package Paws::DS::DirectoryDescription;
2	1	1	475	use Moose;
	1		3
	1		8
3				has AccessUrl => (is => 'ro', isa => 'Str');
4				has Alias => (is => 'ro', isa => 'Str');
5				has ConnectSettings => (is => 'ro', isa => 'Paws::DS::DirectoryConnectSettingsDescription');
6				has Description => (is => 'ro', isa => 'Str');
7				has DesiredNumberOfDomainControllers => (is => 'ro', isa => 'Int');
8				has DirectoryId => (is => 'ro', isa => 'Str');
9				has DnsIpAddrs => (is => 'ro', isa => 'ArrayRef[Str\|Undef]');
10				has LaunchTime => (is => 'ro', isa => 'Str');
11				has Name => (is => 'ro', isa => 'Str');
12				has RadiusSettings => (is => 'ro', isa => 'Paws::DS::RadiusSettings');
13				has RadiusStatus => (is => 'ro', isa => 'Str');
14				has ShortName => (is => 'ro', isa => 'Str');
15				has Size => (is => 'ro', isa => 'Str');
16				has SsoEnabled => (is => 'ro', isa => 'Bool');
17				has Stage => (is => 'ro', isa => 'Str');
18				has StageLastUpdatedDateTime => (is => 'ro', isa => 'Str');
19				has StageReason => (is => 'ro', isa => 'Str');
20				has Type => (is => 'ro', isa => 'Str');
21				has VpcSettings => (is => 'ro', isa => 'Paws::DS::DirectoryVpcSettingsDescription');
22				1;
23
24				### main pod documentation begin ###
25
26				=head1 NAME
27
28				Paws::DS::DirectoryDescription
29
30				=head1 USAGE
31
32				This class represents one of two things:
33
34				=head3 Arguments in a call to a service
35
36				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
37				Each attribute should be used as a named argument in the calls that expect this type of object.
38
39				As an example, if Att1 is expected to be a Paws::DS::DirectoryDescription object:
40
41				$service_obj->Method(Att1 => { AccessUrl => $value, ..., VpcSettings => $value });
42
43				=head3 Results returned from an API call
44
45				Use accessors for each attribute. If Att1 is expected to be an Paws::DS::DirectoryDescription object:
46
47				$result = $service_obj->Method(...);
48				$result->Att1->AccessUrl
49
50				=head1 DESCRIPTION
51
52				Contains information about an AWS Directory Service directory.
53
54				=head1 ATTRIBUTES
55
56
57				=head2 AccessUrl => Str
58
59				The access URL for the directory, such as
60				C<http://E<lt>aliasE<gt>.awsapps.com>. If no alias has been created for
61				the directory, C<E<lt>aliasE<gt>> is the directory identifier, such as
62				C<d-XXXXXXXXXX>.
63
64
65				=head2 Alias => Str
66
67				The alias for the directory. If no alias has been created for the
68				directory, the alias is the directory identifier, such as
69				C<d-XXXXXXXXXX>.
70
71
72				=head2 ConnectSettings => L<Paws::DS::DirectoryConnectSettingsDescription>
73
74				A DirectoryConnectSettingsDescription object that contains additional
75				information about an AD Connector directory. This member is only
76				present if the directory is an AD Connector directory.
77
78
79				=head2 Description => Str
80
81				The textual description for the directory.
82
83
84				=head2 DesiredNumberOfDomainControllers => Int
85
86				The desired number of domain controllers in the directory if the
87				directory is Microsoft AD.
88
89
90				=head2 DirectoryId => Str
91
92				The directory identifier.
93
94
95				=head2 DnsIpAddrs => ArrayRef[Str\|Undef]
96
97				The IP addresses of the DNS servers for the directory. For a Simple AD
98				or Microsoft AD directory, these are the IP addresses of the Simple AD
99				or Microsoft AD directory servers. For an AD Connector directory, these
100				are the IP addresses of the DNS servers or domain controllers in the
101				on-premises directory to which the AD Connector is connected.
102
103
104				=head2 LaunchTime => Str
105
106				Specifies when the directory was created.
107
108
109				=head2 Name => Str
110
111				The fully-qualified name of the directory.
112
113
114				=head2 RadiusSettings => L<Paws::DS::RadiusSettings>
115
116				A RadiusSettings object that contains information about the RADIUS
117				server configured for this directory.
118
119
120				=head2 RadiusStatus => Str
121
122				The status of the RADIUS MFA server connection.
123
124
125				=head2 ShortName => Str
126
127				The short name of the directory.
128
129
130				=head2 Size => Str
131
132				The directory size.
133
134
135				=head2 SsoEnabled => Bool
136
137				Indicates if single-sign on is enabled for the directory. For more
138				information, see EnableSso and DisableSso.
139
140
141				=head2 Stage => Str
142
143				The current stage of the directory.
144
145
146				=head2 StageLastUpdatedDateTime => Str
147
148				The date and time that the stage was last updated.
149
150
151				=head2 StageReason => Str
152
153				Additional information about the directory stage.
154
155
156				=head2 Type => Str
157
158				The directory size.
159
160
161				=head2 VpcSettings => L<Paws::DS::DirectoryVpcSettingsDescription>
162
163				A DirectoryVpcSettingsDescription object that contains additional
164				information about a directory. This member is only present if the
165				directory is a Simple AD or Managed AD directory.
166
167
168
169				=head1 SEE ALSO
170
171				This class forms part of L<Paws>, describing an object used in L<Paws::DS>
172
173				=head1 BUGS and CONTRIBUTIONS
174
175				The source code is located here: https://github.com/pplu/aws-sdk-perl
176
177				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
178
179				=cut
180