blib/lib/Paws/Transfer/ListedServer.pm untested

filter: Statementstmt 0.0% 0 / 11 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 12 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Transfer::ListedServer;
3 use Moose;
4 has Arn => (is => 'ro', isa => 'Str', required => 1);
5 has Domain => (is => 'ro', isa => 'Str');
6 has EndpointType => (is => 'ro', isa => 'Str');
7 has IdentityProviderType => (is => 'ro', isa => 'Str');
8 has LoggingRole => (is => 'ro', isa => 'Str');
9 has ServerId => (is => 'ro', isa => 'Str');
10 has State => (is => 'ro', isa => 'Str');
11 has UserCount => (is => 'ro', isa => 'Int');
12  
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::Transfer::ListedServer
20  
21 =head1 USAGE
22  
23 This class represents one of two things:
24  
25 =head3 Arguments in a call to a service
26  
27 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28 Each attribute should be used as a named argument in the calls that expect this type of object.
29  
30 As an example, if Att1 is expected to be a Paws::Transfer::ListedServer object:
31  
32 $service_obj->Method(Att1 => { Arn => $value, ..., UserCount => $value });
33  
34 =head3 Results returned from an API call
35  
36 Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::ListedServer object:
37  
38 $result = $service_obj->Method(...);
39 $result->Att1->Arn
40  
41 =head1 DESCRIPTION
42  
43 Returns properties of a file transfer protocol-enabled server that was
44 specified.
45  
46 =head1 ATTRIBUTES
47  
48  
49 =head2 B<REQUIRED> Arn => Str
50  
51 Specifies the unique Amazon Resource Name (ARN) for a server to be
52 listed.
53  
54  
55 =head2 Domain => Str
56  
57 Specifies the domain of the storage system that is used for file
58 transfers.
59  
60  
61 =head2 EndpointType => Str
62  
63 Specifies the type of VPC endpoint that your server is connected to. If
64 your server is connected to a VPC endpoint, your server isn't
65 accessible over the public internet.
66  
67  
68 =head2 IdentityProviderType => Str
69  
70 Specifies the mode of authentication for a server. The default value is
71 C<SERVICE_MANAGED>, which allows you to store and access user
72 credentials within the Amazon Web Services Transfer Family service.
73  
74 Use C<AWS_DIRECTORY_SERVICE> to provide access to Active Directory
75 groups in Amazon Web Services Managed Active Directory or Microsoft
76 Active Directory in your on-premises environment or in Amazon Web
77 Services using AD Connectors. This option also requires you to provide
78 a Directory ID using the C<IdentityProviderDetails> parameter.
79  
80 Use the C<API_GATEWAY> value to integrate with an identity provider of
81 your choosing. The C<API_GATEWAY> setting requires you to provide an
82 API Gateway endpoint URL to call for authentication using the
83 C<IdentityProviderDetails> parameter.
84  
85  
86 =head2 LoggingRole => Str
87  
88 Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
89 Identity and Access Management (IAM) role that allows a server to turn
90 on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When
91 set, user activity can be viewed in your CloudWatch logs.
92  
93  
94 =head2 ServerId => Str
95  
96 Specifies the unique system assigned identifier for the servers that
97 were listed.
98  
99  
100 =head2 State => Str
101  
102 Specifies the condition of a server for the server that was described.
103 A value of C<ONLINE> indicates that the server can accept jobs and
104 transfer files. A C<State> value of C<OFFLINE> means that the server
105 cannot perform file transfer operations.
106  
107 The states of C<STARTING> and C<STOPPING> indicate that the server is
108 in an intermediate state, either not fully able to respond, or not
109 fully offline. The values of C<START_FAILED> or C<STOP_FAILED> can
110 indicate an error condition.
111  
112  
113 =head2 UserCount => Int
114  
115 Specifies the number of users that are assigned to a server you
116 specified with the C<ServerId>.
117  
118  
119  
120 =head1 SEE ALSO
121  
122 This class forms part of L<Paws>, describing an object used in L<Paws::Transfer>
123  
124 =head1 BUGS and CONTRIBUTIONS
125  
126 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
127  
128 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
129  
130 =cut
131